www.digitalmars.com         C & C++   DMDScript  

digitalmars.D.announce - DDOX search support and new 2.064.2 Phobos docs

reply =?ISO-8859-15?Q?S=F6nke_Ludwig?= <sludwig outerproduct.org> writes:
DDOX [1] has just gained support for a JavaScript based live search
function. I've uploaded new DMD 2.064.2 Phobos/Druntime docs [2] with
this (search box in the upper-left corner).

The vibe.d docs [3] are now also searchable and documentation for old
releases can now also be viewed in addition to the most current release.

[1]: https://github.com/rejectedsoftware/ddox
[2]: http://vibed.org/temp/dlang.org/library/index.html
[3]: http://vibed.org/api/
Dec 29 2013
next sibling parent reply Leandro Lucarella <luca llucax.com.ar> writes:
Sönke Ludwig, el 29 de December a las 19:07 me escribiste:
 DDOX [1] has just gained support for a JavaScript based live search
 function. I've uploaded new DMD 2.064.2 Phobos/Druntime docs [2] with
 this (search box in the upper-left corner).
 
 The vibe.d docs [3] are now also searchable and documentation for old
 releases can now also be viewed in addition to the most current release.
Very nice! In FF 26 the search box is a little wider than the container though (in both phobs and vibe.d docs). -- Leandro Lucarella (AKA luca) http://llucax.com.ar/ ---------------------------------------------------------------------- GPG Key: 5F5A8D05 (F8CD F9A7 BF00 5431 4145 104C 949E BFB6 5F5A 8D05) ---------------------------------------------------------------------- We are born naked, wet and hungry Then things get worse
Dec 29 2013
parent reply =?UTF-8?B?U8O2bmtlIEx1ZHdpZw==?= <sludwig outerproduct.org> writes:
Am 29.12.2013 21:10, schrieb Leandro Lucarella:
 Sönke Ludwig, el 29 de December a las 19:07 me escribiste:
 DDOX [1] has just gained support for a JavaScript based live search
 function. I've uploaded new DMD 2.064.2 Phobos/Druntime docs [2] with
 this (search box in the upper-left corner).

 The vibe.d docs [3] are now also searchable and documentation for old
 releases can now also be viewed in addition to the most current release.
Very nice! In FF 26 the search box is a little wider than the container though (in both phobs and vibe.d docs).
Thanks, fixed now on the Phobos page.
Dec 29 2013
parent reply "extrawurst" <stephan extrawurst.org> writes:
On Sunday, 29 December 2013 at 21:35:53 UTC, Sönke Ludwig wrote:
 Am 29.12.2013 21:10, schrieb Leandro Lucarella:
 Sönke Ludwig, el 29 de December a las 19:07 me escribiste:
 DDOX [1] has just gained support for a JavaScript based live 
 search
 function. I've uploaded new DMD 2.064.2 Phobos/Druntime docs 
 [2] with
 this (search box in the upper-left corner).

 The vibe.d docs [3] are now also searchable and documentation 
 for old
 releases can now also be viewed in addition to the most 
 current release.
Very nice! In FF 26 the search box is a little wider than the container though (in both phobs and vibe.d docs).
Thanks, fixed now on the Phobos page.
Wow this is fantastic! Nice work
Dec 29 2013
parent Walter Bright <newshound2 digitalmars.com> writes:
On 12/29/2013 1:39 PM, extrawurst wrote:
 On Sunday, 29 December 2013 at 21:35:53 UTC, Sönke Ludwig wrote:
 Am 29.12.2013 21:10, schrieb Leandro Lucarella:
 Sönke Ludwig, el 29 de December a las 19:07 me escribiste:
 DDOX [1] has just gained support for a JavaScript based live search
 function. I've uploaded new DMD 2.064.2 Phobos/Druntime docs [2] with
 this (search box in the upper-left corner).

 The vibe.d docs [3] are now also searchable and documentation for old
 releases can now also be viewed in addition to the most current release.
Very nice! In FF 26 the search box is a little wider than the container though (in both phobs and vibe.d docs).
Thanks, fixed now on the Phobos page.
Wow this is fantastic! Nice work
I agree. Looks very nice.
Dec 29 2013
prev sibling next sibling parent reply "Dicebot" <public dicebot.lv> writes:
On Sunday, 29 December 2013 at 18:08:15 UTC, Sönke Ludwig wrote:
 DDOX [1] has just gained support for a JavaScript based live 
 search
 function. I've uploaded new DMD 2.064.2 Phobos/Druntime docs 
 [2] with
 this (search box in the upper-left corner).

 The vibe.d docs [3] are now also searchable and documentation 
 for old
 releases can now also be viewed in addition to the most current 
 release.

 [1]: https://github.com/rejectedsoftware/ddox
 [2]: http://vibed.org/temp/dlang.org/library/index.html
 [3]: http://vibed.org/api/
Enhancement proposal - how about adding abbreviation interpretation to match list? This was first thing I have naively tried :) (for example, "fqn" to propose "fullyQualifiedName")
Dec 29 2013
parent =?UTF-8?B?U8O2bmtlIEx1ZHdpZw==?= <sludwig outerproduct.org> writes:
Am 29.12.2013 22:46, schrieb Dicebot:
 On Sunday, 29 December 2013 at 18:08:15 UTC, Sönke Ludwig wrote:
 DDOX [1] has just gained support for a JavaScript based live search
 function. I've uploaded new DMD 2.064.2 Phobos/Druntime docs [2] with
 this (search box in the upper-left corner).

 The vibe.d docs [3] are now also searchable and documentation for old
 releases can now also be viewed in addition to the most current release.

 [1]: https://github.com/rejectedsoftware/ddox
 [2]: http://vibed.org/temp/dlang.org/library/index.html
 [3]: http://vibed.org/api/
