www.digitalmars.com         C & C++   DMDScript  

digitalmars.D - http://d-programming-language.org/ 404 & small proposal

reply Andrej Mitrovic <andrej none.net> writes:
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?
Dec 09 2010
next sibling parent reply "Nick Sabalausky" <a a.a> writes:
"Andrej Mitrovic" <andrej none.net> wrote in message 
news:ids8s6$21gm$1 digitalmars.com...

 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?


vote++
Dec 09 2010
parent Adam D. Ruppe <destructionator gmail.com> writes:
Add this to the <head> section of the website:

<style>
	#quickindex b:first-child {
		display: block;
	}
	#quickindex a {
		display: inline-block;
		min-width: 160px;
		border: solid 1px #cccccc;
		margin-top: 4px;
	}
</style>


Tweak a little maybe but you'll end up with something like this:

http://arsdnet.net/dtbl.png


The CSS is just a slightly simpler approach than messing with the javascript or
html itself and can be made good enough with virtually zero effort.
Dec 09 2010
prev sibling next sibling parent reply Andrei Alexandrescu <SeeWebsiteForEmail erdani.org> writes:
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
Dec 09 2010
parent reply Lutger Blijdestijn <lutger.blijdestijn gmail.com> writes:
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.
Dec 10 2010
next sibling parent reply Jimmy Cao <jcao219 gmail.com> writes:
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.
Dec 11 2010
parent reply Andrei Alexandrescu <SeeWebsiteForEmail erdani.org> writes:
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
Dec 11 2010
parent reply Lutger Blijdestijn <lutger.blijdestijn gmail.com> writes:
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.
Dec 11 2010
parent Andrei Alexandrescu <SeeWebsiteForEmail erdani.org> writes:
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
Dec 11 2010
prev sibling parent spir <denis.spir gmail.com> writes:
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 t=


he

 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 no=
n-white background? (White backgrounds on screens hurt human eyes.) Any nic=
e pastel color (if you want to keep black front color) would do the job :-)


Denis
-- -- -- -- -- -- --
vit esse estrany =E2=98=A3

spir.wikidot.com
Dec 11 2010
prev sibling next sibling parent Jonathan M Davis <jmdavisProg gmx.com> writes:
On Thursday 09 December 2010 20:04:22 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?


I think that most people want something similar to that. I think that the real 
issue is that someone has to sit down and do it. IIRC Yao G. had something
going 
but hadn't gotten working all the way yet.

At some point, we do need something that shows all of the module functions 
separate from the types in the function and the member functions associated
with 
each type with the type rather than mixed in with the module functions.

What you show seems reasonable (aside from the fact that most of what you list 
as functions are types, but I assume that that's because it's a mock up), and
it 
would definitely be an improvement. I think what many people would like to see 
would be a collapsible tree of some kind, but what you show is definitely
better 
than what we currently have, and presumably it would be easier to do.

- Jonathan M Davis
Dec 09 2010
prev sibling next sibling parent Andrej Mitrovic <andrej.mitrovich gmail.com> writes:
On 12/10/10, Jonathan M Davis <jmdavisProg gmx.com> wrote:

 What you show seems reasonable (aside from the fact that most of what you
 list
 as functions are types, but I assume that that's because it's a mock up),


Haha, yeah I made one table and then got lazy and copy-pasted the rest. Guilty.


 would be a collapsible tree of some kind, but what you show is definitely
 better
 than what we currently have, and presumably it would be easier to do.

 - Jonathan M Davis


We should stick with making smaller improvements over time on the site
itself. D is lacking manpower as it is so we shouldn't have to waste a
lot of time on design issues.
Dec 09 2010
prev sibling next sibling parent reply Jonathan M Davis <jmdavisProg gmx.com> writes:
On Thursday 09 December 2010 21:03:53 Andrej Mitrovic wrote:

 On 12/10/10, Jonathan M Davis <jmdavisProg gmx.com> wrote:

 What you show seems reasonable (aside from the fact that most of what you
 list
 as functions are types, but I assume that that's because it's a mock up),


 
 Haha, yeah I made one table and then got lazy and copy-pasted the rest.
 Guilty.
 

 would be a collapsible tree of some kind, but what you show is definitely
 better
 than what we currently have, and presumably it would be easier to do.
 
 - Jonathan M Davis


 
 We should stick with making smaller improvements over time on the site
 itself. D is lacking manpower as it is so we shouldn't have to waste a
 lot of time on design issues.


I see no problem with that. I do think that we should be striving for the best 
design that we can, but incremental improvements are just fine. I just thought 
that I'd point out what people have generally been looking for. Making it like 
what you suggested would be a definite improvement though, regardless of
whether 
we end up with some sort of collapsible tree later. The fact that we have so 
little manpower is a big part of why changes haven't been made already, so it's 
definitely a valid point.

- Jonathan M Davis
Dec 09 2010
parent reply duckett <quack pond.net> writes:
I don't know JavaScript but I've managed to make it look similar if it
helps. Methods for classes and structs don't show.

http://imgur.com/rfRUc.jpg
Dec 10 2010
parent reply Andrei Alexandrescu <SeeWebsiteForEmail erdani.org> writes:
On 12/10/10 12:38 AM, duckett wrote:

 I don't know JavaScript but I've managed to make it look similar if it
 helps. Methods for classes and structs don't show.

 http://imgur.com/rfRUc.jpg


Looks interesting, could you please share the code in a bugzilla 
enhancement report?

And welcome aboard!

Andrei
Dec 10 2010
parent duckett <quack pond.net> writes:
http://d.puremagic.com/issues/show_bug.cgi?id=5339
Dec 10 2010
prev sibling parent "Steven Schveighoffer" <schveiguy yahoo.com> writes:
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
Dec 10 2010