[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: sections done

From: John Mandereau
Subject: Re: sections done
Date: Sat, 15 Sep 2007 01:12:52 +0200

Le vendredi 14 septembre 2007 à 13:26 -0700, Graham Percival a écrit :
> Ok, I think we've reached the point of diminishing returns.  The latest 
> sectioning is pretty solid.  There will still be a few problems, but 
> we'll tackle those when we investigate each section individually.  I 
> don't think it's worth holding up the main part of GDP any more.
> John, could you do the following:
> - make a new branch in git   ( doc/gdp ?  whatever the appropriate name 
> would be)    (I tried to remove the doc-experimental, but I'm not 
> certain if it actually worked or not.  If it's still there, please kill it)

I killed doc-experimental (and fr-doc too).  The new branch may be named
lilypond/gdp ("lilypond" because these are lilypond sources, and "doc"
isn't necessary because it's part of the GDP initialism).

> - split the Learning manual away from the main manual (just like
> Program 
> usage).  For now, take all of chapters 1-5.
> - point the "tutorial" link in Documentation/  to the
> table 
> of contents of the Learning Manual.
> - make a directory Documentation/user/notation/
> - split up basic-notation, instrument-specific, and advanced-notation 
> into section files inside notation.  ie
>     ./notation/pitches.itely
>     ./notation/rhythms.itely
>     ./notation/expressive.itely
> Having one .itely file for the whole thing would be too awkward.  We 
> could invisibly keep stuff split up into basic- and instrument- , but 
> that's also awkward.  Plus, having the files split up this way will
> make 
> it much easier to coordinate with the trivial/easy helpers.


> - I really wish I could do some of these steps.  Are you sure that
> it's 
> easier for you in the long term (ie not screwing up Translations) if
> you 
> do this all yourself?  :(

I don't mind about who does these steps, but it's important that each
step (including typos and nitpicks) is done for *all* languages at the
same time (i.e. in the same commit or a consecutive commits sequence).
If there is one thing you want to do that you can't do in *all*
languages, please postpone it after the big rearrangement.

When rearranging sections, it's important to treat untranslated sections
just like translated one (i.e. move the @node/@(sub)*sec commands with

There is a final step to add, after the sections rearrangement is done
and before making any other changes in the docs: updating committishes
in translations and marking files not translated at all as skeleton (and
less importantly updating doc POs).  Of course, I'll do this step.

Graham, which steps would you like to do?  I don't request anything
other than following the rules above, so I'll agree with whatever you
propose :-)

> Here's my current sections.  Let me know when you plan on doing the 
> actual rearrangement, just in case somebody sends an absolutely 
> compelling rearrangement proposal in the next $foo hours.

I plan to do this either Sunday afternoon and evening (European time) or
next Thursday or Friday, depending on when the translations are up to
date and what we decide about who does what.


reply via email to

[Prev in Thread] Current Thread [Next in Thread]