September 16, 2013 Re: Improved Phobos dox | ||||
---|---|---|---|---|
| ||||
Posted in reply to Walter Bright | On 9/15/13 11:04 AM, Walter Bright wrote: > On 9/15/2013 10:52 AM, Andrei Alexandrescu wrote: >> the simpler approach of making the file and line of each symbol >> available as >> ddoc symbols. > > > I think that would make for a nice enhancement to ddoc. Enhancement > request to bugzilla? http://d.puremagic.com/issues/show_bug.cgi?id=11050 Andrei |
September 16, 2013 Re: Improved Phobos dox | ||||
---|---|---|---|---|
| ||||
Posted in reply to H. S. Teoh | On 9/15/13 9:53 PM, H. S. Teoh wrote: > On Mon, Sep 16, 2013 at 06:15:35AM +0200, deadalnix wrote: >> On Sunday, 15 September 2013 at 18:38:54 UTC, Sönke Ludwig wrote: >>> Am 15.09.2013 19:20, schrieb Walter Bright: >>>> On 9/15/2013 12:53 AM, Vladimir Panteleev wrote: >>>>> What happened with Ddox? This looks like an improvement in both >>>>> function and aesthetics: >>>>> >>>>> http://vibed.org/temp/phobos/std/array.html >>>> >>>> It doesn't document the parameters, return type, and doesn't >>>> recognize embedded hyperlinks. >>> >>> Just as a reminder, this is the current version: >>> http://vibed.org/temp/d-programming-language.org/phobos/std/array.html >> >> I'm sold, that is awesome ! > > Me too. Why aren't we working towards that, instead of trying to cook > up yet another hack on top of the current poor state of documentation? https://github.com/D-Programming-Language/dlang.org/pull/271 consists mainly of a reorganization of the ddoc macros for PDF and ebook generation purposes, as well as helpers such as plaintext generator and "debugger". These are good starting points for anyone using ddoc for generating their own documentations. I was at it so I thought I'd improve on the bag-of-words-at-the-top morass, too. It only took a little time. That was apparently unsuccessful so I'll remove it from the pull request. https://github.com/D-Programming-Language/dlang.org/pull/267 is the pull request using ddox. That's a larger change of build tooling, which I plan to get to after 271 (with a revert to the bag-of-words) gets in. Andrei |
September 16, 2013 Re: Improved Phobos dox | ||||
---|---|---|---|---|
| ||||
Posted in reply to Sönke Ludwig | On 9/15/13 11:34 PM, Sönke Ludwig wrote:
> I need some form of authoritative decision on how to go about making (or
> not making) the transition before I can start to work on the necessary
> changes to the make file and the rest of the site. There is a suggestion
> I made in the pull request:
>
> https://github.com/D-Programming-Language/dlang.org/pull/267
What other changes need to be made in addition to what's in 267 now?
Andrei
|
September 16, 2013 Re: Improved Phobos dox | ||||
---|---|---|---|---|
| ||||
Posted in reply to Vladimir Panteleev | On 9/15/13 11:49 PM, Vladimir Panteleev wrote:
> On Monday, 16 September 2013 at 01:44:34 UTC, Andrei Alexandrescu wrote:
>> On 9/15/13 11:25 AM, Vladimir Panteleev wrote:
>>> On Sunday, 15 September 2013 at 18:02:10 UTC, Andrei Alexandrescu wrote:
>>>> Vladimir, do you think you could easily implement such an incremental
>>>> search box (with autocompletion)?
>>>
>>> Sorry, that idea does not appeal to me either. Web browsers already have
>>> the function of searching within a page.
>>
>> But search boxes with autocomplete are vastly better.
>
> Search boxes with autocomplete are vastly better than the classical
> Ctrl+F dialog as implemented in Internet Explorer 6. Most browsers
> currently implement Ctrl+F as incremental search, which highlights
> results as you type.
Ctrl-F does not progressively adjust the list of search candidates - it can highlight only what's actually visible in the document.
Andrei
|
September 16, 2013 Re: Improved Phobos dox | ||||
---|---|---|---|---|
| ||||
Posted in reply to Andrei Alexandrescu | On Monday, 16 September 2013 at 10:47:25 UTC, Andrei Alexandrescu wrote: > Ctrl-F does not progressively adjust the list of search candidates - it can highlight only what's actually visible in the document. If the page is property laid out, this is not an issue. http://dump.thecybershadow.net/269d31b27d121d13ceb51dc308b89b69/00000088.png http://dump.thecybershadow.net/9b9e677a061087ef9486288eeaaccdc1/00000087.png |
September 16, 2013 Re: Improved Phobos dox | ||||
---|---|---|---|---|
| ||||
Posted in reply to Andrei Alexandrescu | On 9/15/13 12:14 AM, Andrei Alexandrescu wrote: [snip] Got destroyed so I changed the jump-to list back, added a couple of minor improvements until we land https://github.com/D-Programming-Language/dlang.org/pull/267. http://erdani.com/d/phobos/std_array.html Andrei |
September 16, 2013 Re: Improved Phobos dox | ||||
---|---|---|---|---|
| ||||
Posted in reply to Andrei Alexandrescu | On Monday, 16 September 2013 at 12:59:28 UTC, Andrei Alexandrescu wrote:
> On 9/15/13 12:14 AM, Andrei Alexandrescu wrote:
> [snip]
>
> Got destroyed so I changed the jump-to list back, added a couple of minor improvements until we land https://github.com/D-Programming-Language/dlang.org/pull/267.
>
> http://erdani.com/d/phobos/std_array.html
What happened to the margins/padding? The assocArray example block shouldn't be glued to the uninitializedArray signature.
|
September 16, 2013 Re: Improved Phobos dox | ||||
---|---|---|---|---|
| ||||
Posted in reply to Andrei Alexandrescu | On Monday, 16 September 2013 at 12:59:28 UTC, Andrei Alexandrescu wrote:
> On 9/15/13 12:14 AM, Andrei Alexandrescu wrote:
> [snip]
>
> Got destroyed so I changed the jump-to list back, added a couple of minor improvements until we land https://github.com/D-Programming-Language/dlang.org/pull/267.
>
> http://erdani.com/d/phobos/std_array.html
Links in the list are currently broken, I think you need to prepend a ".".
|
September 16, 2013 Re: Improved Phobos dox | ||||
---|---|---|---|---|
| ||||
Posted in reply to Andrei Alexandrescu | On Sunday, 15 September 2013 at 18:02:10 UTC, Andrei Alexandrescu wrote:
>
> Sure. My goal with this upgrade is to get rid of the unsightly bag of words at the top of most pages.
>
A few months ago, I made a prototype that turned the "bag of words" into a boxed out vertical list floating at the left. It worked fairly well at all sorts of browser sizes and required zero Javascript. (It will work even better when all the modules have introductory text as mentioned in another thread.</optimism>)
I wonder if I should resurrect that branch?
-Wyatt
|
September 16, 2013 Re: Improved Phobos dox | ||||
---|---|---|---|---|
| ||||
Posted in reply to Vladimir Panteleev | On 9/16/13 6:08 AM, Vladimir Panteleev wrote:
> On Monday, 16 September 2013 at 12:59:28 UTC, Andrei Alexandrescu wrote:
>> On 9/15/13 12:14 AM, Andrei Alexandrescu wrote:
>> [snip]
>>
>> Got destroyed so I changed the jump-to list back, added a couple of
>> minor improvements until we land
>> https://github.com/D-Programming-Language/dlang.org/pull/267.
>>
>> http://erdani.com/d/phobos/std_array.html
>
> What happened to the margins/padding? The assocArray example block
> shouldn't be glued to the uninitializedArray signature.
Must have fallen through the cracks. Any chance you'd spot it in the pull request? I'll try the same when I'll find some time.
Andrei
|
Copyright © 1999-2021 by the D Language Foundation