Help:Contributing: Difference between revisions
Created page with "To create a new page, type the title in the search box, then click on the red link. A simple page can be structured as follows: <pre><nowiki> Some explanatory text. Describe what the snippet does and how to use it. Use wikitext markup like ''italic'', '''bold''' and <code>code fragment</code>. <lilypond version="2.24.0"> % Here goes your LilyPond snippet. Do not include a \version % statement, it will be added automatically. Set the version % in the <lilypond version="..." |
Mention requirements for “official” snippets |
||
| (3 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
You can edit without an account, but this is encouraged if you do more than a handful of edits so that other editors can recognize you and discuss with you in case of need. | |||
To create a new page, type the title in the search box, then click on the red link. A simple page can be structured as follows: | To create a new page, type the title in the search box, then click on the red link. A simple page can be structured as follows: | ||
<pre><nowiki> | <pre><nowiki> | ||
Some explanatory text | Some explanatory text. | ||
<lilypond version="2.24 | <lilypond version="2.24"> | ||
{ c'^"a note!" } | |||
</lilypond> | </lilypond> | ||
</nowiki></pre> | </nowiki></pre> | ||
This renders like this: | |||
:: Some explanatory text. | |||
:: | |||
:: <lilypond version="2.24"> | |||
{ c'^"a note!" } | |||
</lilypond> | |||
First, describe what the snippet does and how to use it. Use [https://www.mediawiki.org/wiki/Help:Formatting wikitext markup] like <code><nowiki>''italic''</nowiki></code> for ''italic'', <code><nowiki>'''bold'''</nowiki></code> for '''bold''' and <code><nowiki><code>\command</code></nowiki></code> for <code>\command</code>. | |||
The LilyPond snippet goes between <code><nowiki><lilypond version="..."></nowiki></code> and <code><nowiki></lilypond></nowiki></code>. | |||
The <code>version</code> parameter is the LilyPond version used to compile the snippet. A <code>\version</code> statement with this version will also be added automatically, so don't repeat it in the snippet code. In almost all cases, you should put the major and minor number of the latest stable release series of LilyPond, e.g., 2.24. This will automatically select the latest micro release in that series, e.g., 2.24.4. However, in case your example specifically requires a newer development version, you can put that specific version here, e.g., 2.25.27 (it will be automatically downloaded on the wiki if needed). | |||
If you need to demonstrate page layout features, use the <code>full</code> keyword to prevent cropping, like this: <code><nowiki><lilypond version="..." full></nowiki></code>. | |||
'''Please be careful while editing snippets that are tagged with the category “Included in the official documentation”!''' There are special requirements so that they can be used seamlessly in LilyPond's documentation. See [[:Category:Included in the official documentation]] for more information. | |||
Latest revision as of 07:11, 10 December 2025
You can edit without an account, but this is encouraged if you do more than a handful of edits so that other editors can recognize you and discuss with you in case of need.
To create a new page, type the title in the search box, then click on the red link. A simple page can be structured as follows:
Some explanatory text.
<lilypond version="2.24">
{ c'^"a note!" }
</lilypond>
This renders like this:
- Some explanatory text.
\version "2.24" { c'^"a note!" }
First, describe what the snippet does and how to use it. Use wikitext markup like ''italic'' for italic, '''bold''' for bold and <code>\command</code> for \command.
The LilyPond snippet goes between <lilypond version="..."> and </lilypond>.
The version parameter is the LilyPond version used to compile the snippet. A \version statement with this version will also be added automatically, so don't repeat it in the snippet code. In almost all cases, you should put the major and minor number of the latest stable release series of LilyPond, e.g., 2.24. This will automatically select the latest micro release in that series, e.g., 2.24.4. However, in case your example specifically requires a newer development version, you can put that specific version here, e.g., 2.25.27 (it will be automatically downloaded on the wiki if needed).
If you need to demonstrate page layout features, use the full keyword to prevent cropping, like this: <lilypond version="..." full>.
Please be careful while editing snippets that are tagged with the category “Included in the official documentation”! There are special requirements so that they can be used seamlessly in LilyPond's documentation. See Category:Included in the official documentation for more information.