On Thu, 09 Dec 2010 23:04:22 -0500, Andrej Mitrovic <andrej@none.net> wrote:

> The D website is 404'ing for the library page:
>
> http://d-programming-language.org/phobos/phobos.html
>
> And I've had an idea to make the documentation website a little easier to navigate. Here's what the docs look like with their old design:
>
> http://imgur.com/8Vdrj.jpg
>
> Now, that's quite a mess to look at. The text isn't aligned or anything so it doesn't look that good, and you can't really tell which of those names are functions, class definitions or enums, etc.
>
> So I just quickly sketched out what I'd like to see instead:
>
> http://imgur.com/0lufR.jpg
>
> Disregard the off coloring, font sizes, and my general lack of design skills please :). The main point is to put the links in a table so they're aligned and easier to browse, and maybe even categorize all the names by their type (functions/enums/etc).
>
> I'm pretty sure adding a table is trivial, but I don't know if we can automatically categorize all the names and put them in separate tables.
>
> Thoughts?

Yes please.

Note that if you want to work on the doc, the entire D website is generated by ddoc from the phobos repository.  So you can experiment with different things directly by editing the source.

-Steve

Andrei Alexandrescu wrote:

> On 12/9/10 8:04 PM, Andrej Mitrovic wrote:
>> The D website is 404'ing for the library page:
>>
>> http://d-programming-language.org/phobos/phobos.html
>>
>> And I've had an idea to make the documentation website a little easier to navigate. Here's what the docs look like with their old design:
>>
>> http://imgur.com/8Vdrj.jpg
>>
>> Now, that's quite a mess to look at. The text isn't aligned or anything so it doesn't look that good, and you can't really tell which of those names are functions, class definitions or enums, etc.
>>
>> So I just quickly sketched out what I'd like to see instead:
>>
>> http://imgur.com/0lufR.jpg
>>
>> Disregard the off coloring, font sizes, and my general lack of design skills please :). The main point is to put the links in a table so they're aligned and easier to browse, and maybe even categorize all the names by their type (functions/enums/etc).
>>
>> I'm pretty sure adding a table is trivial, but I don't know if we can automatically categorize all the names and put them in separate tables.
>>
>> Thoughts?
>>
> 
> Very nice initiative. I'm not sure how we can implement that easy without considerable effort; currently, the list is generated with Javascript using a flat list. To generate a more structured list, the programmer would need to insert appropriate cues in the documentation.
> 
> Andrei

With the json files dmd produces it can be automated, and you can do it the ddoc way (so latex and other formats would also be supported.) A disadvantage is that ddoc processor has to be ran twice plus an additional pass over the json is needed. ddoc support for this would obviously be better. I got this far (but it uses non-standard css3):

https://dl.dropbox.com/u/6777848/ddoc_index.jpeg

I'll share the tool when it's more complete, if this is something that is wanted for phobos I am willing to put it together.

I think bold instead of all caps would be better.  Either way is fine, though.

On Fri, Dec 10, 2010 at 4:05 PM, Lutger Blijdestijn < lutger.blijdestijn@gmail.com> wrote:

> Andrei Alexandrescu wrote:
>
> > On 12/9/10 8:04 PM, Andrej Mitrovic wrote:
> >> The D website is 404'ing for the library page:
> >>
> >> http://d-programming-language.org/phobos/phobos.html
> >>
> >> And I've had an idea to make the documentation website a little easier
> to
> >> navigate. Here's what the docs look like with their old design:
> >>
> >> http://imgur.com/8Vdrj.jpg
> >>
> >> Now, that's quite a mess to look at. The text isn't aligned or anything so it doesn't look that good, and you can't really tell which of those names are functions, class definitions or enums, etc.
> >>
> >> So I just quickly sketched out what I'd like to see instead:
> >>
> >> http://imgur.com/0lufR.jpg
> >>
> >> Disregard the off coloring, font sizes, and my general lack of design skills please :). The main point is to put the links in a table so they're aligned and easier to browse, and maybe even categorize all the names by their type (functions/enums/etc).
> >>
> >> I'm pretty sure adding a table is trivial, but I don't know if we can automatically categorize all the names and put them in separate tables.
> >>
> >> Thoughts?
> >>
> >
> > Very nice initiative. I'm not sure how we can implement that easy without considerable effort; currently, the list is generated with Javascript using a flat list. To generate a more structured list, the programmer would need to insert appropriate cues in the documentation.
> >
> > Andrei
>
> With the json files dmd produces it can be automated, and you can do it the ddoc way (so latex and other formats would also be supported.) A disadvantage is that ddoc processor has to be ran twice plus an additional pass over the json is needed. ddoc support for this would obviously be better. I got this far (but it uses non-standard css3):
>
> https://dl.dropbox.com/u/6777848/ddoc_index.jpeg
>
> I'll share the tool when it's more complete, if this is something that is wanted for phobos I am willing to put it together.
>

