Re: [openlilylib] Discuss restructuring

[Urs Liska]

Am 03.07.2014 19:50, schrieb Paul Morris:
> Uns Liska wrote
> > I think that after an initial phase of trial & error we should
> > now do it right and create a structure we can live with for the future.
>
> Hi Urs,  This is looking like an improvement to me.  Here's a thought.  If
> the emphasis is on include-ability, what about just having all the include
> files at the same level in the "Library" directory, without needing to
> categorize them by putting them in different directories by topic?  Then you
> could just do \include "filename.ily" without having to remember what
> category directory a file is in.  (Maybe stylesheets still gets a directory
> since they are a clear case of a different kind of file with a specific
> usage?)

This is definitely something we should discuss. Although I actually like 
having a category path explicitly written in the input file. And: at 
least Frescobaldi can show you the available categories through 
autocompletion (at least after entering the start of the _first_ folder 
name).

> It seems the category directories are mainly for navigation purposes, i.e.
> for finding things,

apart from what I wrote about explicitly having it in the input file.

> but could this be done (in a more flexible way) through
> tags and/or search?  So a file can be tagged with more than one tag and you
> can see a list of the files for any given tag.  I guess GitHub lends itself
> to organization by nested categories-by-directory rather than by a flat list
> with tags and search...

I'm quite sure that Github doesn't offer that. Which seems clear because 
they concentrate on source code repositories where it doesn't seem to 
make much sense.

> So... one simple way to provide for navigation is to have a GitHub wiki page
> (or the main readme page?) that lists links to the files by category and/or
> tag, and use that for navigation.  That has the advantage of giving you an
> overview of what's in each category/tag, on a single page, rather than
> having to open and close directories.  (This could be maintained manually,
> but I suppose it could also be automated at some point.)

This is probably the way to go anyway. Actually I had this in mind since 
the first steps with the repository. I'd like to have a script that 
walks through the whole library and generates documentation from the 
metadata stored in the files. And just recently I realized that the Wiki 
is the place for this to go. This script would then create the TOC, 
together with some short descriptions of the categories, and 
additionally it could create a detail page for each snippet/item, using 
its example file to create png images.

> In any case, I think having fewer and broader categories is generally
> better.

Thanks for the feedback
Urs

> Cheers,
> -Paul
>
>
>
> --
> View this message in context: 
> http://lilypond.1069038.n5.nabble.com/openlilylib-Discuss-restructuring-tp163922p163950.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