91 lines
26 KiB
HTML
91 lines
26 KiB
HTML
<!doctype html><html lang=en class="js csstransforms3d"><head><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1"><meta name=generator content="Hugo 0.97.3"><meta name=description content><link rel=icon href=/ardour-tutorial/images/favicon.png type=image/png><title>How to contribute :: Ardour tutorial</title><link href=/ardour-tutorial/css/nucleus.css?1650836361 rel=stylesheet><link href=/ardour-tutorial/css/fontawesome-all.min.css?1650836361 rel=stylesheet><link href=/ardour-tutorial/css/hybrid.css?1650836361 rel=stylesheet><link href=/ardour-tutorial/css/featherlight.min.css?1650836361 rel=stylesheet><link href=/ardour-tutorial/css/perfect-scrollbar.min.css?1650836361 rel=stylesheet><link href=/ardour-tutorial/css/auto-complete.css?1650836361 rel=stylesheet><link href=/ardour-tutorial/css/atom-one-dark-reasonable.css?1650836361 rel=stylesheet><link href=/ardour-tutorial/css/theme.css?1650836361 rel=stylesheet><link href=/ardour-tutorial/css/tabs.css?1650836361 rel=stylesheet><link href=/ardour-tutorial/css/hugo-theme.css?1650836361 rel=stylesheet><link href=/ardour-tutorial/css/theme-blue.css?1650836361 rel=stylesheet><script src=/ardour-tutorial/js/jquery-3.3.1.min.js?1650836361></script><style>:root #header+#content>#left>#rlblock_left{display:none!important}:not(pre)>code+span.copy-to-clipboard{display:none}</style></head><body data-url=/ardour-tutorial/en/appendices/how-to-contribute/><nav id=sidebar><div id=header-wrapper><div id=header><a id=logo href=/ardour-tutorial/en/><svg id="Layer_1" width="92" height="80" viewBox="0 0 92 80" enable-background="new 0 0 92 80" xmlns="http://www.w3.org/2000/svg" xmlns:svg="http://www.w3.org/2000/svg"><defs id="defs6"/><path id="path6984" fill="#c61f40" d="M45.586.44-.082 79.558c3.356.0 2.828-2.382 4.417-2.382 1.681.004 1.367 1.19 2.951 1.19.814.0 1.467-.806 1.466-2.804.0-2.664.661-4.017 1.476-4.017s1.476 1.187 1.476 2.372c0 1.492.662 2.678 1.476 2.678.814.0 1.477-2.019 1.477-4.512l-.01-2.857c0-3.447.661-6.24 1.476-6.24s1.477 1.207 1.476 5.112c0 3.104.662 6.198 1.476 6.198s1.478-3.602 1.477-9.382c0-6.68.65-10.996 1.465-10.996s1.477 4.32 1.476 8.582c0 4.977.662 9.878 1.477 9.878s1.477-4.902 1.476-11.701c0-7.302.651-12.609 1.466-12.609.813.0 1.477 5.308 1.476 11.406.0 6.4.661 11.955 1.476 11.955s1.476-5.551 1.476-12.661c0-7.109.651-12.766 1.466-12.766s1.476 5.656 1.476 12.649c0 6.994.662 12.641 1.476 12.641s1.477-5.65 1.477-12.397c0-6.602.65-12.135 1.465-12.135s1.476 5.53 1.476 12.746c0 6.952.663 12.271 1.477 12.271.813.0 1.477-5.318 1.476-11.332.0-5.651.651-10.669 1.465-10.669s1.478 5.027 1.477 11.882c0 6.413.661 11.068 1.476 11.068s1.477-4.657 1.476-9.667c0-4.514.651-8.781 1.466-8.781s1.477 4.265 1.476 10.32c0 5.522.662 9.351 1.476 9.351s1.477-3.825 1.477-7.727c0-3.353.65-6.737 1.465-6.737s1.476 3.382 1.476 8.382c0 4.449.662 7.389 1.477 7.389s1.476-2.586 1.476-5.407c0-2.911.662-5.145 1.476-5.145s1.466 2.501 1.466 6.356c0 3.345.661 5.439 1.476 5.439s1.476-1.732 1.476-3.479c0-1.801.662-3.563 1.477-3.563.813.0 1.465 1.703 1.465 4.459.0 2.317.662 3.668 1.477 3.668s1.477-.941 1.477-2.034c0-1.438.661-2.098 1.476-2.098s1.466.987 1.466 2.814c0 1.44.661 2.192 1.476 2.192 1.539.0 1.331-1.917 2.951-1.929 1.773.0 1.253 2.571 2.941 2.571 1.217.0 2.159-.469 2.952-.474 1.316.0 1.408.928 4.416.928L45.588.44H45.586z" style="fill:#000"/></svg></a></div><div class=searchbox><label for=search-by><i class="fas fa-search"></i></label>
|
|
<input data-search-input id=search-by type=search placeholder=Search...>
|
|
<span data-search-clear><i class="fas fa-times"></i></span></div><script type=text/javascript src=/ardour-tutorial/js/lunr.min.js?1650836361></script>
|
|
<script type=text/javascript src=/ardour-tutorial/js/auto-complete.js?1650836361></script>
|
|
<script type=text/javascript>var baseurl="https://prokoudine.github.io/ardour-tutorial/en"</script><script type=text/javascript src=/ardour-tutorial/js/search.js?1650836361></script></div><section id=homelinks><ul><li><a class=padding href=/ardour-tutorial/en/><i class="fas fa-home"></i> Home</a></li></ul></section><div class=highlightable><ul class=topics><li data-nav-id=/ardour-tutorial/en/introduction/ title=Introduction class=dd-item><a href=/ardour-tutorial/en/introduction/><b>1. </b>Introduction</a><ul><li data-nav-id=/ardour-tutorial/en/introduction/conventions/ title=Conventions class=dd-item><a href=/ardour-tutorial/en/introduction/conventions/>Conventions</a></li><li data-nav-id=/ardour-tutorial/en/introduction/what-is-digital-audio/ title="What is digital audio?" class=dd-item><a href=/ardour-tutorial/en/introduction/what-is-digital-audio/>What is digital audio?</a></li></ul></li><li data-nav-id=/ardour-tutorial/en/getting-started/ title="Getting started" class=dd-item><a href=/ardour-tutorial/en/getting-started/><b>2. </b>Getting started</a><ul><li data-nav-id=/ardour-tutorial/en/getting-started/starting-ardour-on-ubuntu/ title="Starting Ardour" class=dd-item><a href=/ardour-tutorial/en/getting-started/starting-ardour-on-ubuntu/>Starting Ardour</a></li><li data-nav-id=/ardour-tutorial/en/getting-started/overview-of-the-interface/ title="Overview of the Interface" class=dd-item><a href=/ardour-tutorial/en/getting-started/overview-of-the-interface/>Overview of the Interface</a><ul><li data-nav-id=/ardour-tutorial/en/getting-started/overview-of-the-interface/editor-window/ title="Editor window" class=dd-item><a href=/ardour-tutorial/en/getting-started/overview-of-the-interface/editor-window/>Editor window</a></li><li data-nav-id=/ardour-tutorial/en/getting-started/overview-of-the-interface/mixer-window/ title="Mixer window" class=dd-item><a href=/ardour-tutorial/en/getting-started/overview-of-the-interface/mixer-window/>Mixer window</a></li><li data-nav-id=/ardour-tutorial/en/getting-started/overview-of-the-interface/recorder-window/ title="Recorder window" class=dd-item><a href=/ardour-tutorial/en/getting-started/overview-of-the-interface/recorder-window/>Recorder window</a></li><li data-nav-id=/ardour-tutorial/en/getting-started/overview-of-the-interface/cue-window/ title="Cue window" class=dd-item><a href=/ardour-tutorial/en/getting-started/overview-of-the-interface/cue-window/>Cue window</a></li></ul></li><li data-nav-id=/ardour-tutorial/en/getting-started/creating-tracks-and-busses/ title="Creating tracks and busses" class=dd-item><a href=/ardour-tutorial/en/getting-started/creating-tracks-and-busses/>Creating tracks and busses</a></li><li data-nav-id=/ardour-tutorial/en/getting-started/importing-audio/ title="Importing audio" class=dd-item><a href=/ardour-tutorial/en/getting-started/importing-audio/>Importing audio</a></li><li data-nav-id=/ardour-tutorial/en/getting-started/setting-up-the-timeline/ title="Setting up the timeline" class=dd-item><a href=/ardour-tutorial/en/getting-started/setting-up-the-timeline/>Setting up the timeline</a></li></ul></li><li data-nav-id=/ardour-tutorial/en/recording-audio/ title=Recording class=dd-item><a href=/ardour-tutorial/en/recording-audio/><b>3. </b>Recording</a><ul><li data-nav-id=/ardour-tutorial/en/recording-audio/recording-audio/ title="Recording audio" class=dd-item><a href=/ardour-tutorial/en/recording-audio/recording-audio/>Recording audio</a></li><li data-nav-id=/ardour-tutorial/en/recording-audio/understanding-routing/ title="Understanding routing" class=dd-item><a href=/ardour-tutorial/en/recording-audio/understanding-routing/>Understanding routing</a></li><li data-nav-id=/ardour-tutorial/en/recording-audio/routing-between-applications/ title="Routing between applications" class=dd-item><a href=/ardour-tutorial/en/recording-audio/routing-between-applications/>Routing between applications</a></li></ul></li><li data-nav-id=/ardour-tutorial/en/editing-sessions/ title="Editing sessions" class=dd-item><a href=/ardour-tutorial/en/editing-sessions/><b>4. </b>Editing sessions</a><ul><li data-nav-id=/ardour-tutorial/en/editing-sessions/non-destructive-editing/ title="Non-destructive editing" class=dd-item><a href=/ardour-tutorial/en/editing-sessions/non-destructive-editing/>Non-destructive editing</a></li><li data-nav-id=/ardour-tutorial/en/editing-sessions/arranging-tracks/ title="Arranging tracks" class=dd-item><a href=/ardour-tutorial/en/editing-sessions/arranging-tracks/>Arranging tracks</a></li><li data-nav-id=/ardour-tutorial/en/editing-sessions/setting-up-time-signature/ title="Setting up time signature" class=dd-item><a href=/ardour-tutorial/en/editing-sessions/setting-up-time-signature/>Setting up time signature</a></li><li data-nav-id=/ardour-tutorial/en/editing-sessions/using-ranges/ title="Using ranges" class=dd-item><a href=/ardour-tutorial/en/editing-sessions/using-ranges/>Using ranges</a></li><li data-nav-id=/ardour-tutorial/en/editing-sessions/working-with-regions/ title="Working with regions" class=dd-item><a href=/ardour-tutorial/en/editing-sessions/working-with-regions/>Working with regions</a></li><li data-nav-id=/ardour-tutorial/en/editing-sessions/further-region-operations/ title="Further region operations" class=dd-item><a href=/ardour-tutorial/en/editing-sessions/further-region-operations/>Further region operations</a></li><li data-nav-id=/ardour-tutorial/en/editing-sessions/changing-edit-modes/ title="Changing edit modes" class=dd-item><a href=/ardour-tutorial/en/editing-sessions/changing-edit-modes/>Changing edit modes</a></li><li data-nav-id=/ardour-tutorial/en/editing-sessions/creating-looped-sections/ title="Creating looped sections" class=dd-item><a href=/ardour-tutorial/en/editing-sessions/creating-looped-sections/>Creating looped sections</a></li><li data-nav-id=/ardour-tutorial/en/editing-sessions/stretching-shrinking-regions/ title="Stretching & shrinking regions" class=dd-item><a href=/ardour-tutorial/en/editing-sessions/stretching-shrinking-regions/>Stretching & shrinking regions</a></li></ul></li><li data-nav-id=/ardour-tutorial/en/mixing-sessions/ title="Mixing sessions" class=dd-item><a href=/ardour-tutorial/en/mixing-sessions/><b>5. </b>Mixing sessions</a><ul><li data-nav-id=/ardour-tutorial/en/mixing-sessions/the-mixer-strip/ title="The mixer strip" class=dd-item><a href=/ardour-tutorial/en/mixing-sessions/the-mixer-strip/>The mixer strip</a></li><li data-nav-id=/ardour-tutorial/en/mixing-sessions/mixing-levels/ title="Mixing levels" class=dd-item><a href=/ardour-tutorial/en/mixing-sessions/mixing-levels/>Mixing levels</a></li><li data-nav-id=/ardour-tutorial/en/mixing-sessions/panning/ title=Panning class=dd-item><a href=/ardour-tutorial/en/mixing-sessions/panning/>Panning</a></li><li data-nav-id=/ardour-tutorial/en/mixing-sessions/using-plugins/ title="Using plugins" class=dd-item><a href=/ardour-tutorial/en/mixing-sessions/using-plugins/>Using plugins</a></li><li data-nav-id=/ardour-tutorial/en/mixing-sessions/using-sends/ title="Using sends" class=dd-item><a href=/ardour-tutorial/en/mixing-sessions/using-sends/>Using sends</a></li><li data-nav-id=/ardour-tutorial/en/mixing-sessions/dynamics/ title=Dynamics class=dd-item><a href=/ardour-tutorial/en/mixing-sessions/dynamics/>Dynamics</a></li><li data-nav-id=/ardour-tutorial/en/mixing-sessions/equalizing/ title=Equalizing class=dd-item><a href=/ardour-tutorial/en/mixing-sessions/equalizing/>Equalizing</a></li><li data-nav-id=/ardour-tutorial/en/mixing-sessions/using-automation/ title="Using automation" class=dd-item><a href=/ardour-tutorial/en/mixing-sessions/using-automation/>Using automation</a></li></ul></li><li data-nav-id=/ardour-tutorial/en/exporting-sessions/ title="Exporting sessions" class=dd-item><a href=/ardour-tutorial/en/exporting-sessions/><b>6. </b>Exporting sessions</a><ul><li data-nav-id=/ardour-tutorial/en/exporting-sessions/exporting-a-session/ title="Exporting sessions" class=dd-item><a href=/ardour-tutorial/en/exporting-sessions/exporting-a-session/>Exporting sessions</a></li><li data-nav-id=/ardour-tutorial/en/exporting-sessions/exporting-a-region/ title="Exporting regions" class=dd-item><a href=/ardour-tutorial/en/exporting-sessions/exporting-a-region/>Exporting regions</a></li><li data-nav-id=/ardour-tutorial/en/exporting-sessions/exporting-a-range/ title="Exporting ranges" class=dd-item><a href=/ardour-tutorial/en/exporting-sessions/exporting-a-range/>Exporting ranges</a></li></ul></li><li data-nav-id=/ardour-tutorial/en/saving-sessions/ title="Saving sessions" class=dd-item><a href=/ardour-tutorial/en/saving-sessions/><b>7. </b>Saving sessions</a><ul><li data-nav-id=/ardour-tutorial/en/saving-sessions/saving-a-session/ title="Saving a session" class=dd-item><a href=/ardour-tutorial/en/saving-sessions/saving-a-session/>Saving a session</a></li><li data-nav-id=/ardour-tutorial/en/saving-sessions/saving-a-snapshot/ title="Saving a snapshot" class=dd-item><a href=/ardour-tutorial/en/saving-sessions/saving-a-snapshot/>Saving a snapshot</a></li><li data-nav-id=/ardour-tutorial/en/saving-sessions/saving-a-template/ title="Saving a template" class=dd-item><a href=/ardour-tutorial/en/saving-sessions/saving-a-template/>Saving a template</a></li></ul></li><li data-nav-id=/ardour-tutorial/en/appendices/ title=Appendices class="dd-item
|
|
parent"><a href=/ardour-tutorial/en/appendices/><b>8. </b>Appendices</a><ul><li data-nav-id=/ardour-tutorial/en/appendices/further-help/ title="Further help" class=dd-item><a href=/ardour-tutorial/en/appendices/further-help/>Further help</a></li><li data-nav-id=/ardour-tutorial/en/appendices/glossary/ title=Glossary class=dd-item><a href=/ardour-tutorial/en/appendices/glossary/>Glossary</a></li><li data-nav-id=/ardour-tutorial/en/appendices/credits/ title=Credits class=dd-item><a href=/ardour-tutorial/en/appendices/credits/>Credits</a></li><li data-nav-id=/ardour-tutorial/en/appendices/license/ title=License class=dd-item><a href=/ardour-tutorial/en/appendices/license/>License</a></li><li data-nav-id=/ardour-tutorial/en/appendices/how-to-contribute/ title="How to contribute" class="dd-item active"><a href=/ardour-tutorial/en/appendices/how-to-contribute/>How to contribute</a></li></ul></li></ul><section id=shortcuts><h3>More</h3><ul><li><a class=padding href=https://github.com/prokoudine/ardour-tutorial><i class="fab fa-fw fa-github"></i> This tutorial on GitHub</a></li><li><a class=padding href=https://ardour.org/><i class="fas fa-fw fa-home"></i> Ardour's homepage</a></li><li><a class=padding href=https://manual.ardour.org><i class="fas fa-fw fa-bookmark"></i> User manual</a></li><li><a class=padding href=https://discourse.ardour.org/><i class="fas fa-fw fa-users"></i> Forum</a></li><li><a class=padding href=https://prokoudine.github.io/ardour-tutorial/en/appendices/credits/><i class="fas fa-fw fa-bullhorn"></i> Credits</a></li></ul></section><section id=prefooter><hr><ul><li><a class=padding><i class="fas fa-language fa-fw"></i><div class=select-style><select id=select-language onchange="location=this.value"><option id=en value=https://prokoudine.github.io/ardour-tutorial/en/appendices/how-to-contribute/ selected>English</option></select><svg id="Capa_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="255" height="255" viewBox="0 0 255 255" style="enable-background:new 0 0 255 255"><g><g id="arrow-drop-down"><polygon points="0,63.75 127.5,191.25 255,63.75"/></g></g></svg></div></a></li></ul></section><section id=footer><p>Built with <a href=https://github.com/matcornic/hugo-theme-learn><i class="fas fa-heart"></i></a> from <a href=https://getgrav.org>Grav</a> and <a href=https://gohugo.io/>Hugo</a></p></section></div></nav><section id=body><div id=overlay></div><div class="padding highlightable"><div><div id=top-bar><div id=breadcrumbs itemscope itemtype=http://data-vocabulary.org/Breadcrumb><span id=sidebar-toggle-span><a href=# id=sidebar-toggle data-sidebar-toggle><i class="fas fa-bars"></i></a></span>
|
|
<span id=toc-menu><i class="fas fa-list-alt"></i></span>
|
|
<span class=links><a href=/ardour-tutorial/en/>Home</a> > <a href=/ardour-tutorial/en/appendices/>Appendices</a> > How to contribute</span></div><div class=progress><div class=wrapper><nav id=TableOfContents><ul><li><a href=#what-kind-of-contributions-we-accept>What Kind Of Contributions We Accept</a></li><li><a href=#using-markdown-syntax-and-extras>Using Markdown Syntax And Extras</a></li><li><a href=#how-to-submit-changes>How to Submit Changes</a></li><li><a href=#how-to-create-and-submit-a-translation>How To Create And Submit A Translation</a><ul><li><a href=#translating-menu>Translating Menu</a></li><li><a href=#translating-chapters-and-pages>Translating Chapters And Pages</a></li><li><a href=#translating-user-interface-elements-and-screenshots>Translating User Interface Elements and Screenshots</a></li><li><a href=#submitting-translation>Submitting Translation</a></li></ul></li></ul></nav></div></div></div></div><div id=head-tags></div><div id=body-inner><h1>How to contribute</h1><h2 id=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
|
|
are sufficient to get users started with recording, mixing, and exporting with
|
|
Ardour. So we’ll gratefully accept patches that do not change the scope in any
|
|
major way: bug fixes, better explanations, better illustrations etc. We also
|
|
encourage translations of the ardour-tutorial.</p><h2 id=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
|
|
(<a href=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><div class="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><h2 id=how-to-submit-changes>How to Submit Changes</h2><p>The repository with this tutorial is available on GitHub. The general idea is
|
|
that you fork the repository, make changes in a branch, then create a pull
|
|
request. Please <a href=https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request>see
|
|
here</a>
|
|
for a complete guide.</p><h2 id=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><h3 id=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><pre tabindex=0><code>[Languages.en]
|
|
title = "Ardour tutorial"
|
|
weight = 1
|
|
languageName = "English"
|
|
landingPageURL = "/ardour-tutorial/en/"
|
|
#landingPageURL = "/"
|
|
landingPageName = "<i class='fas fa-home'></i> Home"
|
|
</code></pre><p>translates to e.g.:</p><pre tabindex=0><code>[Languages.ru]
|
|
title = "Введение в Ardour"
|
|
weight = 1
|
|
languageName = "Russian"
|
|
landingPageURL = "/ardour-tutorial/ru/"
|
|
#landingPageURL = "/"
|
|
landingPageName = "<i class='fas fa-home'></i> Начало"
|
|
</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
|
|
website</p><pre tabindex=0><code>[[Languages.en.menu.shortcuts]]
|
|
name = "<i class='fas fa-fw fa-home'></i> Ardour's homepage"
|
|
url = "https://ardour.org/"
|
|
weight = 11
|
|
</code></pre><p>becomes</p><pre tabindex=0><code>#[[Languages.ru.menu.shortcuts]]
|
|
#name = "<i class='fas fa-fw fa-home'></i> Сайт Ardour"
|
|
#url = "https://ardour.org/"
|
|
#weight = 11
|
|
</code></pre><p>Please keep all translations of the menu in a single larger block.</p><h3 id=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><pre tabindex=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><h3 id=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><pre tabindex=0><code>src="en/ardour7-save-template.png"
|
|
</code></pre><p>becomes</p><pre tabindex=0><code>src="de/ardour7-schablone-speichern.png"
|
|
</code></pre><h3 id=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><footer class=footline></footer></div></div><div id=navigation></div></section><div style=left:-1000px;overflow:scroll;position:absolute;top:-1000px;border:none;box-sizing:content-box;height:200px;margin:0;padding:0;width:200px><div style=border:none;box-sizing:content-box;height:200px;margin:0;padding:0;width:200px></div></div><script src=/ardour-tutorial/js/clipboard.min.js?1650836361></script>
|
|
<script src=/ardour-tutorial/js/perfect-scrollbar.min.js?1650836361></script>
|
|
<script src=/ardour-tutorial/js/perfect-scrollbar.jquery.min.js?1650836361></script>
|
|
<script src=/ardour-tutorial/js/jquery.sticky.js?1650836361></script>
|
|
<script src=/ardour-tutorial/js/featherlight.min.js?1650836361></script>
|
|
<script src=/ardour-tutorial/js/highlight.pack.js?1650836361></script>
|
|
<script>hljs.initHighlightingOnLoad()</script><script src=/ardour-tutorial/js/modernizr.custom-3.6.0.js?1650836361></script>
|
|
<script src=/ardour-tutorial/js/learn.js?1650836361></script>
|
|
<script src=/ardour-tutorial/js/hugo-learn.js?1650836361></script>
|
|
<script src=/ardour-tutorial/mermaid/mermaid.js?1650836361></script>
|
|
<script>mermaid.initialize({startOnLoad:!0})</script></body></html> |