Category:Included in the official documentation: Difference between revisions
Import snippet from LSR |
No edit summary |
||
| Line 1: | Line 1: | ||
Pages in this category are part of the official LilyPond documentation, available in the [https://lilypond.org/snippets.html 'Snippets' manual]. A subset is also included in the [https://lilypond.org/notation.html Notation Reference]. | |||
The selection of the snippets that are added to the LilyPond documentation is done at the discretion of the LilyPond maintainers, so please don't add the 'Included in the official documentation' category by yourself. | |||
There are some formatting guidelines that must be obeyed so that inclusion into the LilyPond documentation works. | |||
* 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. | |||
* 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. | |||