openlilylib-user

[oll-user] OLLib renaming

[Urs L. <ul...@op...>]

Hi all,

I'm busy reorganising the repos and making good progress, I think.

When coming to the OLLib subdirectory I realized that we should
reconsider the naming.

Originally 'openLilyLib' was to be the name of the LilyPond library, but
when I decided to connect my other projects (i.e. the LaTeX packages) to
it it was clear that 'openLilyLib' would be the name of the complete
project. (I think '...Lib' is a good name for the 'family of resources'
I label it elsewhere.)
Consequently I renamed the library subdirectory to 'OLLib' - intending
to indicate that this is the actual library. But after some time I find
this somewhat obscure, and although this part is probably the one that
will be of most interest to you it actually is just one of several
subprojects.

So I ask for suggestions for a better name in the sense 'The XXX
library, part of openLilyLib'.
We need a 'label' name and a repo/directory name. They may be the same
or different, at least the latter being lowercase.

My suggestions (I always prepend the root folder):
- openlilylib/oll-lib
- openlilylib/lilylib
- openlilylib/lib
- openlilylib/llib
- openlilylib/ollib (the same as the current, in lowercase)

Any better ideas?

Urs

Re: [oll-user] OLLib renaming

[Urs L. <ul...@op...>]

Update:

how to organize the directory structure?

We'll have one root directory, and part of the 'installation'
requirements is to make this root dir available to LilyPond.

I see two set-ups how to make the contents available to .ly documents:
(I'll write 'OLLIB' as a placeholder for a to-be-agreed-upon name)


\include "OLLIB.ily" for the full lib -> would be natural, but:
\include "tb/curvestoolbox.ily" is less expressive than
\include "OLLIB/curvestoolbox.ily". And
\include "includes/stylesheets/a4-lied.ily" is much less expressive than
\include "OLLIB/includes/stylesheets/a4-lied.ily"

So I propose to set up the root dir like:
- documentation
- examples
- templates
- OLLIB
  |- includes
  |- tb (see below)
     |- curves (etc.)
  |- full.ily
  |- curves.ily (etc. for loading individual sublibraries)

full.ily loads the complete library (but not examples, templates and
includes)-
curves.ily etc. load partial libraries
tb/ contains the code for the partial libraries, i.e. there is one
subfolder of tb/ for each .ily file

So the user can write forexample:
\include "OLLIB/full.ily"
\include "OLLIB/curves.ily"
\include "OLLIB/includes/scoreblocks/piano4hd.ily"

Examples and templates are items that aren't usually included but opened
and/or copied directly, so they can remain at the root level.

Any comments, disapproval, better ideas?

Urs

Am Donnerstag, den 18.04.2013, 10:19 +0200 schrieb Urs Liska:
> Hi all,
> 
> I'm busy reorganising the repos and making good progress, I think.
> 
> When coming to the OLLib subdirectory I realized that we should
> reconsider the naming.
> 
> Originally 'openLilyLib' was to be the name of the LilyPond library, but
> when I decided to connect my other projects (i.e. the LaTeX packages) to
> it it was clear that 'openLilyLib' would be the name of the complete
> project. (I think '...Lib' is a good name for the 'family of resources'
> I label it elsewhere.)
> Consequently I renamed the library subdirectory to 'OLLib' - intending
> to indicate that this is the actual library. But after some time I find
> this somewhat obscure, and although this part is probably the one that
> will be of most interest to you it actually is just one of several
> subprojects.
> 
> So I ask for suggestions for a better name in the sense 'The XXX
> library, part of openLilyLib'.
> We need a 'label' name and a repo/directory name. They may be the same
> or different, at least the latter being lowercase.
> 
> My suggestions (I always prepend the root folder):
> - openlilylib/oll-lib
> - openlilylib/lilylib
> - openlilylib/lib
> - openlilylib/llib
> - openlilylib/ollib (the same as the current, in lowercase)
> 
> Any better ideas?
> 
> Urs
> 
> 
> ------------------------------------------------------------------------------
> Precog is a next-generation analytics platform capable of advanced
> analytics on semi-structured data. The platform includes APIs for building
> apps and a phenomenal toolset for data science. Developers can use
> our toolset for easy data analysis & visualization. Get a free account!
> http://www2.precog.com/precogplatform/slashdotnewsletter
> _______________________________________________
> openlilylib-user mailing list
> ope...@li...
> https://lists.sourceforge.net/lists/listinfo/openlilylib-user

Re: [oll-user] OLLib renaming

[Ian H. <ia...@hu...>]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi Urs and all,
On 18/04/13 09:19, Urs Liska wrote:
> Hi all,
> 
> I'm busy reorganising the repos and making good progress, I think.
> 
> When coming to the OLLib subdirectory I realized that we should 
> reconsider the naming.
> 
> Originally 'openLilyLib' was to be the name of the LilyPond
> library, but when I decided to connect my other projects (i.e. the
> LaTeX packages) to it it was clear that 'openLilyLib' would be the
> name of the complete project. (I think '...Lib' is a good name for
> the 'family of resources' I label it elsewhere.) Consequently I
> renamed the library subdirectory to 'OLLib' - intending to indicate
> that this is the actual library. But after some time I find this
> somewhat obscure, and although this part is probably the one that 
> will be of most interest to you it actually is just one of several 
> subprojects.
> 
> So I ask for suggestions for a better name in the sense 'The XXX 
> library, part of openLilyLib'. We need a 'label' name and a
> repo/directory name. They may be the same or different, at least
> the latter being lowercase.
> 
> My suggestions (I always prepend the root folder): -
> openlilylib/oll-lib - openlilylib/lilylib - openlilylib/lib -
> openlilylib/llib - openlilylib/ollib (the same as the current, in
> lowercase)
> 
> Any better ideas?
> 
> Urs
We've got some slightly conflicting goals, then.
1) is what looks good in 'The XXX library part of openLilyLib'
2) what is unique and descriptive in the file system structure
3) what is *not* too long for people typing the name in a hurry, and
have mistake-prone fingers, like me.