On 12/11/10 11:56 CST, Jimmy Cao wrote:
> I think bold instead of all caps would be better.  Either way is fine,
> though.
>
> On Fri, Dec 10, 2010 at 4:05 PM, Lutger Blijdestijn
> <lutger.blijdestijn@gmail.com <mailto:lutger.blijdestijn@gmail.com>> wrote:
>
>     Andrei Alexandrescu wrote:
>
>      > On 12/9/10 8:04 PM, Andrej Mitrovic wrote:
>      >> The D website is 404'ing for the library page:
>      >>
>      >> http://d-programming-language.org/phobos/phobos.html
>      >>
>      >> And I've had an idea to make the documentation website a little
>     easier to
>      >> navigate. Here's what the docs look like with their old design:
>      >>
>      >> http://imgur.com/8Vdrj.jpg
>      >>
>      >> Now, that's quite a mess to look at. The text isn't aligned or
>     anything
>      >> so it doesn't look that good, and you can't really tell which of
>     those
>      >> names are functions, class definitions or enums, etc.
>      >>
>      >> So I just quickly sketched out what I'd like to see instead:
>      >>
>      >> http://imgur.com/0lufR.jpg
>      >>
>      >> Disregard the off coloring, font sizes, and my general lack of
>     design
>      >> skills please :). The main point is to put the links in a table so
>      >> they're aligned and easier to browse, and maybe even categorize
>     all the
>      >> names by their type (functions/enums/etc).
>      >>
>      >> I'm pretty sure adding a table is trivial, but I don't know if
>     we can
>      >> automatically categorize all the names and put them in separate
>     tables.
>      >>
>      >> Thoughts?
>      >>
>      >
>      > Very nice initiative. I'm not sure how we can implement that easy
>      > without considerable effort; currently, the list is generated with
>      > Javascript using a flat list. To generate a more structured list, the
>      > programmer would need to insert appropriate cues in the
>     documentation.
>      >
>      > Andrei
>
>     With the json files dmd produces it can be automated, and you can do
>     it the
>     ddoc way (so latex and other formats would also be supported.) A
>     disadvantage is that ddoc processor has to be ran twice plus an
>     additional
>     pass over the json is needed. ddoc support for this would obviously be
>     better. I got this far (but it uses non-standard css3):
>
>     https://dl.dropbox.com/u/6777848/ddoc_index.jpeg
>
>     I'll share the tool when it's more complete, if this is something
>     that is
>     wanted for phobos I am willing to put it together.

Yes please. Other Phobosites?

Andrei

Andrei Alexandrescu wrote:
>>
>>     I'll share the tool when it's more complete, if this is something
>>     that is
>>     wanted for phobos I am willing to put it together.
> 
> Yes please. Other Phobosites?
> 
> Andrei

I'm sorry, I did not understand what you meant.

On Sat, 11 Dec 2010 11:56:25 -0600
Jimmy Cao <jcao219@gmail.com> wrote:

> With the json files dmd produces it can be automated, and you can do it the ddoc way (so latex and other formats would also be supported.) A disadvantage is that ddoc processor has to be ran twice plus an additional pass over the json is needed. ddoc support for this would obviously be better. I got this far (but it uses non-standard css3):
>
> https://dl.dropbox.com/u/6777848/ddoc_index.jpeg
>
> I'll share the tool when it's more complete, if this is something that is wanted for phobos I am willing to put it together.

This is great. Since you're working on style, would would mind setting a non-white background? (White backgrounds on screens hurt human eyes.) Any nice pastel color (if you want to keep black front color) would do the job :-)


Denis
-- -- -- -- -- -- --
vit esse estrany ☣

spir.wikidot.com

On 12/11/10 1:33 PM, Lutger Blijdestijn wrote:
> Andrei Alexandrescu wrote:
>>>
>>>      I'll share the tool when it's more complete, if this is something
>>>      that is
>>>      wanted for phobos I am willing to put it together.
>>
>> Yes please. Other Phobosites?
>>
>> Andrei
>
> I'm sorry, I did not understand what you meant.

I wanted to say that I like it so it would be great if you put it together, and then I asked other Phobos contributors about their opinion as well. In fact I should ask the you all.

Andrei