[totem/mallard-documentation] Removed old help and began re-writing it in Mallard.
- From: Marta Bogdanowicz <martab src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [totem/mallard-documentation] Removed old help and began re-writing it in Mallard.
- Date: Mon, 27 Feb 2012 19:24:32 +0000 (UTC)
commit ceae67f8fd73dcd0779160e194a74e1a5f0d4dbf
Author: Marta Bogdanowicz <majus85 gmail com>
Date: Mon Feb 27 19:49:51 2012 +0100
Removed old help and began re-writing it in Mallard.
help/C/adjustment-sound.page | 51 ++
help/C/figures/totem-main-window.png | Bin 0 -> 46802 bytes
help/C/figures/totem_next_button.png | Bin 671 -> 0 bytes
help/C/figures/totem_pause_button.png | Bin 1058 -> 0 bytes
help/C/figures/totem_play_button.png | Bin 928 -> 0 bytes
help/C/figures/totem_previous_button.png | Bin 653 -> 0 bytes
help/C/figures/totem_show_playlist_button.png | Bin 906 -> 0 bytes
help/C/figures/totem_start_window.png | Bin 35767 -> 0 bytes
help/C/figures/totem_volume_maximum_button.png | Bin 512 -> 0 bytes
help/C/figures/totem_volume_mute_button.png | Bin 341 -> 0 bytes
help/C/file-open.page | 64 ++
help/C/file-save.page | 40 +
help/C/index.page | 27 +
help/C/introduction.page | 37 +
help/C/keyboard-shortcuts.page | 138 +++
help/C/legal.xml | 76 --
help/C/navigation.page | 70 ++
help/C/playlist.page | 75 ++
help/C/preferences.page | 121 +++
help/C/properties.page | 43 +
help/C/screenshot-gallery.page | 58 ++
help/C/screenshot.page | 47 +
help/C/sidebar.page | 137 +++
help/C/subtitles.page | 45 +
help/C/totem.xml | 1112 ------------------------
help/Makefile.am | 35 +-
26 files changed, 975 insertions(+), 1201 deletions(-)
---
diff --git a/help/C/adjustment-sound.page b/help/C/adjustment-sound.page
new file mode 100644
index 0000000..16db19d
--- /dev/null
+++ b/help/C/adjustment-sound.page
@@ -0,0 +1,51 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide"
+ id="adjustment-sound">
+
+ <info>
+ <link type="guide" xref="index#playing-media"/>
+ <desc>Adjust the volume of a movie or music or select a language.</desc>
+ <credit type="author">
+ <name>Marta Bogdanowicz</name>
+ <email>majus85 gmail com</email>
+ </credit>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>Sound adjustment</title>
+
+ <p>
+ Adjust the volume of played media to your needs. Do it in one of the following
+ ways:
+ </p>
+
+ <list>
+ <item>
+ <p>Click <guiseq><gui style="menu">Sound</gui>
+ <gui style="menuitem">Volume Up</gui></guiseq> or use keyboard shortcut
+ <key>Up</key> to make the sound louder.</p>
+ </item>
+ <item>
+ <p>Click <guiseq><gui style="menu">Sound</gui>
+ <gui style="menuitem">Volume Down</gui></guiseq> or use keyboard shortcut
+ <key>Down</key> to make the sound more quiet.</p>
+ </item>
+ <item>
+ <p>Use the <gui>Volume button</gui> to adjust volume. It is located below
+ the display area. Click on it and then drag along the slider.</p>
+ </item>
+ </list>
+
+<!-- <p>-->
+<!-- Click <guiseq><gui style="menu">Sound</gui>-->
+<!-- <gui style="menuitem">Languages</gui></guiseq> and select the language.-->
+<!-- </p>-->
+
+ <note style="tip">
+ <p>You may choose audio output. For further information see
+ <guiseq><gui>Audio</gui><gui>Audio Output</gui></guiseq> on
+ <link xref="preferences"/> page.</p>
+ </note>
+</page>
diff --git a/help/C/figures/totem-main-window.png b/help/C/figures/totem-main-window.png
new file mode 100644
index 0000000..03bbc00
Binary files /dev/null and b/help/C/figures/totem-main-window.png differ
diff --git a/help/C/file-open.page b/help/C/file-open.page
new file mode 100644
index 0000000..166260f
--- /dev/null
+++ b/help/C/file-open.page
@@ -0,0 +1,64 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide"
+ id="file-open">
+
+ <info>
+ <link type="guide" xref="index#playing-media"/>
+ <desc>Start watching a movie or listetning to the music.</desc>
+ <credit type="author">
+ <name>Marta Bogdanowicz</name>
+ <email>majus85 gmail com</email>
+ </credit>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>Open a file</title>
+
+ <p>
+ Open video or audio file in <app>Totem Movie Player</app>, in one of the
+ following ways:</p>
+
+ <list>
+ <item>
+ <p>Click <guiseq><gui style="menu">Movie</gui>
+ <gui style="menuitem">Openâ</gui></guiseq> or use keyboard shortcut
+ <keyseq><key>Ctrl</key><key>O</key></keyseq>.The file chooser will open.
+ Use it to search for the wanted media and click <gui>Add</gui>.</p>
+ <note style="tip">
+ <p>Speed up searching by choosing the file type, you want to find. At
+ the bottom of file chooser <app>Totem</app> offers you such options
+ as:</p>
+ <list>
+ <item><p>All files</p></item>
+ <item><p>Supported files</p></item>
+ <item><p>Audio files</p></item>
+ <item><p>Video files</p></item>
+ </list>
+ </note>
+ </item>
+ <item>
+ <p>Click <guiseq><gui style="menu">Movie</gui>
+ <gui style="menuitem">Open Locationâ</gui></guiseq> or use keyboard
+ shortcut <keyseq><key>Ctrl</key><key>L</key></keyseq>. A dialog will open.
+ Type the address of the file you would like to open and then click
+ <gui>Open</gui>.</p>
+ </item>
+ <item>
+ <p>Click <guiseq><gui style="menu">Movie</gui>
+ <gui style="menuitem">Play Disc</gui></guiseq> to start watching movie or
+ listetning to the music from CD or DVD.</p>
+ <note>
+ <p>Option <gui style="menuitem">Play Disc</gui> will show up only
+ then, when you put CD or DVD to your disc drive.</p>
+ </note>
+ </item>
+ <item>
+ <p><app>Totem</app> allows you to search through the recently used files.
+ See the numbered list of them by clicking <gui style="menu">Movie</gui>.
+ </p>
+ </item>
+ </list>
+
+</page>
diff --git a/help/C/file-save.page b/help/C/file-save.page
new file mode 100644
index 0000000..dfcd2fa
--- /dev/null
+++ b/help/C/file-save.page
@@ -0,0 +1,40 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide"
+ id="file-save">
+
+ <info>
+ <link type="guide" xref="index#playing-media"/>
+ <desc>Save a copy of audio or video file.</desc>
+ <credit type="author">
+ <name>Marta Bogdanowicz</name>
+ <email>majus85 gmail com</email>
+ </credit>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>Save a copy of a file</title>
+
+ <p>
+ <app>Totem</app> allows you to save a copy of the used file. Do this in the
+ following way:
+ </p>
+
+ <steps>
+ <item>
+ <p>Click <guiseq><gui style="menu">Movie</gui>
+ <gui style="menuitem">Save a Copyâ</gui></guiseq> or use keyboard shortcut
+ <keyseq><key>Ctrl</key><key>E</key></keyseq>.</p>
+ </item>
+ <item>
+ <p>The file chooser will open. Type the name of a file and choose a
+ destination folder.</p>
+ </item>
+ <item>
+ <p>Confirm your choice by clicking <gui>Save</gui>.</p>
+ </item>
+
+ </steps>
+
+</page>
diff --git a/help/C/index.page b/help/C/index.page
new file mode 100644
index 0000000..35444aa
--- /dev/null
+++ b/help/C/index.page
@@ -0,0 +1,27 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide"
+ id="index">
+
+ <title>Totem Movie Player Help</title>
+
+ <section id="playing-media" style="2column">
+ <title>Playing media</title>
+ </section>
+
+ <section id="application-adjustment" style="2column">
+ <title>Application adjustment</title>
+ </section>
+
+ <section id="advanced-options" style="2column">
+ <title>Advanced options</title>
+ </section>
+
+ <section id="extra-features" style="2column">
+ <title>Extra features</title>
+ </section>
+
+ <section id="troubleshooting" style="2column">
+ <title>Troubleshooting</title>
+ </section>
+
+</page>
diff --git a/help/C/introduction.page b/help/C/introduction.page
new file mode 100644
index 0000000..ce64ecc
--- /dev/null
+++ b/help/C/introduction.page
@@ -0,0 +1,37 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide"
+ id="introduction">
+
+ <info>
+ <link type="guide" xref="index"/>
+ <desc>Welcome to the <app>Totem Movie Player</app>, GNOME application for
+ playing music and movies.</desc>
+ <credit type="author">
+ <name>Marta Bogdanowicz</name>
+ <email>majus85 gmail com</email>
+ </credit>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>Introduction</title>
+
+ <p><app>Totem Movie Player</app> is an application for palying media, video as
+ well as audio. With it you can watch movies, listen to the music or create
+ your personal playlists.</p>
+
+ <note style="advanced">
+ <p><app>Totem</app> is based on <gui>GStreamer</gui>. This is a plugin-based
+ multimedia framework. Thanks to <gui>GStreamer</gui> <app>Totem</app> has
+ superior extensibility and supports a larger variety of media formats.</p>
+ </note>
+
+ <figure>
+ <title><gui>Totem Movie Player</gui> main window</title>
+ <media type="image" mime="image/png" src="figures/totem-main-window.png">
+ <p>Screenshot of the <app>Totem Movie Player</app> main window.</p>
+ </media>
+ </figure>
+
+</page>
diff --git a/help/C/keyboard-shortcuts.page b/help/C/keyboard-shortcuts.page
new file mode 100644
index 0000000..5e2fb10
--- /dev/null
+++ b/help/C/keyboard-shortcuts.page
@@ -0,0 +1,138 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide"
+ id="keyboard-shortcuts">
+
+<info>
+ <link type="guide" xref="index#advanced-options"/>
+ <desc>The list of keyboard shortcuts.</desc>
+ <credit type="author">
+ <name>Marta Bogdanowicz</name>
+ <email>majus85 gmail com</email>
+ </credit>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+</info>
+
+ <title>Keyboard shortcuts</title>
+
+ <p>Use keyboard shortcuts to speed up navigation. In the tables below, there
+ are lists of shortcuts which can be used in <app>Totem</app>.</p>
+
+<section id="basic">
+ <title>Main functions</title>
+ <table frame="all" shade="rows">
+ <tr>
+ <td><p>Openâ</p></td>
+ <td><p><keyseq><key>Ctrl</key><key>O</key></keyseq></p></td>
+ </tr>
+ <tr>
+ <td><p>Open Location</p></td>
+ <td><p><keyseq><key>Ctrl</key><key>L</key></keyseq></p></td>
+ </tr>
+ <tr>
+ <td><p>Save a Copy</p></td>
+ <td><p><keyseq><key>Ctrl</key><key>E</key></keyseq></p></td>
+ </tr>
+ <tr>
+ <td><p>Eject</p></td>
+ <td><p><keyseq><key>Ctrl</key><key>E</key></keyseq></p></td>
+ </tr>
+ <tr>
+ <td><p>Quit</p></td>
+ <td><p><keyseq><key>Ctrl</key><key>Q</key></keyseq></p></td>
+ </tr>
+ </table>
+</section>
+
+<section id="play">
+ <title>Playing media</title>
+ <table frame="all" shade="rows">
+ <tr>
+ <td><p>Chapter Menu</p></td>
+ <td><p><keyseq><key>Ctrl</key><key>C</key></keyseq></p></td>
+ </tr>
+ <tr>
+ <td><p>DVD Menu</p></td>
+ <td><p><keyseq><key>Ctrl</key><key>M</key></keyseq></p></td>
+ </tr>
+ <tr>
+ <td><p>Fullscreen</p></td>
+ <td><p><key>F11</key></p></td>
+ </tr>
+ <tr>
+ <td><p>Next Chapter/Movie</p></td>
+ <td><p><keyseq><key>Alt</key><key>Right</key></keyseq></p></td>
+ </tr>
+ <tr>
+ <td><p>Prevoius Chapter/Movie</p></td>
+ <td><p><keyseq><key>Alt</key><key>Left</key></keyseq></p></td>
+ </tr>
+ <tr>
+ <td><p>Play/Pause</p></td>
+ <td><p><keyseq><key>Ctrl</key><key>Space</key></keyseq></p></td>
+ </tr>
+ <tr>
+ <td><p>Skip To</p></td>
+ <td><p><keyseq><key>Ctrl</key><key>K</key></keyseq></p></td>
+ </tr>
+ <tr>
+ <td><p>Skip Forward</p></td>
+ <td><p><key>Right</key></p></td>
+ </tr>
+ <tr>
+ <td><p>Skip Backwards</p></td>
+ <td><p><key>Left</key></p></td>
+ </tr>
+ <tr>
+ <td><p>Zoom In</p></td>
+ <td><p><keyseq><key>Ctrl</key><key>Z</key></keyseq></p></td>
+ </tr>
+ </table>
+</section>
+
+<section id="audio">
+ <title>Sound adjustment</title>
+ <table frame="all" shade="rows">
+ <tr>
+ <td><p>Volume Up</p></td>
+ <td><p><key>Up</key></p></td>
+ </tr>
+ <tr>
+ <td><p>Volume Down</p></td>
+ <td><p><key>Down</key></p></td>
+ </tr>
+ </table>
+</section>
+
+<section id="other">
+ <title>Other options</title>
+ <table frame="all" shade="rows">
+ <tr>
+ <td><p>Help</p></td>
+ <td><p><key>F1</key></p></td>
+ </tr>
+ <tr>
+ <td><p>Properties</p></td>
+ <td><p><keyseq><key>Ctrl</key><key>P</key></keyseq></p></td>
+ </tr>
+ <tr>
+ <td><p>Show Controls</p></td>
+ <td><p><keyseq><key>Ctrl</key><key>H</key></keyseq></p></td>
+ </tr>
+ <tr>
+ <td><p>Sidebar</p></td>
+ <td><p><key>F9</key></p></td>
+ </tr>
+ <tr>
+ <td><p>Switch Angels</p></td>
+ <td><p><keyseq><key>Ctrl</key><key>G</key></keyseq></p></td>
+ </tr>
+ <tr>
+ <td><p>Take Screenshot</p></td>
+ <td><p><keyseq><key>Ctrl</key><key>S</key></keyseq></p></td>
+ </tr>
+ </table>
+</section>
+
+</page>
diff --git a/help/C/navigation.page b/help/C/navigation.page
new file mode 100644
index 0000000..baa090c
--- /dev/null
+++ b/help/C/navigation.page
@@ -0,0 +1,70 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide"
+ id="navigation">
+
+ <info>
+ <link type="guide" xref="index#playing-media"/>
+ <link type="seealso" xref="keyboard-shortcuts"/>
+ <link type="seealso" xref="adjustment-volume"/>
+ <link type="seealso" xref="sidebar"/>
+ <desc>Navigate <app>Totem</app> while playing media.</desc>
+ <credit type="author">
+ <name>Marta Bogdanowicz</name>
+ <email>majus85 gmail com</email>
+ </credit>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>Navigation</title>
+
+ <p>
+ You may navigate <app>Totem</app> via control buttons, menu items or
+ <link xref="keyboard-shortcuts"/>.
+ </p>
+
+ <p>View control buttons by clicking <keyseq><key>Ctrl</key>
+ <key>H</key></keyseq>. They will appear under the display area, below the
+ time slider. Click them to:</p>
+
+ <list>
+ <item>
+ <p>Play previous chapter or movie. Do the same by clicking
+ <guiseq><gui style="menu">Go</gui>
+ <gui style="menuitem">Previous Chapter/Movie</gui></guiseq> or
+ <keyseq><key>Alt</key><key>Left</key></keyseq>.</p>
+ </item>
+ <item>
+ <p>Play media, or pause them. You may also use keyboard shortcut
+ <keyseq><key>Ctrl</key><key>Space</key></keyseq> or click
+ <guiseq><gui style="menu">Movie</gui>
+ <gui style="menuitem">Play/Pause</gui></guiseq>.</p>
+ </item>
+ <item>
+ <p>Play next chapter or movie. The same result you will achieve by
+ clicking <guiseq><gui style="menu">Movie</gui>
+ <gui style="menuitem">Play/Pause</gui></guiseq> or <keyseq><key>Alt</key>
+ <key>Right</key></keyseq>.</p>
+ </item>
+ <item>
+ <p>View the fullscreen. Do the same by clicking <key>F11</key> or
+ <guiseq><gui style="menu">View</gui>
+ <gui sytle="menuitem">Fullscreen</gui></guiseq>.</p>
+ <note style="tip">
+ <p>Leave the <gui>Fullscreen</gui> mode by clicking <key>F11</key>.
+ You may also move cursor while watching movie and the icon
+ <gui>Leave Fullscreen</gui> will appear - click it.</p>
+ </note>
+ </item>
+ <item>
+ <p>Adjust volume. For further information see
+ <link xref="adjustment-sound"/> page.</p>
+ </item>
+ <item>
+ <p>View the sidebar. Get to know more about it from
+ <link xref="sidebar"/> page.</p>
+ </item>
+ </list>
+
+</page>
diff --git a/help/C/playlist.page b/help/C/playlist.page
new file mode 100644
index 0000000..6ec9e80
--- /dev/null
+++ b/help/C/playlist.page
@@ -0,0 +1,75 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide"
+ id="playlist">
+
+ <info>
+ <link type="guide" xref="index#advanced-options"/>
+ <link type="seealso" xref="sidebar.page"/>
+ <desc>Create and manage a playlist.</desc>
+ <credit type="author">
+ <name>Marta Bogdanowicz</name>
+ <email>majus85 gmail com</email>
+ </credit>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>Playlist</title>
+
+ <p>
+ Create your own playlist with <app>Totem</app> in the following way:
+ </p>
+
+ <steps>
+ <item>
+ <p>View <gui>Sidebar</gui> by following the instructions on
+ <link xref="sidebar"/> page.</p>
+ </item>
+ <item>
+ <p>When <gui>Sidebar</gui> is viewed, click
+ <guiseq><gui style="menu">View</gui>
+ <gui style="menuitem">Playlist</gui></guiseq>.</p>
+ </item>
+ <item>
+ <p>On the bottom of the <gui>Playlist</gui> there are control buttons.
+ Click <gui>Addâ</gui> button to add movie or song to your playlist.</p>
+ </item>
+ <item>
+ <p>Remove media files from your playlist by clicking on the
+ <gui>Remove</gui> button.</p>
+ </item>
+ <note style="tip">
+ <p>Change the order of the media files on your playlist. Highlight the
+ song or movie and click <gui>Move Up</gui> or <gui>Move Down</gui>.</p>
+ </note>
+ </steps>
+
+ <p>
+ <app>Totem</app> allows you to save the playlist. Do it in the following
+ way:
+ </p>
+
+ <steps>
+ <item>
+ <p>Click <gui>Save Playlistâ</gui> button.</p>
+ </item>
+ <item>
+ <p>A dialog will open. Name your playlist and choose a folder, in which it
+ should be saved.</p>
+ </item>
+ <item>
+ <p>Click <gui>Save</gui>.</p>
+ </item>
+ <note>
+ <p>Your playlist will be written in the <file>.pls</file> format.</p>
+ </note>
+ </steps>
+
+ <note style="tip">
+ <p>While using <app>Totem</app> you may want to clear playlist. Do it by
+ clicking <guiseq><gui style="menu">Edit</gui>
+ <gui style="menuitem">Clear Playlist</gui></guiseq>.</p>
+ </note>
+
+</page>
diff --git a/help/C/preferences.page b/help/C/preferences.page
new file mode 100644
index 0000000..3e5fa55
--- /dev/null
+++ b/help/C/preferences.page
@@ -0,0 +1,121 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide"
+ id="preferences">
+
+ <info>
+ <link type="guide" xref="index#application-adjustment"/>
+ <link type="seealso" xref="subtitles"/>
+ <desc>Configure the application.</desc>
+ <credit type="author">
+ <name>Marta Bogdanowicz</name>
+ <email>majus85 gmail com</email>
+ </credit>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>Preferences</title>
+
+ <p>
+ <app>Totem</app> offers you some additional options. Configure the
+ application according to your preferences. View <gui>Preferences</gui>
+ window by clicking <guiseq><gui style="menu">Edit</gui>
+ <gui style="menuitem">Preferences</gui></guiseq>.
+ </p>
+ <note>
+ <p>When you finish adjusting application click <gui>Close</gui> to leave
+ <gui>Preferences</gui> window.</p>
+ </note>
+
+
+ <section>
+ <title>General</title>
+ <terms>
+ <item>
+ <title><code>Playback</code></title>
+ <p>Tick option <gui>Start playing files from the last position</gui>.
+ <app>Totem</app> will remember when you stopped playing, and will
+ start from this moment, when you run the application again.</p>
+ </item>
+ <item>
+ <title><code>Networking</code></title>
+ <p>Choose the connection speed from the drop-down list.</p>
+ </item>
+ <item>
+ <title><code>Text Subtitles</code></title>
+ <list>
+ <item>
+ <p>Tick the option
+ <gui>Load subtitle file when movie is loaded</gui>, if you want
+ subtitles to be loaded automatically.</p>
+ </item>
+ <item>
+ <p>Adjust font type and size, by clickng its name. Choose font
+ type from the drop-down list. Click on the slider and change the
+ font size. When ready click <gui>Select</gui>. </p>
+ </item>
+ <item>
+ <p>Choose the encoding from the drop-down list.</p>
+ </item>
+ </list>
+ </item>
+ <item>
+ <title><code>External Chapters</code></title>
+ <p><app>Totem</app> allows you to load chapter files, when movie is
+ loaded. Do it by ticking this option.</p>
+ </item>
+ </terms>
+ </section>
+
+ <section>
+ <title>Display</title>
+ <terms>
+ <item>
+ <title><code>Display</code></title>
+ <p><app>Totem</app> allows you to specify, wheather you want to:</p>
+ <list>
+ <item><p><gui>Resize the window when a new video is loaded
+ </gui></p></item>
+ <item><p><gui>Disable deinterlacing of interlaced videos
+ </gui></p></item>
+ <item><p><gui>Disable screensaver when playing</gui>
+ <gui>Video</gui> or <gui>Video or Audio</gui></p></item>
+ </list>
+ <p>Tick the desired option.</p>
+ </item>
+ <item>
+ <title><code>Visual Effects</code></title>
+ <p>Choose if <app>Totem</app> should show visual effects while playing
+ audio files or not. Tick this option if you want to see visualization.
+ </p>
+ <note>
+ <p>You may also select the type of visualization or its size.
+ Choose them from the drop-down lists.</p>
+ </note>
+ </item>
+ <item>
+ <title><code>Color Balance</code></title>
+ <p>This option allows you to adjust <gui>Brightness</gui>,
+ <gui>Contrast</gui>, <gui>Saturation</gui> or <gui>Hue</gui> of the
+ viewed video. Do it by clicking and dragging along sliders.</p>
+ <note style="tip">
+ <p>You may go back to previous settings, by clicking
+ <gui>Reset to Deafult</gui> button.</p>
+ </note>
+ </item>
+ </terms>
+ </section>
+
+ <section>
+ <title>Audio</title>
+ <terms>
+ <item>
+ <title><code>Audio Output</code></title>
+ <p>Choose the type of <gui>Audio Output</gui> from the drop-down list.
+ </p>
+ </item>
+ </terms>
+ </section>
+
+</page>
diff --git a/help/C/properties.page b/help/C/properties.page
new file mode 100644
index 0000000..02e0183
--- /dev/null
+++ b/help/C/properties.page
@@ -0,0 +1,43 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide"
+ id="properties">
+
+ <info>
+ <link type="guide" xref="index#advanced-options"/>
+ <link type="seealso" xref="sidebar"/>
+ <desc>View properties of a played audio or video file.</desc>
+ <credit type="author">
+ <name>Marta Bogdanowicz</name>
+ <email>majus85 gmail com</email>
+ </credit>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>Properties</title>
+
+ <p>
+ View properties of a played media by clicking
+ <guiseq><gui style="menu">Movie</gui><gui>Properties</gui></guiseq> or
+ <keyseq><key>Ctrl</key><key>P</key></keyseq>. They will appear on the
+ <gui>Sidebar</gui> in three sections:
+ </p>
+
+ <terms>
+ <item>
+ <title><code>General</code></title>
+ <p>You may find here information about: title, artist, album, year,
+ duration, comment and container.</p>
+ </item>
+ <item>
+ <title><code>Video</code></title>
+ <p>Information about: dimensions, codec, framerate, bitrate.</p>
+ </item>
+ <item>
+ <title><code>Audio</code></title>
+ <p>You may get to know about: codec, channels, sample rate, bitrate.</p>
+ </item>
+ </terms>
+
+</page>
diff --git a/help/C/screenshot-gallery.page b/help/C/screenshot-gallery.page
new file mode 100644
index 0000000..2c73a36
--- /dev/null
+++ b/help/C/screenshot-gallery.page
@@ -0,0 +1,58 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide"
+ id="screenshot-gallery">
+
+ <info>
+ <link type="guide" xref="index#advanced-options"/>
+ <desc>Create gallery with the screenshots from a movie.</desc>
+ <credit type="author">
+ <name>Marta Bogdanowicz</name>
+ <email>majus85 gmail com</email>
+ </credit>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>Screenshot gallery</title>
+
+ <p>
+ Create screenshot gallery in the following way:
+ </p>
+
+ <steps>
+ <item>
+ <p>Click <guiseq><gui style="menu">Edit</gui>
+ <gui>Create Screenshot Galleryâ</gui></guiseq>.</p>
+ </item>
+ <item>
+ <p>A file chooser will open.</p>
+ </item>
+ <item>
+ <p>Type the name of your gallery.</p>
+ </item>
+ <item>
+ <p>Choose a folder, where the gallery should be saved.</p>
+ </item>
+ <item>
+ <p>Click <gui>Save</gui> when ready.</p>
+ </item>
+ <item>
+ <p>The progress bar will pop up. While loading you may resign from
+ creating gallery by clicking <gui>Cancel</gui>.</p>
+ </item>
+ <item>
+ <p><app>Totem</app> creates a gallery from the random screenshots. The
+ gallery will be saved in the folder you chose, as a <file>.jpg</file>
+ file.</p>
+ </item>
+ </steps>
+
+ <note style="advanced">
+ <p>On the bottom of the file chooser you may specify the width of
+ screenshots in pixels. You may also set the number of screenshots, which
+ the gallery will consist of or tick option <gui>Calculate the number of
+ screenshots</gui> and <app>Totem</app> will set it automatically.</p>
+ </note>
+
+</page>
diff --git a/help/C/screenshot.page b/help/C/screenshot.page
new file mode 100644
index 0000000..541f69f
--- /dev/null
+++ b/help/C/screenshot.page
@@ -0,0 +1,47 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide"
+ id="screenshot">
+
+ <info>
+ <link type="guide" xref="index#advanced-options"/>
+ <desc>Take screenshots from the movie.</desc>
+ <credit type="author">
+ <name>Marta Bogdanowicz</name>
+ <email>majus85 gmail com</email>
+ </credit>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>Screenshots</title>
+
+ <p>
+ Take screenshot while watching movie. Follow these steps:
+ </p>
+
+ <steps>
+ <item>
+ <p>Click <guiseq><gui style="menu">Edit</gui>
+ <gui>Take Screenshotâ</gui></guiseq> or click <keyseq><key>Ctrl</key>
+ <key>S</key></keyseq>.</p>
+ </item>
+ <item>
+ <p>The <gui>Save Screenshot</gui> window will pop up.</p>
+ </item>
+ <item>
+ <p>Type the name of your screenshot.</p>
+ </item>
+ <item>
+ <p>Choose a location, where the screenshot sould be saved.</p>
+ </item>
+ <item>
+ <p>Click <gui>Save</gui> when ready.</p>
+ </item>
+ </steps>
+
+ <note>
+ <p>Your screenshots will be saved in <file>.png</file> format.</p>
+ </note>
+
+</page>
diff --git a/help/C/sidebar.page b/help/C/sidebar.page
new file mode 100644
index 0000000..3831a6c
--- /dev/null
+++ b/help/C/sidebar.page
@@ -0,0 +1,137 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide"
+ id="sidebar">
+
+ <info>
+ <link type="guide" xref="index#application-adjustment"/>
+ <link type="seealso" xref="playlist"/>
+ <desc>View and manage the sidebar.</desc>
+ <credit type="author">
+ <name>Marta Bogdanowicz</name>
+ <email>majus85 gmail com</email>
+ </credit>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>Sidebar</title>
+
+ <p>
+ View the <gui>Sidebar</gui> in one of the following ways:
+ </p>
+
+ <list>
+ <item>
+ <p>Click <guiseq><gui style="menu">View</gui>
+ <gui style="menuitem">Sidebar</gui></guiseq>.</p>
+ </item>
+ <item>
+ <p>Click <key>F9</key>.</p>
+ </item>
+ <item>
+ <p>Use the <gui> Sidebar</gui> icon, which is located below the time
+ slider, on the right side.</p>
+ </item>
+ <note>
+ <p><gui>Sidebar</gui> will appear on the right side of the display area.
+ Hide it in the same way, as you showed it.</p>
+ </note>
+ </list>
+
+ <p>
+ On the <gui>Sidebar</gui> you may view:
+ </p>
+
+ <terms>
+ <item>
+ <title><code>Playlist</code></title>
+ <p>Create and manage your own playlist. Do it by following the
+ instructions on <link xref="playlist"/> page.</p>
+ </item>
+ <item>
+ <title><code>Browse</code></title>
+ <p>Find audio or video files you want to play by browsing. Do it in the
+ following way:</p>
+ <steps>
+ <item>
+ <p>View <gui>Browse</gui> option by clicking
+ <guiseq><gui style="menu">View</gui>
+ <gui style="menuitem">Browse</gui></guiseq>.</p>
+ </item>
+ <item>
+ <p>In the <gui>Sidebar</gui> there will appear a list of sources
+ you may browse, such as <gui>You Tube</gui>, <gui>Jamendo</gui> or
+ <gui>Tracker</gui>.</p>
+ <note>
+ <p>To browse some of these sources you will need Internet
+ connection.</p>
+ </note>
+ </item>
+ </steps>
+ </item>
+ <item>
+ <title><code>Search</code></title>
+ <p>Find audio or video files you want to play by searching. Do it in the
+ following way:</p>
+ <steps>
+ <item>
+ <p>Click <guiseq><gui style="menu">View</gui>
+ <gui style="menuitem">Search</gui></guiseq>.</p>
+ </item>
+ <item>
+ <p>In the <gui>Sidebar</gui> there will appear search window.</p>
+ </item>
+ <item>
+ <p>Choose the source from the drop-down list or type the neame of
+ server you want to search.</p>
+ </item>
+ </steps>
+ </item>
+ <item>
+ <title><code>Chapters</code></title>
+ <p>Divide movie or song into chapters. In this way you may mark your
+ favourite parts and start playing from specified moment. Do it in the
+ following way:</p>
+ <steps>
+ <item>
+ <p>Click <guiseq><gui style="menu">View</gui>
+ <gui style="menuitem">Chapters</gui></guiseq>.</p>
+ </item>
+ <item>
+ <p>Click <gui>Add New Chapters</gui> and then
+ <gui>Add Chapterâ</gui> button.</p>
+ </item>
+ <item>
+ <p>New dialog will pop up. Name new chapter and click
+ <gui>OK</gui> when ready.</p>
+ <note style="tip">
+ <p>In this way you may add more chapters. The list of them
+ will appear in the <gui>Sidebar</gui>. Apart from the name you
+ chose for chapter, <app>Totem</app> will also show the time,
+ when the chapter begins.</p>
+ </note>
+ </item>
+ <item>
+ <p>You may also remove chapters by clicking
+ <gui>Remove Chapter</gui> button.</p>
+ </item>
+ <item>
+ <p>Navigate between chapters. Highlight one of them and click
+ <gui>Go to Chapter</gui> button. <app>Totem</app> will start
+ playing from the time specified by chosen chapter.</p>
+ </item>
+ <item>
+ <p>Save the list of chapters by clicking <gui>Save Changes</gui>.
+ </p>
+ </item>
+ <note>
+ <p>You may also load existing chapters. Do it by clicking
+ <gui>Load Chaptersâ</gui>. The chooser dialog will open. Select
+ file and click <gui>Open</gui> button.</p>
+ </note>
+ </steps>
+ </item>
+ </terms>
+
+</page>
diff --git a/help/C/subtitles.page b/help/C/subtitles.page
new file mode 100644
index 0000000..c789c7f
--- /dev/null
+++ b/help/C/subtitles.page
@@ -0,0 +1,45 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide"
+ id="subtitles">
+
+ <info>
+ <link type="guide" xref="index#playing-media"/>
+ <link type="seealso" xref="preferences"/>
+ <desc>Search for and select subtitles for the played movie.</desc>
+ <credit type="author">
+ <name>Marta Bogdanowicz</name>
+ <email>majus85 gmail com</email>
+ </credit>
+ <license>
+ <p>Creative Commons Share Alike 3.0</p>
+ </license>
+ </info>
+
+ <title>Subtitles</title>
+
+ <p>
+ <app>Totem</app> usually view subtitles automatically. If it does not, view
+ them in the following way:
+ </p>
+
+ <steps>
+ <item>
+ <p>Click <guiseq><gui style="menu">View</gui>
+ <gui style="menuitem">Subtitles</gui>
+ <gui>Select Text Subtitles</gui></guiseq>.</p>
+ </item>
+ <item>
+ <p>The file chooser will open. Search for the wanted subtitles.</p>
+ </item>
+ <item>
+ <p>Select them and click <gui>Open</gui>.</p>
+ </item>
+ </steps>
+
+ <note style="tip">
+ <p>Adjust size and font of subtitles to your needs. See
+ <guiseq><gui>General</gui><gui>Text Subtitles</gui></guiseq>
+ section on <link xref="preferences"/> page.</p>
+ </note>
+
+</page>
diff --git a/help/Makefile.am b/help/Makefile.am
index c393aaf..ec63718 100644
--- a/help/Makefile.am
+++ b/help/Makefile.am
@@ -1,20 +1,29 @@
include $(top_srcdir)/gnome-doc-utils.make
dist-hook: doc-dist-hook
-DOC_MODULE = totem
-DOC_ENTITIES = legal.xml
-DOC_H_FILE = totem-docs.h
-DOC_H_DOCS = C/totem.xml
-DOC_INCLUDES =
+# Module name
+DOC_ID = totem
-DOC_FIGURES = figures/totem_show_playlist_button.png \
- figures/totem_next_button.png \
- figures/totem_start_window.png \
- figures/totem_pause_button.png \
- figures/totem_volume_maximum_button.png \
- figures/totem_play_button.png \
- figures/totem_volume_mute_button.png \
- figures/totem_previous_button.png
+# List of figures to be included
+DOC_FIGURES = \
+ figures/totem-main-window.png \
+
+# List of pages
+DOC_PAGES = \
+ adjustment-sound.page \
+ file-open.page \
+ file-save.page \
+ index.page \
+ introduction.page \
+ keyboard-shortcuts.page \
+ navigation.page \
+ playlist.page \
+ preferences.page \
+ properties.page \
+ screenshot.page \
+ screenshot-gallery.page \
+ sidebar.page \
+ subtitles.page
DOC_LINGUAS = bg ca cs da de el en_GB es eu fi fr gl it ja oc pa pl pt_BR ro ru sl sv uk zh_CN zh_HK zh_TW
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