How about openlilylib/oll-library?  (prefix all Open Lily Library
stuff at this level with oll, separate it with a hyphen[1]), or your
oll-lib suggestion above.

HTH
Cheers,
Ian

[1] The files within the directory or any parallel to this would not
need the oll- prefix however.


-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.11 (GNU/Linux)
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iQEcBAEBAgAGBQJRb71pAAoJEBqidDirZqASGBMH/1ZTo/Fxi2XXJrH9Q/22varM
PqtVg9Y9WvbLt+OxDxlBzTKO+QnemgnbmenqU/TDTBRt5WZ+n4lnAsUlraPElQIw
HO8/IHxSe+C4xnZNmIivkyjaw7VaOVVu1cvjF6sdh3IAOppzKP1+nAj04UZCLP7v
76Mhb1dySTfiKRuAkH7RjfE2CgqMEcOg6cAAmf+X/ZauAiDY5/STebwLowEyvUwT
YKo7aYHRXhjd6tebUSgWQzmFTHdrhPd4J365es2HaPkRzph9KhtDKsi7V8xvOb3L
yDkHxcOUsJgx/48ZR+TLTjRMEvuz+S9dPdPDHmJiJVn5XDjJuw9mGOBHa6mg+uU=
=A7gO
-----END PGP SIGNATURE-----

Re: [oll-user] OLLib renaming

[Urs L. <ul...@op...>]

