Category:Included in the official documentation: Difference between revisions

Pages in this category are part of the official LilyPond documentation, available in the ‘Snippets’ manual. A subset is also included in the 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 Texinfo format (as used for all documentation in the LilyPond project) by the pandoc converter.

• Please be careful with adding links (i.e., either [...] or [[...]]). While it is OK to add links to other “official” documentation snippets, you should avoid links to generic topics like “rests” or “skips”, contrary to what you would do in a “normal” Wiki like Wikipedia.

• Text that is intended to be displayed in the Wiki only without showing up in the official documentation should be embedded into <div class="nodoc">...</div> (for blocks) or <span class="nodoc">...</span> (for inline text). These tags have no effect in the Wiki and are removed during the import.

• The second part is the actual LilyPond code block. It must compile with the current stable release. Comments that start with % LSR 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.

• At the end of page come the categories. At least one other snippet category besides ‘Included in the official documentation’ and ‘Snippet’ must be specified so that it can be properly grouped in the manual.

• Some remarks regarding typography (before the LilyPond code block).
  • <pre>...</pre> gets converted to a non-indented verbatim text block. Wiki markup like ''...'' is properly ignored.
  • Preformatted text (i.e., text lines starting with a space) gets converted to an indented verbatim text block that also honours Wiki markup like ''...''.