<scripttype=text/javascript>varbaseurl="https://prokoudine.github.io/ardour-tutorial/en"</script><scripttype=text/javascriptsrc=/ardour-tutorial/js/search.js?1650836361></script></div><sectionid=homelinks><ul><li><aclass=paddinghref=/ardour-tutorial/en/><iclass="fas fa-home"></i> Home</a></li></ul></section><divclass=highlightable><ulclass=topics><lidata-nav-id=/ardour-tutorial/en/introduction/title=Introductionclass=dd-item><ahref=/ardour-tutorial/en/introduction/><b>1. </b>Introduction</a><ul><lidata-nav-id=/ardour-tutorial/en/introduction/conventions/title=Conventionsclass=dd-item><ahref=/ardour-tutorial/en/introduction/conventions/>Conventions</a></li><lidata-nav-id=/ardour-tutorial/en/introduction/what-is-digital-audio/title="What is digital audio?"class=dd-item><ahref=/ardour-tutorial/en/introduction/what-is-digital-audio/>What is digital audio?</a></li></ul></li><lidata-nav-id=/ardour-tutorial/en/getting-started/title="Getting started"class=dd-item><ahref=/ardour-tutorial/en/getting-started/><b>2. </b>Getting started</a><ul><lidata-nav-id=/ardour-tutorial/en/getting-started/starting-ardour-on-ubuntu/title="Starting Ardour"class=dd-item><ahref=/ardour-tutorial/en/getting-started/starting-ardour-on-ubuntu/>Starting Ardour</a></li><lidata-nav-id=/ardour-tutorial/en/getting-started/overview-of-the-interface/title="Overview of the Interface"class=dd-item><ahref=/ardour-tutorial/en/getting-started/overview-of-the-interface/>Overview of the Interface</a><ul><lidata-nav-id=/ardour-tutorial/en/getting-started/overview-of-the-interface/editor-window/title="Editor window"class=dd-item><ahref=/ardour-tutorial/en/getting-started/overview-of-the-interface/editor-window/>Editor window</a></li><lidata-nav-id=/ardour-tutorial/en/getting-started/overview-of-the-interface/mixer-window/title="Mixer window"class=dd-item><ahref=/ardour-tutorial/en/getting-started/overview-of-the-interface/mixer-window/>Mixer window</a></li><lidata-nav-id=/ardour-tutorial/en/getting-started/overview-of-the-interface/recorder-window/title="Recorder window"class=dd-item><ahref=/ardour-tutorial/en/getting-started/overview-of-the-interface/recorder-window/>Recorder window</a></li><lidata-nav-id=/ardour-tutorial/en/getting-started/overview-of-the-interface/cue-window/title="Cue window"class=dd-item><ahref=/ardour-tutorial/en/getting-started/overview-of-the-interface/cue-window/>Cue window</a></li></ul></li><lidata-nav-id=/ardour-tutorial/en/getting-started/creating-tracks-and-busses/title="Creating tracks and busses"class=dd-item><ahref=/ardour-tutorial/en/getting-started/creating-tracks-and-busses/>Creating tracks and busses</a></li><lidata-nav-id=/ardour-tutorial/en/getting-started/importing-audio/title="Importing audio"class=dd-item><ahref=/ardour-tutorial/en/getting-started/importing-audio/>Importing audio</a></li><lidata-nav-id=/ardour-tutorial/en/getting-started/setting-up-the-timeline/title="Setting up the timeline"class=dd-item><ahref=/ardour-tutorial/en/getting-started/setting-up-the-timeline/>Setting up the timeline</a></li></ul></li><lidata-nav-id=/ardour-tutorial/en/recording-audio/title=Recordingclass=dd-item><ahref=/ardour-tutorial/en/recording-audio/><b>3. </b>Recording</a><ul><lidata-nav-id=/ardour-tutorial/en/recording-audio/recording-audio/title="Recording audio"class=dd-item><ahref=/ardour-tutorial/en/recording-audio/recording-audio/>Recording audio</a></li><lidata-nav-id=/ardour-tutorial/en/recording-audio/understanding-routing/title="Understanding routing"class=dd-item><ahref=/ardour-tutorial/en/recording-audio/understanding-routing/>Understanding routing</a></li><lidata-nav-id=/ardour-tutorial/en/recording-audio/routing-between-applications/title="Routing between applications"class=dd-item><ahref=/ardour-tutorial/en/recording-audio/routing-between-applications/>Routing between applications</a></li></ul></li><lidata-nav-id=/ardour-tutorial/en/editing-sessions/title="Editing sessions"class=dd-item><ahref=/ardour-tutorial/en/editing-sessions/><b>4. </b>Editi
<spanclass=links><ahref=/ardour-tutorial/en/>Home</a> > <ahref=/ardour-tutorial/en/appendices/>Appendices</a> > How to contribute</span></div><divclass=progress><divclass=wrapper><navid=TableOfContents><ul><li><ahref=#what-kind-of-contributions-we-accept>What Kind Of Contributions We Accept</a></li><li><ahref=#using-markdown-syntax-and-extras>Using Markdown Syntax And Extras</a></li><li><ahref=#how-to-submit-changes>How to Submit Changes</a></li><li><ahref=#how-to-create-and-submit-a-translation>How To Create And Submit A Translation</a><ul><li><ahref=#translating-menu>Translating Menu</a></li><li><ahref=#translating-chapters-and-pages>Translating Chapters And Pages</a></li><li><ahref=#translating-user-interface-elements-and-screenshots>Translating User Interface Elements and Screenshots</a></li><li><ahref=#submitting-translation>Submitting Translation</a></li></ul></li></ul></nav></div></div></div></div><divid=head-tags></div><divid=body-inner><h1>How to contribute</h1><h2id=what-kind-of-contributions-we-accept>What Kind Of Contributions We Accept</h2><p>We intentionally limit the scope of this tutorial to very basic techniques that
encourage translations of the ardour-tutorial.</p><h2id=using-markdown-syntax-and-extras>Using Markdown Syntax And Extras</h2><p>All text files use Markdown syntax with a few extras. We use a limited subset of
available options and one shortcode specific to HTML5, a <code><figure></code> element
(<ahref=https://gohugo.io/content-management/shortcodes/#figure>see here</a> for more
info). Another extra feature available in the template of choice is a so called
shortcode for notice boxes that look like this:</p><divclass="notices tip"><p>Some text</p></div><p>We generally stick to two type of notice boxes: ’tip’ and ‘warning’.</p><p>The rest is really straightforward:</p><ul><li>Single underscore like <code>_Name_</code> makes italics and is used for UI elements like
window captions.</li><li>Double asterisk like <code>**OK**</code> makes bolds and is reserved for button captions.</li><li>Backticks around some text are typically reserved for menu paths and filenames.</li></ul><h2id=how-to-submit-changes>How to Submit Changes</h2><p>The repository with this tutorial is available on GitHub. The general idea is
for a complete guide.</p><h2id=how-to-create-and-submit-a-translation>How To Create And Submit A Translation</h2><p>The entire tutorial can be translated into a different language. Once you create
a git branch to separate your work, here is what you do next.</p><h3id=translating-menu>Translating Menu</h3><p>The menu is stored in <code>config.toml</code>, inside the <code>[Languages]</code> section. For each
language, that section has two parts:</p><ol><li>The main part where names of chapters and pages chow up.</li><li>The ‘shortcuts’ menu with links to Ardour’s homepage, forum etc.</li></ol><p>To translate the header of the main part, copy and paste the entire block that
starts with <code>[Languages.en]</code> and then:</p><ol><li>Change the language code in <code>[Languages.en]</code>.</li><li>Translate the title.</li><li>Submit the name of the language that will show up in the drop-down list of
available translations. We encourage you to use language
or the local one, in your alphabet — whichever works for you.</li><li>Change the two-letter language code in the line that starts with
<code>landingPageURL</code>.</li><li>Translate the caption of the homepage of the tutorial in the line that starts
with <code>landingPageName</code>.</li></ol><p>Thus</p><pretabindex=0><code>[Languages.en]
</code></pre><p>This main part of the menu will start automatically accumulating links to
translated pages as you start adding pages with translations.</p><p>Use the same approach to translate the shortcuts menu. E.g. the link to Ardour’s
</code></pre><p>Please keep all translations of the menu in a single larger block.</p><h3id=translating-chapters-and-pages>Translating Chapters And Pages</h3><p>All content lives inside the <code>content</code> folder where subfolders are names of
chapters like <em>Recording</em> (<code>recording</code>), <em>Mixing sessions</em> (<code>mixing-sessions</code>)
etc. Here is the general structure:</p><pretabindex=0><code>/content # The root folder for all content
/content/_index.en.md # The start page you see when you click Home
/content/chapter-folder/ # The folder for an entire chapter like "Recording"
/content/chapter-folder/_index.en.md # Chapter
/content/chapter-folder/page/ # Folder for a page in a chapter, e.g. "Understanding Routing"
/content/chapter-folder/page/index.md # Original text of that page in English
/content/chapter-folder/page/en/ # Screenshots created with English user interface
</code></pre><p>All text files have a language code right in the file name:</p><ul><li>regular pages are named <code>index.XX.md</code>,</li><li>chapters are named <code>_index.XX.md</code>,</li></ul><p>where XX is a two-letter language code like ‘de’ for German or ‘fr’ for French. You should be able to use four-letter codes as well, e.g. ‘pt_BR’ or ’es_AR’.</p><p>Supposing you want to translate the <em>Getting Started</em> chapter into French. Here
is how you do it.</p><ol><li><p>Create a copy of <code>getting-started/_index.en.md</code> and name it <code>_index.fr.md</code>.
Now you should have <code>_index.en.md</code> and <code>_index.fr.md</code> in the same folder.</p></li><li><p>Translate <code>_index.fr.md</code>. If you already translated the main menu, you should
be able to open the original page in English, switch the language to ‘Français’
and see your translated page.</p></li><li><p>Go to the <code>starting-ardour</code> subfolder, create a copy of <code>index.en.md</code> and
name it <code>index.fr.md</code> and then translate it.</p></li><li><p>Repeat step 3 for all subfolders. This should give you the translation of an
entire chapter on getting started with Ardour.</p></li></ol><h3id=translating-user-interface-elements-and-screenshots>Translating User Interface Elements and Screenshots</h3><p>If Ardour’s user interface is available in the language you are translating this
tutorial into, it is generally up to you to decide if you refer to localized
user interface or not.</p><p>We know that users are very passionate about both localized and non-localized
UIs, so one approach you could take is to create localized screenshots, refer to
localized user interface and then mention the English counterparts in
parenthesis. Here is an example of a translation into German:</p><blockquote><p>Nach dem Import einiger Sounds aus dem heruntergeladenen Sample-Pack
(Bassdrum, Snare, Hi-Hat, Clap) sieht unsere Session so aus (in diesem Fall
haben wir die Option <em>Dateien als neue Spuren hinzufügen</em> (EN: <em>Add files as new
tracks</em>) verwendet und beim Start der Session eingefügt.</p></blockquote><p>If you intend to create screenshots of localized user interface, please create a
subfolder that’s named after a language code (two-letter of four-letter,
whichever is applicable) and place your screenshots there. Having done so,
please update references to screenshots in the text. E.g.</p><pretabindex=0><code>src="en/ardour7-save-template.png"
</code></pre><h3id=submitting-translation>Submitting Translation</h3><p>The process is the same as for general patches: submit a pull request. See above
for a link to a step-by-step guide.</p><footerclass=footline></footer></div></div><divid=navigation></div></section><divstyle=left:-1000px;overflow:scroll;position:absolute;top:-1000px;border:none;box-sizing:content-box;height:200px;margin:0;padding:0;width:200px><divstyle=border:none;box-sizing:content-box;height:200px;margin:0;padding:0;width:200px></div></div><scriptsrc=/ardour-tutorial/js/clipboard.min.js?1650836361></script>
