[easytag] Start writing Mallard help, add basics



commit 9c649064e0bd66445d635e855261f6282d2b2d37
Author: Ekaterina Gerasimova <kittykat3756 gmail com>
Date:   Mon Mar 4 21:56:56 2013 +0000

    Start writing Mallard help, add basics
    
    Add index, introduction, rename-file and starting pages. Add icon to
    figures.

 help/C/figures/icon.png  |  Bin 0 -> 1915 bytes
 help/C/index.page        |   38 +++++++++++++++++++++++++++
 help/C/introduction.page |   26 ++++++++++++++++++
 help/C/rename-file.page  |   64 ++++++++++++++++++++++++++++++++++++++++++++++
 help/C/starting.page     |   40 ++++++++++++++++++++++++++++
 5 files changed, 168 insertions(+), 0 deletions(-)
---
diff --git a/help/C/figures/icon.png b/help/C/figures/icon.png
new file mode 100644
index 0000000..7bcd4d8
Binary files /dev/null and b/help/C/figures/icon.png differ
diff --git a/help/C/index.page b/help/C/index.page
new file mode 100644
index 0000000..b3158e7
--- /dev/null
+++ b/help/C/index.page
@@ -0,0 +1,38 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      xmlns:e="http://projectmallard.org/experimental/";
+      type="guide" style="task"
+      id="index">
+  <info>
+    <revision version="0.1" pkgversion="2.1.9" date="2013-02-20" status="review"/>
+
+    <credit type="author">
+      <name>Ekaterina Gerasimova</name>
+      <email>kittykat3756 gmail com</email>
+    </credit>
+
+    <license>
+      <p>Creative Commons Attribution-ShareAlike 3.0</p>
+    </license>
+
+    <desc></desc>
+
+  </info>
+
+  <title>
+    <media type="image" mime="image/png" src="figures/icon.png"/>
+    EasyTAG
+  </title>
+
+  <section id="main" style="2column">
+    <title>Features</title>
+  </section>
+
+  <section id="preferences" style="2column">
+    <title>Preferences</title>
+  </section>
+
+  <section id="problems">
+    <title>Common problems and questions</title>
+  </section>
+
+</page>
diff --git a/help/C/introduction.page b/help/C/introduction.page
new file mode 100644
index 0000000..b7f7f87
--- /dev/null
+++ b/help/C/introduction.page
@@ -0,0 +1,26 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="guide"
+      id="introduction">
+
+  <info>
+    <link type="guide" xref="index" group="#first"/>
+    <revision version="0.1" pkgversion="2.1.9" date="2013-02-20" status="draft" />
+
+    <credit type="author">
+      <name>Ekaterina Gerasimova</name>
+      <email>kittykat3756 gmail com</email>
+    </credit>
+
+    <license>
+      <p>Creative Commons Attribution-ShareAlike 3.0</p>
+    </license>
+
+    <desc></desc>
+  </info>
+
+  <title>Introduction</title>
+
+  <p><app>EasyTAG</app> is a comprehensive tag editor for FLAC, Monkey's Audio,
+  MP2, MP3, MP4/AAC, MusePack, Ogg Vorbis, Speex and WavPack audio files.</p>
+
+</page>
diff --git a/help/C/rename-file.page b/help/C/rename-file.page
new file mode 100644
index 0000000..34fd18f
--- /dev/null
+++ b/help/C/rename-file.page
@@ -0,0 +1,64 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="guide"
+      id="rename-file">
+
+  <info>
+    <link type="guide" xref="index#main"/>
+    <revision version="0.1" pkgversion="2.1.9" date="2013-02-20" status="draft" />
+
+    <credit type="author">
+      <name>Ekaterina Gerasimova</name>
+      <email>kittykat3756 gmail com</email>
+    </credit>
+
+    <license>
+      <p>Creative Commons Attribution-ShareAlike 3.0</p>
+    </license>
+
+    <desc>Change the file names</desc>
+  </info>
+
+  <title>Rename files</title>
+
+  <p>Rename your music files:</p>
+
+  <steps>
+    <item>
+      <p>Select the files that you wish to rename in the file view. To select
+      multiple files, you can either hold down <key>Ctrl</key> while you click
+      on the files that you wish to select or you can select a file then hold
+      down <key>Shift</key> and click another file to select all the files
+      between the two, including the first and last file.</p>
+    </item>
+    <item>
+      <p>Select <guiseq><gui style="menu">Scanner</gui>
+      <gui style="menuitem">Rename Files and Directories…</gui></guiseq>.</p>
+    </item>
+    <item>
+      <p>Using the <gui>Legend</gui>, type in the structure<!--find better
+      word--> that you would like to use for the file naming. For example, if
+      you wish your files to be named
+      <file>[artist] - [title].[extention]</file>, enter <gui>%a - %t</gui> into
+      the renaming field.</p>
+    </item>
+    <item>
+      <p>To apply the changes to all files, select
+      <guiseq><gui style="menu">File</gui>
+      <gui style="menuitem">Scan Files…</gui></guiseq>.</p>
+    </item>
+    <item>
+      <p>Close the <gui style="dialog">Tag and File Name scan</gui> dialog.</p>
+    </item>
+    <item>
+      <p>To save the applied changes, select
+      <guiseq><gui style="menu">File</gui>
+      <gui style="menuitem">Save Files</gui></guiseq>.</p>
+    </item>
+  </steps>
+
+  <note style="tip">
+    <p>If you close the application without saving, your changes will be
+    lost.</p>
+  </note>
+
+</page>
diff --git a/help/C/starting.page b/help/C/starting.page
new file mode 100644
index 0000000..ef4a4e5
--- /dev/null
+++ b/help/C/starting.page
@@ -0,0 +1,40 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="guide"
+      id="starting">
+
+  <info>
+    <link type="guide" xref="index"/>
+    <revision version="0.1" pkgversion="2.1.9" date="2013-02-20" status="draft" />
+
+    <credit type="author">
+      <name>Ekaterina Gerasimova</name>
+      <email>kittykat3756 gmail com</email>
+    </credit>
+
+    <license>
+      <p>Creative Commons Attribution-ShareAlike 3.0</p>
+    </license>
+
+    <desc>Using <app>EasyTAG</app> for the first time.</desc>
+  </info>
+
+  <title>Starting</title>
+
+  <p>When you start <app>EasyTAG</app> for the first time, it will search your
+  <file>Music</file> directory or your home directory for music files. If you
+  wish to skip the search, press the <gui style="button">STOP the
+  search…</gui>.</p>
+
+  <p>Once the search is complete, <app>EasyTAG</app> may apply some automatic
+  corrections to some of your music files which will be displayed in red or
+  bold. These are normally updates to the tag metadata containers and will not
+  be applied until you save the changes.</p>
+
+  <p>To save these changes, select all the files that have been affected and
+  press <keyseq><key>Ctrl</key><key>S</key></keyseq>. It is not possible to
+  undo the automatic changes but they will not be saved unless you select the
+  file and save it. You can disable some of the automatic updates in the
+  <gui style="tab">ID3 Tag Settings</gui> tab in the
+  <gui style="dialog">Preferences</gui> dialog.</p>
+
+</page>


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]