Re: [openlilylib] generated docs, HTML/CSS help desired

[Urs Liska]

Am 18.07.2014 16:18, schrieb Paul Morris:
> Urs Liska wrote
> > to give you quick access and a first impression on what I've done on the
> > openlilylib documentation you can have a look at
> >
> > http://openlilylib.org/demo-oll/git-commands.html
>
> Hi Urs,
>
> This is great progress and it's looking good!  I have some thoughts about
> the layout but I think it would be helpful to see what things look like with
> all the files/modules/items before going too far with the design.
>
> One thought is that the metadata and status info could fit nicely in a thin
> column, perhaps in a 3rd column on the right, in a 3-column layout?

What I've set up so far doesn't mean anything really, it's just 
something to work with. Fortunately I've set up a structure modular and 
template based structure that should make it really simple to generate 
any other HTML output.

> That
> would get the snippet definition up higher on the page.  But I'm just
> thinking out loud, and this depends on a lot of other things, and might be
> getting ahead of ourselves.

Having a three-column layout may be a good idea. However, I'm not sure 
if the snippet definition should actually  be displayed by default at 
all. I think this is only useful as an additional resource. Actually I'm 
thinking of something that Jan-Peter also suggested, maybe displaying 
the code and the usage example in tabs.
And I'm thinking about an infrastructure to also provide an additional 
example with a PNG file that can be used in the documentation.

> Are you planning on having a page that lists all the files by category
> (and/or by name?) with just their title and description, as an overview of
> the whole collection on one page?  I might start with that as the entry
> point to the documentation.

Yes. And we should have a number of pages with general information (a 
"manual" and maybe a Contributors' Guide). I think these will have to be 
written in text files in another directory.

> Seems like once you have that in place the file
> migration can go forward since that meets the need of easily navigating the
> library (that is currently provided by github).  Then it will be easier to
> work confidently on the html/css after the migration.

Yes, but I think I'll work somewhat more with the three files I have 
already present.

Best
Urs

> Sorry I don't have much time to help out at the moment...
>
> Cheers,
> -Paul
>
>
>
> --
> View this message in context: 
> http://lilypond.1069038.n5.nabble.com/openlilylib-generated-docs-HTML-CSS-help-desired-tp164546p164613.html
> Sent from the User mailing list archive at Nabble.com.
>
> _______________________________________________
> lilypond-user mailing list
> address@hidden
> https://lists.gnu.org/mailman/listinfo/lilypond-user