bootDoc - advanced DDoc framework using Twitter's Bootstrap

Steven Schveighoffer schveiguy at yahoo.com
Thu May 3 07:30:37 PDT 2012


On Thu, 03 May 2012 08:43:43 -0400, Jakob Ovrum <jakobovrum at gmail.com>  
wrote:

> On Thursday, 3 May 2012 at 12:33:33 UTC, Ary Manzana wrote:
>> On 5/3/12 6:41 PM, Jacob Carlborg wrote:
>>> On 2012-05-03 10:09, Ary Manzana wrote:
>>>
>>>> I'm not sure. I'd like the symbols to be under the same tree.
>>>>
>>>> With tabs you'd have to click twice to go from one place to another.
>>>>
>>>
>>> I didn't even know the symbols where there until a scrolled down.
>>>
>>
>> The same happened to me.
>>
>> What I meant with "under the same tree is"
>>
>> + std
>>   + algorithm
>>     * map
>>     * reduce
>>     * ...
>
> There would be a lot of wasted whitespace to the left, and overflow for  
> long symbol names would become an even bigger issue.
>
> I do understand the problem though, and I want to fix it. Some more  
> opinions are much appreciated.

I suggest:

1. Only expand tree to the level of the current symbol selected.  So for  
instance, you click on std.datetime, you see all the top-level symbols of  
std.datetime *not* expanded.  If you click on std.datetime.Month, the  
Month enum expands in the tree.
2. When inside a module, only show the packages of that module as  
breadcrumbs, without indentation.  That saves you the white space.

BTW, I noticed two issues:

1. If a symbol name is too long, it is truncated with ..., but the  
expand/collapse arrow is also removed.
2. The index.html goes to links like std_base64.html, but the actual doc  
is at std.base64.html, so you get a 404.

Looks really nice!  I agree with Ary, we *really* really need cross  
references (generated by the compiler), and I'd add it would be nice to be  
able to show categories and category headers at the top of each module  
(i.e. here are all the structs in this file, here are all the classes).

-Steve


More information about the Digitalmars-d-announce mailing list