Category:Included in the official documentation: Difference between revisions
No edit summary |
Mention “% LSR” comments |
||
| Line 7: | Line 7: | ||
* The first part of the page is a textual description of what the snippet does, without a LilyPond code block. This text gets converted to the [https://www.gnu.org/software/texinfo/manual/texinfo/ Texinfo format] (as used for all documentation in the LilyPond project) by the [https://pandoc.org/ pandoc converter]. | * The first part of the page is a textual description of what the snippet does, without a LilyPond code block. This text gets converted to the [https://www.gnu.org/software/texinfo/manual/texinfo/ Texinfo format] (as used for all documentation in the LilyPond project) by the [https://pandoc.org/ pandoc converter]. | ||
* The second part is the actual LilyPond code block. It must compile with the current stable release. | * The second part is the actual LilyPond code block. It must compile with the current stable release. Comments that start with <code>% LSR</code> are removed during the import; use such comments for discussion links, for example, that should not show up in the Notation Reference. | ||
* No further explanatory text is allowed after the LilyPond code. | * No further explanatory text is allowed after the LilyPond code. | ||
* At the end of page come the categories. At least one other snippet category besides 'Included in the official documentation' must be specified so that it can be properly grouped in the manual.[[Category:Snippet]] | * At the end of page come the categories. At least one other snippet category besides 'Included in the official documentation' must be specified so that it can be properly grouped in the manual.[[Category:Snippet]] | ||