Am Donnerstag, den 18.04.2013, 10:31 +0100 schrieb Ian Hulin:
> Hi Urs and all,
> On 18/04/13 09:19, Urs Liska wrote:
> > Hi all,
> > 
> > I'm busy reorganising the repos and making good progress, I think.
> > 
> > When coming to the OLLib subdirectory I realized that we should 
> > reconsider the naming.
> > 
...
> > 
> > Urs
> We've got some slightly conflicting goals, then.
> 1) is what looks good in 'The XXX library part of openLilyLib'
> 2) what is unique and descriptive in the file system structure
> 3) what is *not* too long for people typing the name in a hurry, and
> have mistake-prone fingers, like me.
You're right. Probably I wouldn't have had to ask if there weren't any
conflicts ;-)
> 
> How about openlilylib/oll-library?  (prefix all Open Lily Library
> stuff at this level with oll, separate it with a hyphen[1]), or your
> oll-lib suggestion above.
This means in our openlilylib root directory we'd have:
openlilylib
| oll-base (new: LaTeX classes/packages and maybe some helper scripts)
| oll-lib
| oll-tutorials
but:
| lilyglyphs
| musicexamples
| website
?

Alternative (Jan-Peter's preference):
openlilylib
| base
| lilyglyphs
| musicexamples
| lilylib
| tutorials
| website

I prefer the latter because the oll- is in most cases a redundancy.
Maybe ollib instead of lilylib, but see my comment on Jan-Peter's mail.

Urs


> 
> HTH
> Cheers,
> Ian
> 
> [1] The files within the directory or any parallel to this would not
> need the oll- prefix however.
> 
> 

Re: [oll-user] OLLib renaming

[Jan-Peter V. <jp....@gm...>]

Hi Urs,

now I have little time and can take a look at the progression this 
project made. I have cloned (again ;) ) all repos from github and 
succesfully compiled some of the tex files.
As I only use xelatex for some dedicated things, it took some time, to 
make the cls and sty files visible for my texlive here. I use Ubuntu 
precise with texlive 2012 and the solution is not very complicated, but 
one has to know. So I propose to include this hint somewhere for example 
in a README file:
I created a directory: mkdir -p ~/texmf/tex/xelatex/
and then created symbolic links to <path to openlilylib>/lilyglyphs 
<path to openlilylib>/oll-archive/OLLlatex and <path to 
openlilylib>/musicexamples in that directory.
I didn't need to run texhash, because this location is the default place 
user modifications.

 From the suggested names I would prefer lilylib or ollib.

Best,
Jan-Peter

Am 18.04.2013 10:19, schrieb Urs Liska:
> Hi all,
>
> I'm busy reorganising the repos and making good progress, I think.
>
> When coming to the OLLib subdirectory I realized that we should
> reconsider the naming.
>
> Originally 'openLilyLib' was to be the name of the LilyPond library, but
> when I decided to connect my other projects (i.e. the LaTeX packages) to
> it it was clear that 'openLilyLib' would be the name of the complete
> project. (I think '...Lib' is a good name for the 'family of resources'
> I label it elsewhere.)
> Consequently I renamed the library subdirectory to 'OLLib' - intending
> to indicate that this is the actual library. But after some time I find
> this somewhat obscure, and although this part is probably the one that
> will be of most interest to you it actually is just one of several
> subprojects.
>
> So I ask for suggestions for a better name in the sense 'The XXX
> library, part of openLilyLib'.
> We need a 'label' name and a repo/directory name. They may be the same
> or different, at least the latter being lowercase.
>
> My suggestions (I always prepend the root folder):
> - openlilylib/oll-lib
> - openlilylib/lilylib
> - openlilylib/lib
> - openlilylib/llib
> - openlilylib/ollib (the same as the current, in lowercase)
>
> Any better ideas?
>
> Urs
>
>
> ------------------------------------------------------------------------------
> Precog is a next-generation analytics platform capable of advanced
> analytics on semi-structured data. The platform includes APIs for building
> apps and a phenomenal toolset for data science. Developers can use
> our toolset for easy data analysis & visualization. Get a free account!
> http://www2.precog.com/precogplatform/slashdotnewsletter
> _______________________________________________
> openlilylib-user mailing list
> ope...@li...
> https://lists.sourceforge.net/lists/listinfo/openlilylib-user

Re: [oll-user] OLLib renaming

[Urs L. <ul...@op...>]

