From: Graham Percival Date: Sun, 1 Feb 2009 14:47:16 +0000 (+0800) Subject: More misc CG stuff. X-Git-Tag: release/2.13.0-0~46 X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=57dd0048cdc5a38513e9771a8a6e51bc42c0c1be;p=lilypond.git More misc CG stuff. --- diff --git a/Documentation/devel/doc-work.itexi b/Documentation/devel/doc-work.itexi index 5dfef1d625..86f93fc838 100644 --- a/Documentation/devel/doc-work.itexi +++ b/Documentation/devel/doc-work.itexi @@ -55,6 +55,19 @@ limited documentation help. @node Texinfo crash course @section Texinfo crash course +@menu +* Texinfo introduction:: +* Sectioning commands:: +* LilyPond formatting:: +* Text formatting:: +* Syntax survey:: +* Other text concerns:: +@end menu + + +@node Texinfo introduction +@subsection Texinfo introduction + The language is called texinfo; you can see its manual here: @uref{http://www.gnu.org/software/texinfo/manual/texinfo/} @@ -68,6 +81,7 @@ You can learn most of what you need to know from this; if you want to do anything fancy, discuss it on @code{lilypond-devel} first.} +@node Sectioning commands @subsection Sectioning commands Most of the manual operates at the @@ -98,7 +112,7 @@ ode. @end itemize - +@node LilyPond formatting @subsection LilyPond formatting @itemize @@ -236,6 +250,7 @@ Documentation Editor. @end itemize +@node Text formatting @subsection Text formatting @itemize @@ -367,6 +382,7 @@ enclose it with @end itemize +@node Syntax survey @subsection Syntax survey @itemize @@ -427,6 +443,7 @@ B ... @@end itemize - for bulleted lists. +@node Other text concerns @subsection Other text concerns @itemize @@ -484,7 +501,15 @@ that all such characters appear in all output formats. @node Documentation policy @section Documentation policy +@menu +* Books:: +* Section organization:: +* Checking cross-references:: +* General writing:: +* Technical writing style:: +@end menu +@node Books @subsection Books There are four parts to the documentation: the Learning Manual, @@ -566,6 +591,7 @@ automagically generated from the source, but this is its name. @end itemize +@node Section organization @subsection Section organization @itemize @@ -657,6 +683,7 @@ but other than that all material goes into third-level sections @end itemize +@node Checking cross-references @subsection Checking cross-references Cross-references between different manuals are heavily used in the @@ -671,6 +698,7 @@ cross-references in the generated documentation such as the Internals Reference; e.g. you can grep scm/ and lily/. +@node General writing @subsection General writing @itemize @@ -735,6 +763,7 @@ chord construct NOT chord (when referring to <>) @end itemize +@node Technical writing style @subsection Technical writing style These refer to the NR. The LM uses a more gentle, colloquial diff --git a/Documentation/devel/lsr-work.itexi b/Documentation/devel/lsr-work.itexi index 9b239ee34a..54b1efe259 100644 --- a/Documentation/devel/lsr-work.itexi +++ b/Documentation/devel/lsr-work.itexi @@ -13,16 +13,91 @@ @node Introduction to LSR @section Introduction to LSR +The +@uref{http://lsr.dsi.unimi.it/, LilyPond Snippet Repository (LSR)} +is a collection of lilypond examples. A subset of these examples +are automatically imported into the documentation, making it easy +for users to contribute to the docs without learning git and +texinfo. + @node Adding snippets @section Adding snippets +When you create (or find!) a nice snippet, please add it to LSR. +Go to @uref{http://lsr.dsi.unimi.it/, LSR} and log in (if you +haven't already, create an account). Follow the instructions on +the website. + +If you think the snippet is particularly informative and you think +it should be included in the documentation, tag it with "docs" and +one or more other categories. + +Please make sure that the lilypond code follows the guidelines in +@ref{LilyPond formatting}. + @node Approving snippets @section Approving snippets +The main task of LSR editors are approving snippets. Log in to +@uref{http://lsr.dsi.unimi.it/, LSR} and find a list of unapproved +snippets by +FIXME DOING SOMETHING. + +Check each snippet: + +@enumerate + +@item +Does the snippet make sense and does what the author claims that +it does? If you think the snippet is particularly helpful, add +the "docs" tag and at least one other tag. + +@item +If the snippet is tagged with "docs", check to see if it matches +our guidelines for @ref{LilyPond formatting}. + +@item +If the snippet uses scheme, check that everything looks good and +there are no security risks. + +@warning{Somebody could sneak a @code{#'(system "rm -rf /")} +command into our source tree if you do not do this! Take this +step @strong{VERY SERIOUSLY}.} + +@end enumerate + @node LSR to git @section LSR to git +FIXME: Neil, please check that this is up-to-date. + +@enumerate + +@item +Download the latest tarball from +@uref{http://lsr.dsi.unimi.it/download/}. You want a file called +@file{lsr-snippets-docs-DATE.tar.gz}. + +@item +From the top source directory, run: + +@example +scripts/auxiliar/makelsr.py +@end example + +@item +Follow the instructions on the console to manually check for +unsafe files. + +@warning{Somebody could sneak a @code{#'(system "rm -rf /")} +command into our source tree if you do not do this! Take this +step @strong{VERY SERIOUSLY}.} + +@item +Do a git add / commit / push. + +@end enumerate diff --git a/Documentation/devel/website-work.itexi b/Documentation/devel/website-work.itexi index c452cb2c38..cb4e0aac9a 100644 --- a/Documentation/devel/website-work.itexi +++ b/Documentation/devel/website-work.itexi @@ -11,7 +11,8 @@ @node Introduction to website work @section Introduction to website work - +Short answer: don't do it yet. We're completely revamping the +website. @node Translating the website