On Friday, 4 May 2012 at 15:11:39 UTC, Steven Schveighoffer wrote:
> I was envisioning eliminating the rest of the tree, and you'd have to click on one of the breadcrumbs to get it back.  But that might be weird.
>
> Something like:
>
> etc . c .
> sqlite3
> * func1
> * func2
> ...
>
> And then you click on etc or c, and get the module tree back (either dynamically or after a round-trip from the server).
>
> The idea is, when you are navigating in a module, you are interested in the module, not the rest of the modules.
>
> I personally am not as much concerned about how many clicks it takes to navigate as much as I'm concerned about making the tree more focused on what you are doing now.
>
> -Steve

I think that's an awesome idea, I'll play with it later. Thanks.

I would put a text input above the accordian, with the word "Filter
Module" or something like that.
It would be great if it were possible to search the module too or perhaps a
module description of some sort, but that is more work.

The purpose for the text input filter on the accordian would just be to show module names for quicker navigation, esp if the text box was selected on page load.

On Fri, May 4, 2012 at 2:07 PM, Jakob Ovrum <jakobovrum@gmail.com> wrote:

> On Thursday, 3 May 2012 at 08:16:48 UTC, Rory McGuire wrote:
>
>> Would be great if you could make it an accordion with a live search at the top.
>>
>
> An accordion is a nice idea, and Bootstrap has good support for it.
>
> Where would you have the search, exactly, though? And do you mean the existing symbol search, a project-wide search (which is non-trivial), or a module search?
>

On 2012-05-04 16:04, Jakob Ovrum wrote:
> On Thursday, 3 May 2012 at 14:27:38 UTC, Jacob Carlborg wrote:
>> The right side is pretty empty if you have a wide screen. Perhaps the
>> symbols can be placed there.
>
> On my current 16:9 1080p monitor, the full width of the page is utilized
> by the main documentation, tested with Opera and Chrome (as it's
> supposed to do with the current use of Bootstrap's "table" framework).
> It does depend on the quantity of documentation though; for LuaD, the
> right side is considerably more empty than for most Phobos modules.
>
> I think it's possible to conditionally and cleanly introduce a
> right-side sidebar depending on the screen width, that could be worth
> experimenting with.
>
> First I think I want to try to make the sidebar into an accordion, as
> was suggested earlier in the thread.

Well, it's not empty but the main content doesn't need to be that wide. At least not on my screen, 1920x1080.

-- 
/Jacob Carlborg

Jakob Ovrum wrote:

> This project is finally published and documented, so here's an announcement.
> 
>      https://github.com/JakobOvrum/bootDoc
> 
> bootDoc is a configurable DDoc theme, with advanced JavaScript features like a package tree and module tree, as well as fully qualified symbol anchors. The style itself and some of the components come from Twitter's Bootstrap framework.
> 
> Demonstration of Phobos documentation using bootDoc
> 
>      http://jakobovrum.github.com/bootdoc-phobos/
> 
> LuaD's official documentation also uses bootDoc
> 
>      http://jakobovrum.github.com/LuaD/
> 
> bootDoc is designed to be easily usable with any project. It is used as a git-submodule in both of the above sample scenarios. All project-specific settings are provided by a separate configuration file (settings.ddoc), which is documented on the project's Github wiki.
> 
> bootDoc includes a general-purpose generation script. See the readme on Github for usage information. The script uses a candyDoc-style modules.ddoc as input, making the transition from candyDoc projects easy.
> 
> Note about noscript: JavaScript is used to get around the static nature of DDoc. The sidebar does not work without JavaScript, and neither do fully qualified anchor names. However, anchors with ambiguous names (such as those usable for symbols on dlang.org) work both with and without JavaScript, with the same limitations.
> 
> Comments, issues, enhancement requests, questions or rants about JavaScript - all feedback is much appreciated!

As I said on irc://irc.freenode.org/d , this is probably the best DDoc theme I have seen so far. So nice, and elegant.

I have it bookmarked the moment he gave us the link on #D channel. :)

Well-done!

I guess most devs have a pretty wide screen. How about letting the overview of the current selected module be located to the right of the modules listing when there is enough horizontal space. Something like:

http://dl.dropbox.com/u/188292/flow.png

I guess that it could be accomplished by using left floats and min-widths in order not to break it for people with smaller screens.

/Jonas