Am Donnerstag, den 18.04.2013, 11:44 +0200 schrieb Jan-Peter Voigt:
> Hi Urs,
> 
> now I have little time and can take a look at the progression this 
> project made. I have cloned (again ;) ) all repos from github and 
> succesfully compiled some of the tex files.
Be prepared that you might have to do that again, as the repos aren't
quite stable yet. But I hope that this will only result in additional
repos and the corresponding removal of folders in oll-archive.

> As I only use xelatex for some dedicated things, it took some time, to 
> make the cls and sty files visible for my texlive here. I use Ubuntu 
> precise with texlive 2012 and the solution is not very complicated, but 
> one has to know. So I propose to include this hint somewhere for example 
> in a README file:
> I created a directory: mkdir -p ~/texmf/tex/xelatex/
> and then created symbolic links to <path to openlilylib>/lilyglyphs 
> <path to openlilylib>/oll-archive/OLLlatex and <path to 
> openlilylib>/musicexamples in that directory.
> I didn't need to run texhash, because this location is the default place 
> user modifications.
I'm sure that had once been in a readme file, but due to the
reorganization that will have been buried somewhere.
Once the repos are fixed I'll look into that again.

> 
>  From the suggested names I would prefer lilylib or ollib.
I like lilylib - it is just that is actually the finger equivalent to a
tongue twister ;-)

ollib looks somewhat like a _word_ instead of the hybrid between acronym
and abbreviation it is. OLLib was better in this regard, but I think it
was a good suggestion to make all file/dir names lowercase.

See also my reply to Ian's post

Urs

> 
> Best,
> Jan-Peter
> 
> Am 18.04.2013 10:19, schrieb Urs Liska:
> > Hi all,
> >
> > I'm busy reorganising the repos and making good progress, I think.
> >
> > When coming to the OLLib subdirectory I realized that we should
> > reconsider the naming.
> >
> > Originally 'openLilyLib' was to be the name of the LilyPond library, but
> > when I decided to connect my other projects (i.e. the LaTeX packages) to
> > it it was clear that 'openLilyLib' would be the name of the complete
> > project. (I think '...Lib' is a good name for the 'family of resources'
> > I label it elsewhere.)
> > Consequently I renamed the library subdirectory to 'OLLib' - intending
> > to indicate that this is the actual library. But after some time I find
> > this somewhat obscure, and although this part is probably the one that
> > will be of most interest to you it actually is just one of several
> > subprojects.
> >
> > So I ask for suggestions for a better name in the sense 'The XXX
> > library, part of openLilyLib'.
> > We need a 'label' name and a repo/directory name. They may be the same
> > or different, at least the latter being lowercase.
> >
> > My suggestions (I always prepend the root folder):
> > - openlilylib/oll-lib
> > - openlilylib/lilylib
> > - openlilylib/lib
> > - openlilylib/llib
> > - openlilylib/ollib (the same as the current, in lowercase)
> >
> > Any better ideas?
> >
> > Urs
> >
> >
> > ------------------------------------------------------------------------------
> > Precog is a next-generation analytics platform capable of advanced
> > analytics on semi-structured data. The platform includes APIs for building
> > apps and a phenomenal toolset for data science. Developers can use
> > our toolset for easy data analysis & visualization. Get a free account!
> > http://www2.precog.com/precogplatform/slashdotnewsletter
> > _______________________________________________
> > openlilylib-user mailing list
> > ope...@li...
> > https://lists.sourceforge.net/lists/listinfo/openlilylib-user
> 
> 
> ------------------------------------------------------------------------------
> Precog is a next-generation analytics platform capable of advanced
> analytics on semi-structured data. The platform includes APIs for building
> apps and a phenomenal toolset for data science. Developers can use
> our toolset for easy data analysis & visualization. Get a free account!
> http://www2.precog.com/precogplatform/slashdotnewsletter
> _______________________________________________
> openlilylib-user mailing list
> ope...@li...
> https://lists.sourceforge.net/lists/listinfo/openlilylib-user