Enhancement proposal - how about adding abbreviation interpretation to match list? This was first thing I have naively tried :) (for example, "fqn" to propose "fullyQualifiedName")
Interesting idea, I've also added this here: https://github.com/rejectedsoftware/ddox/issues/39
Dec 29 2013
prev sibling next sibling parent reply Andrej Mitrovic <andrej.mitrovich gmail.com> writes:
On 12/29/13, Snke Ludwig <sludwig outerproduct.org> wrote:
 DDOX [1] has just gained support for a JavaScript based live search
 function.
 [2]: http://vibed.org/temp/dlang.org/library/index.html
Nice! I have a few notes/suggestions: - The result bubble should likely hide when you select another part of the website (when you're not focused in on the search box). Otherwise you're forced to delete your query just to see what's hiding behind the result bubble (which can be very large). - Is it possible to add walking through the list via UP/DOWN arrow keys to select one of the URLs? I think this would be convenient to have. It already sort-of works, but first you have to click on the bubble with the mouse, and then you can use the Tab/Shift+Tab to walk through the list. - The search box should likely keep its value when you've clicked on a link to be redirected to a new URL from within the result bubble. I think it would at least be a convenient feature. But it's not a big deal, I can see the result is saved by the browser when I go to the previous page.
Dec 29 2013
parent =?ISO-8859-1?Q?S=F6nke_Ludwig?= <sludwig outerproduct.org> writes:
Am 29.12.2013 22:53, schrieb Andrej Mitrovic:
 On 12/29/13, Snke Ludwig <sludwig outerproduct.org> wrote:
 DDOX [1] has just gained support for a JavaScript based live search
 function.
 [2]: http://vibed.org/temp/dlang.org/library/index.html
Nice! I have a few notes/suggestions: - The result bubble should likely hide when you select another part of the website (when you're not focused in on the search box). Otherwise you're forced to delete your query just to see what's hiding behind the result bubble (which can be very large). - Is it possible to add walking through the list via UP/DOWN arrow keys to select one of the URLs? I think this would be convenient to have. It already sort-of works, but first you have to click on the bubble with the mouse, and then you can use the Tab/Shift+Tab to walk through the list. - The search box should likely keep its value when you've clicked on a link to be redirected to a new URL from within the result bubble. I think it would at least be a convenient feature. But it's not a big deal, I can see the result is saved by the browser when I go to the previous page.
Created a little meta-issue: https://github.com/rejectedsoftware/ddox/issues/39 If anyone wants to get his/her hands dirty (which would be great), the search code is at https://github.com/rejectedsoftware/ddox/blob/master/public/scripts/ddox.js#L22 resp. here when/if the pull request gets merged: https://github.com/D-Programming-Language/dlang.org/blob/master/js/ddox.js
Dec 29 2013
prev sibling parent reply "Jonas Drewsen" <nospam4321 hotmail.com > writes:
Very nice!

Looking at the automatic index created for a module I guess it is 
using the first line of the function comment as the description 
column right?

If that is the case we should probably go through phobos and make 
proper first lines that works as summeries.

/Jonas
Dec 30 2013
parent reply =?UTF-8?B?U8O2bmtlIEx1ZHdpZw==?= <sludwig outerproduct.org> writes:
Am 30.12.2013 20:21, schrieb Jonas Drewsen:
 Very nice!
 
 Looking at the automatic index created for a module I guess it is using
 the first line of the function comment as the description column right?
 
 If that is the case we should probably go through phobos and make proper
 first lines that works as summeries.
 
 /Jonas
Exactly. It's according to the DDOC spec (See Sections/Summary on [1]), but in the normal documentation, the first paragraph isn't treated in a special way, so it never stood out so far. [1]: http://dlang.org/ddoc.html
Dec 30 2013
parent reply "Organic Farmer" <x x.de> writes:
Would be great to have template constraints back in the docs (see 
e.g. std.algorithm.all). Indispensable info on templates in and 
of themselves.

Gut gemacht!
Jan 04 2014
parent reply "Namespace" <rswhite4 googlemail.com> writes:
On Saturday, 4 January 2014 at 22:14:24 UTC, Organic Farmer wrote:
 Would be great to have template constraints back in the docs 
 (see e.g. std.algorithm.all). Indispensable info on templates 
 in and of themselves.

 Gut gemacht!
Überraschend wie viele Deutsche hier sind. :D
Jan 04 2014
parent "Stephan" <Stephan extrawurst.org> writes:
On Saturday, 4 January 2014 at 22:42:28 UTC, Namespace wrote:
 On Saturday, 4 January 2014 at 22:14:24 UTC, Organic Farmer 
 wrote:
 Would be great to have template constraints back in the docs 
 (see e.g. std.algorithm.all). Indispensable info on templates 
 in and of themselves.

 Gut gemacht!
Überraschend wie viele Deutsche hier sind. :D
Ja, FYI es gibt auch #d.de auf freenode ;) (Promoting the German d irc channel)
Jan 05 2014