[nautilus-actions] Update documentation
- From: Pierre Wieser <pwieser src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [nautilus-actions] Update documentation
- Date: Mon, 2 Aug 2010 20:33:49 +0000 (UTC)
commit c78670844c41430cdf73a51c5e48b80156efce14
Author: Pierre Wieser <pwieser trychlos org>
Date: Sun Aug 1 15:40:15 2010 +0200
Update documentation
ChangeLog | 29 +
configure.ac | 3 +
doc/Makefile.am | 3 +
doc/README | 21 +
doc/api/Makefile.am | 124 ++
doc/api/version.xml.in | 1 +
doc/internals/Makefile.am | 27 +
doc/nact/.gitignore | 1 +
doc/nact/C/appendix-feedback.xml | 5 +-
doc/nact/C/appendix-gnu-fdl-1.3.xml | 5 +-
doc/nact/C/articleinfo.xml | 41 +-
doc/nact/C/legalnotice.xml | 8 +-
doc/nact/C/nautilus-actions-config-tool.xml | 2196 ++++++++++++++------------
doc/nact/Makefile.am | 4 +-
doc/nact/nautilus-actions-config-tool.omf.in | 9 +
doc/product/Makefile.am | 27 +
16 files changed, 1486 insertions(+), 1018 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index ef19968..1631c62 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,32 @@
+2010-08-01 Pierre Wieser <pwieser trychlos org>
+
+ * doc/README: Define a global documentation plan.
+
+ * doc/api/Makefile.am:
+ * doc/api/version.xml.in:
+ Define a stub for future public API documentation, targeting
+ Nautilus-Actions plugins developers.
+
+ * doc/internals/Makefile.am:
+ Define a stub for future internal documentation, targeting
+ Nautilus-Actions core developers.
+
+ * doc/product/Makefile.am:
+ Define a stub for future global Nautilus-Actions documentation.
+
+ * configure.ac:
+ * doc/Makefile.am: Updated accordingly.
+
+ * doc/nact/ChangeLog:
+ * doc/nact/nautilus-actions-config-tool.omf.in: New files.
+
+ * doc/nact/C/articleinfo.xml:
+ * doc/nact/C/legalnotice.xml: Included as external entities rather
+ than from xi:include because of db2omf complains.
+
+ * doc/nact/C/appendix-feedback.xml:
+ * doc/nact/C/appendix-gnu-fdl-1.3.xml: Add DOCTYPE declaration.
+
2010-07-31 Pierre Wieser <pwieser trychlos org>
* src/nact/nautilus-actions-config-tool.ui:
diff --git a/configure.ac b/configure.ac
index 444d4fd..3833c35 100644
--- a/configure.ac
+++ b/configure.ac
@@ -40,7 +40,10 @@ AC_CONFIG_FILES([
Makefile
data/Makefile
doc/Makefile
+ doc/api/Makefile
+ doc/internals/Makefile
doc/nact/Makefile
+ doc/product/Makefile
m4/Makefile
icons/Makefile
icons/16x16/Makefile
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 0b363d8..04d4cba 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -27,7 +27,10 @@
# ... and many others (see AUTHORS)
SUBDIRS = \
+ api \
+ internals \
nact \
+ product \
$(NULL)
pkgdocdir = $(datarootdir)/doc/@PACKAGE -@VERSION@
diff --git a/doc/README b/doc/README
new file mode 100644
index 0000000..1c98218
--- /dev/null
+++ b/doc/README
@@ -0,0 +1,21 @@
+The documentation associated with Nautilus-Actions is composed of
+several parts:
+
+- a global documentation which describes all features of the product,
+ such as D-Bus interface, command-line utilities, what is an I/O
+ provider and which I/O providers are provided by default, a description
+ of the export formats, an annexe for .desktop files, a note about
+ versions
+ product/
+
+- the Nautilus-Actions configuration tool user's manual
+ nact/
+
+- the public API which must be used to develop Nautilus-Actions plugins
+ api/
+ only document here the public API
+
+- some articles which target the Nautilus-Actions core developer.
+ internals/
+ put here all informations which may be relevant to the core developer
+ included the internal API
diff --git a/doc/api/Makefile.am b/doc/api/Makefile.am
new file mode 100644
index 0000000..efa171f
--- /dev/null
+++ b/doc/api/Makefile.am
@@ -0,0 +1,124 @@
+# Nautilus Actions
+# A Nautilus extension which offers configurable context menu actions.
+#
+# Copyright (C) 2005 The GNOME Foundation
+# Copyright (C) 2006, 2007, 2008 Frederic Ruaudel and others (see AUTHORS)
+# Copyright (C) 2009, 2010 Pierre Wieser and others (see AUTHORS)
+#
+# This Program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as
+# published by the Free Software Foundation; either version 2 of
+# the License, or (at your option) any later version.
+#
+# This Program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public
+# License along with this Library; see the file COPYING. If not,
+# write to the Free Software Foundation, Inc., 59 Temple Place,
+# Suite 330, Boston, MA 02111-1307, USA.
+#
+# Authors:
+# Frederic Ruaudel <grumz grumz net>
+# Rodrigo Moya <rodrigo gnome-db org>
+# Pierre Wieser <pwieser trychlos org>
+# ... and many others (see AUTHORS)
+
+#include $(top_srcdir)/gtk-doc.make
+
+# The name of the module.
+#DOC_MODULE = nautilus-actions
+
+# The top-level SGML file.
+#DOC_MAIN_SGML_FILE = nautilus-actions.xml
+
+# Extra options to supply to gtkdoc-scan
+#SCAN_OPTIONS = \
+# --ignore-headers="config.h devkit-disks-daemon-glue.h devkit-disks-device-glue.h gdu-private.h gdu-marshal.h gdu-shared.h" \
+# --rebuild-sections
+
+# The directory containing the source code. Relative to $(srcdir)
+#DOC_SOURCE_DIR = ../src/gdu --source-dir=../src/gdu-gtk
+
+# Used for dependencies
+#HFILE_GLOB = $(top_srcdir)/src/gdu*/*.h
+#CFILE_GLOB = $(top_srcdir)/src/gdu*/*.c
+
+# Headers to ignore
+IGNORE_HFILES = \
+ $(NULL)
+
+# CFLAGS and LDFLAGS for compiling scan program. Only needed
+# if $(DOC_MODULE).types is non-empty.
+#INCLUDES = \
+# $(GTK_CFLAGS) \
+# $(DBUS_GLIB_CFLAGS) \
+# -I$(top_srcdir)/src \
+# -I$(top_builddir)/src \
+# -I$(top_srcdir)/src/gdu \
+# -I$(top_builddir)/src/gdu \
+# -I$(top_srcdir)/src/gdu-gtk \
+# -I$(top_builddir)/src/gdu-gtk \
+# $(NULL)
+
+#GTKDOC_LIBS = \
+# $(GLIB2_LIBS) \
+# $(GIO2_LIBS) \
+# $(GIO_UNIX2_LIBS) \
+# $(DBUS_GLIB_LIBS) \
+# $(GNOME_KEYRING_LIBS) \
+# $(top_builddir)/src/gdu/libgdu.la \
+# $(top_builddir)/src/gdu-gtk/libgdu-gtk.la \
+# $(NULL)
+
+# Extra options to supply to gtkdoc-mkdb
+#MKDB_OPTIONS = \
+# --sgml-mode \
+# --output-format=xml \
+# --ignore-files="devkit-disks-daemon-glue.h devkit-disks-device-glue.h gdu-private.h gdu-marshal.h gdu-shared.h"
+
+# Extra options to supply to gtkdoc-mktmpl
+MKTMPL_OPTIONS = \
+ $(NULL)
+
+# Non-autogenerated SGML files to be included in $(DOC_MAIN_SGML_FILE)
+content_files = \
+ version.xml \
+ $(NULL)
+
+# Images to copy into HTML directory
+HTML_IMAGES = \
+ $(NULL)
+
+# Extra options to supply to gtkdoc-fixref
+FIXXREF_OPTIONS = \
+ $(NULL)
+
+MAINTAINERCLEANFILES = \
+ *~ \
+ Makefile.in \
+ $(NULL)
+
+#CLEANFILES += \
+# *~ \
+# gnome-disk-utility-scan* \
+# gnome-disk-utility.args \
+# gnome-disk-utility.hierarchy \
+# gnome-disk-utility.interfaces \
+# gnome-disk-utility.prerequisites \
+# gnome-disk-utility.signals \
+# *.bak \
+# gnome-disk-utility-decl-list.txt \
+# gnome-disk-utility-decl.txt \
+# gnome-disk-utility-overrides.txt \
+# gnome-disk-utility-undeclared.txt \
+# gnome-disk-utility-undocumented.txt \
+# gnome-disk-utility-sections.txt \
+# *.stamp \
+# -rf html xml tmpl \
+# $(NULL)
+
+# Version information for marking the documentation
+EXTRA_DIST = version.xml.in
diff --git a/doc/api/version.xml.in b/doc/api/version.xml.in
new file mode 100644
index 0000000..d78bda9
--- /dev/null
+++ b/doc/api/version.xml.in
@@ -0,0 +1 @@
+ VERSION@
diff --git a/doc/internals/Makefile.am b/doc/internals/Makefile.am
new file mode 100644
index 0000000..93cbc52
--- /dev/null
+++ b/doc/internals/Makefile.am
@@ -0,0 +1,27 @@
+# Nautilus Actions
+# A Nautilus extension which offers configurable context menu actions.
+#
+# Copyright (C) 2005 The GNOME Foundation
+# Copyright (C) 2006, 2007, 2008 Frederic Ruaudel and others (see AUTHORS)
+# Copyright (C) 2009, 2010 Pierre Wieser and others (see AUTHORS)
+#
+# This Program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as
+# published by the Free Software Foundation; either version 2 of
+# the License, or (at your option) any later version.
+#
+# This Program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public
+# License along with this Library; see the file COPYING. If not,
+# write to the Free Software Foundation, Inc., 59 Temple Place,
+# Suite 330, Boston, MA 02111-1307, USA.
+#
+# Authors:
+# Frederic Ruaudel <grumz grumz net>
+# Rodrigo Moya <rodrigo gnome-db org>
+# Pierre Wieser <pwieser trychlos org>
+# ... and many others (see AUTHORS)
diff --git a/doc/nact/.gitignore b/doc/nact/.gitignore
new file mode 100644
index 0000000..e8a71e0
--- /dev/null
+++ b/doc/nact/.gitignore
@@ -0,0 +1 @@
+*.omf
diff --git a/doc/nact/C/appendix-feedback.xml b/doc/nact/C/appendix-feedback.xml
index 2d05920..2357e5a 100644
--- a/doc/nact/C/appendix-feedback.xml
+++ b/doc/nact/C/appendix-feedback.xml
@@ -1,4 +1,7 @@
<?xml version="1.0"?>
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [
+]>
+
<appendix id="appendix-feedback">
<title>Feedback</title>
<para>
@@ -6,4 +9,4 @@
or this manual, follow the directions in the
<ulink url="ghelp:user-guide#feedback" type="help">GNOME Feedback Page</ulink>.
</para>
-</appendix>
\ No newline at end of file
+</appendix>
diff --git a/doc/nact/C/appendix-gnu-fdl-1.3.xml b/doc/nact/C/appendix-gnu-fdl-1.3.xml
index ff4f9f9..54e50b3 100644
--- a/doc/nact/C/appendix-gnu-fdl-1.3.xml
+++ b/doc/nact/C/appendix-gnu-fdl-1.3.xml
@@ -1,4 +1,7 @@
<?xml version="1.0"?>
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [
+]>
+
<appendix id="appendix-gnu-fdl">
<title>GNU Free Documentation License</title>
<simpara>Version 1.3, 3 November 2008</simpara>
@@ -557,4 +560,4 @@ being LIST, and with the Back-Cover Texts being LIST.</screen>
software license, such as the GNU General Public License, to permit their
use in free software.
</simpara>
-</appendix>
\ No newline at end of file
+</appendix>
diff --git a/doc/nact/C/articleinfo.xml b/doc/nact/C/articleinfo.xml
index 41607f7..b179e63 100644
--- a/doc/nact/C/articleinfo.xml
+++ b/doc/nact/C/articleinfo.xml
@@ -1,4 +1,3 @@
-<?xml version="1.0"?>
<articleinfo>
<title>&appname; User's Manual</title>
@@ -35,9 +34,9 @@
<email>pwieser trychlos org</email>
</author>
-<!-- This is appropriate place for other contributors: translators,
- -- maintainers, etc. Commented out by default.
- --
+<!-- This is appropriate place for other contributors: translators, maintainers, etc.
+ Commented out by default.
+
<othercredit role="translator">
<firstname>Latin</firstname>
<surname>Translator 1</surname>
@@ -47,25 +46,25 @@
</affiliation>
<contrib>Latin translation</contrib>
</othercredit>
- --
+
-->
</authorgroup>
<!-- According to GNU FDL, revision history is mandatory if you are
- -- modifying/reusing someone else's document. If not, you can omit it.
- -- Remember to remove the &manrevision; entity from the revision entries other
- -- than the current revision.
- -- The revision numbering system for GNOME manuals is as follows:
- -- * the revision number consists of two components
- -- * the first component of the revision number reflects the release version
- -- of the GNOME desktop.
- -- * the second component of the revision number is a decimal unit that is
- -- incremented with each revision of the manual.
- -- For example, if the GNOME desktop release is V2.x, the first version of the
- -- manual that is written in that desktop timeframe is V2.0, the second version
- -- of the manual is V2.1, etc.
- -- When the desktop release version changes to V3.x, the revision number of the
- -- manual changes to V3.0, and so on.
+ modifying/reusing someone else's document. If not, you can omit it.
+ Remember to remove the &manrevision; entity from the revision entries other
+ than the current revision.
+ The revision numbering system for GNOME manuals is as follows:
+ * the revision number consists of two components
+ * the first component of the revision number reflects the release version
+ of the GNOME desktop.
+ * the second component of the revision number is a decimal unit that is
+ incremented with each revision of the manual.
+ For example, if the GNOME desktop release is V2.x, the first version of the
+ manual that is written in that desktop timeframe is V2.0, the second version
+ of the manual is V2.1, etc.
+ When the desktop release version changes to V3.x, the revision number of the
+ manual changes to V3.0, and so on.
-->
<revhistory>
@@ -81,6 +80,6 @@
</revision>
</revhistory>
- <xi:include href="legalnotice.xml" />
+ &legalnotice;
-</articleinfo>
\ No newline at end of file
+</articleinfo>
diff --git a/doc/nact/C/legalnotice.xml b/doc/nact/C/legalnotice.xml
index cb6bfc4..a957aa0 100644
--- a/doc/nact/C/legalnotice.xml
+++ b/doc/nact/C/legalnotice.xml
@@ -1,8 +1,6 @@
-<?xml version="1.0"?>
-
<!-- This file contains link to license for the documentation (GNU FDL),
- -- and other legal stuff such as "NO WARRANTY" statement.
- -- Please do not change any of this.
+ and other legal stuff such as "NO WARRANTY" statement.
+ Please do not change any of this.
-->
<legalnotice id="legalnotice">
@@ -79,4 +77,4 @@
</listitem>
</orderedlist>
</para>
-</legalnotice>
\ No newline at end of file
+</legalnotice>
diff --git a/doc/nact/C/nautilus-actions-config-tool.xml b/doc/nact/C/nautilus-actions-config-tool.xml
index 22e4235..ca9c804 100644
--- a/doc/nact/C/nautilus-actions-config-tool.xml
+++ b/doc/nact/C/nautilus-actions-config-tool.xml
@@ -1,988 +1,1208 @@
-<?xml version="1.0"?>
-<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [
- <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
-
- <!-- name and version of the application -->
- <!ENTITY prodname "<productname>Nautilus-Actions</productname>">
- <!ENTITY appname "<application>Nautilus-Actions Configuration Tool</application>">
- <!ENTITY appversion "3.0">
-
- <!-- revision number and release date of this manual -->
- <!ENTITY manrevision "3.0">
- <!ENTITY mandate "August 2010">
-
- <!ENTITY nautilus "<productname>Nautilus</productname>">
-]>
-
-<!-- ========================= Document Header ============================
- -- Please do not change the id!
- -- For translations, change lang to appropriate code
- -->
-<article id="index" lang="en">
-
- <xi:include href="articleinfo.xml" />
-
- <xi:include href="appendix-gnu-fdl.xml" />
- <xi:include href="appendix-feedback.xml" />
-
- <indexterm zone="index">
- <primary>&nautilus;</primary>
- </indexterm>
- <indexterm zone="index">
- <primary>&prodname;</primary>
- </indexterm>
-
-
-<!-- =========================== Document Body ============================= -->
-<!-- =========================== Introduction ==============================
- -- Use the Introduction section to give a brief overview of what
- -- the application is and what it does.
- -->
-
- <sect1 id="introduction">
- <title>Introduction</title>
- <para>
- &prodname; is a &nautilus; extension which let the user
- define new actions in the file-manager context menus, and group them
- into his own menus.
- </para>
- <para>
- The &appname; application is the user interface which let you precisely
- configure how, where and when your actions should appear in &nautilus;
- context menus, how they will be executed.
- </para>
- <para>
- &appname; provides the following features:
- </para>
- <itemizedlist>
- <listitem>
- <para>Define and configure actions from scratch.</para>
- </listitem>
- <listitem>
- <para>Organize actions into menus, submenus and so on.</para>
- </listitem>
- <listitem>
- <para>Import and export actions and menus from and to outside world.</para>
- </listitem>
- </itemizedlist>
-
- <note>
- <para>
- &prodname; also comes with additional functionality such as:
- </para>
- <itemizedlist>
- <listitem>
- <para>
- A DBus interface which let you run any action from the
- command-line, of from a keyboard shortcut.
- </para>
- </listitem>
- </itemizedlist>
- </note>
- </sect1>
-
-<!-- ========================= Getting Started =============================
- -- Use the Getting Started section to describe the steps required
- -- to start the application and to describe the user interface components
- -- of the application. If there is other information that it is important
- -- for readers to know before they start using the application, you should
- -- also include this information here.
- -- If the information about how to get started is very short, you can
- -- include it in the Introduction and omit this section.
- -->
-
- <sect1 id="getting-started">
- <title>Getting Started</title>
-
- <sect2 id="starting">
- <title>Start &appname;</title>
- <para>
- You can start &appname; in the following ways:
- </para>
- <variablelist>
- <varlistentry>
- <term><guimenu>Applications</guimenu> menu</term>
- <listitem>
- <para>
- Choose
- <menuchoice>
- <guisubmenu>Sound & Video</guisubmenu>
- <guimenuitem>Movie Player</guimenuitem>
- </menuchoice>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Command line</term>
- <listitem>
- <para>
- To start &appname; from a command line, type the following command,
- then press <keycap>Return</keycap>:
- </para>
- <para>
- <command>nautilus-actions-config-tool</command>
- </para>
- <tip>
- <para>
- To view other command line options that are available,
- type <command>totem --help</command>, then press <keycap>Return</keycap>.
- </para>
- </tip>
- </listitem>
- </varlistentry>
- </variablelist>
- </sect2>
-
- <sect2 id="when-start">
- <title>The first run</title>
- <para>
- When you start &appname;, the following window is displayed.
- </para>
- <figure id="nact-FIG-main-empty">
- <title>&appname; Start Up Window</title>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="figures/nact-main-empty.png" format="PNG"/>
- </imageobject>
- <textobject>
- <phrase>
- Shows &appname; main window.
- Contains menubar, display area, an empty items list in the left,
- several disabled properties tab, and statusbar.
- </phrase>
- </textobject>
- <caption>
- <para>The empty &appname; main window</para>
- </caption>
- </mediaobject>
- </screenshot>
- </figure>
-
- <!-- Include any descriptions of the GUI immediately after the screenshot
- -- of the main UI, for example, the items on the menubar and on the toolbar.
- -- This section is optional.
- -->
- <para>
- The &appname; main window contains the following elements:
- </para>
- <variablelist>
- <varlistentry>
- <term>Menubar.</term>
- <listitem>
- <para>
- The menus on the menubar contain all of the commands
- you need to use in &appname;.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Items list.</term>
- <listitem>
- <para>
- The list on the left of the main window contains all items,
- whether they are actions or menus, currently available.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Properties tabs.</term>
- <listitem>
- <para>
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Statusbar.</term>
- <listitem>
- <para>
- The statusbar displays some status informations about the
- currently selected row in the items list.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </sect2>
- </sect1>
-
-<!-- ============================== Usage =====================================
- -- Use this section to describe how to use the application to perform the
- -- tasks for which the application is designed.
- -->
-
- <sect1 id="usage">
- <title>Usage</title>
-
- <!-- ================ Usage Subsection ================================ -->
- <sect2 id="totem-open-file">
- <title>To Open a File</title>
- <para>To open a video or an audio file, choose
- <menuchoice>
- <shortcut><keycombo><keycap>Ctrl</keycap><keycap>O</keycap></keycombo></shortcut>
- <guimenu>Movie</guimenu>
- <guisubmenu>Open</guisubmenu>
- </menuchoice>.
- The <application>Select Movies or Playlists</application> dialog is displayed.
- Select the file or files you want to open, then click
- <guibutton>OK</guibutton>.
- </para>
- <para>You can drag a file from another application such as a file manager to the
- <application>&app;</application> window. If you drag the file to the display area, the file will replace the current
- playlist and will start playing immediately. If you drag the file to the playlist in the sidebar, the file will be
- appended to the current playlist. The <application>&app;</application> application
- will open the file and play the movie or song. <application>&app;</application>
- displays the title of the movie or song in the titlebar of
- the window and in the playlist in the sidebar.
- </para>
- <para>If you try to open a file format that <application>&app;</application> does
- not recognize, the application displays an error message. This error is most often encountered
- if you do not have the correct codecs installed. Information on getting codecs working can be found on
- the <ulink url="http://projects.gnome.org/totem/#codecs"; type="http"><application>&app;</application> website</ulink>.
- </para>
- <tip>
- <para>You can double-click on a video or an audio file in the <application>Nautilus</application>
- file manager to open it in the <application>&app;</application> window.
- </para>
- </tip>
- </sect2>
-
- <sect2 id="totem-usage-open-location">
- <title>To Open a Location</title>
- <para>To open a file by URI (location), choose
- <menuchoice>
- <shortcut><keycombo><keycap>Ctrl</keycap><keycap>L</keycap></keycombo></shortcut>
- <guimenu>Movie</guimenu>
- <guimenuitem>Open Location</guimenuitem>
- </menuchoice>. The <application>Open Location</application> dialog is displayed. Use the drop-down
- combination box to specify the URI you would like to open (it lists URIs which have
- previously been opened) – or type one in directly – then click on the <guibutton>Open</guibutton> button.
- </para>
- <para>If you have a URI in the clipboard already, it will automatically be pasted into the combination box.</para>
- </sect2>
-
- <sect2 id="totem-usage-play">
- <title>To Play a Movie (DVD or VCD)</title>
- <para>Insert the disc in the optical device of your computer, then choose
- <menuchoice><guimenu>Movie</guimenu><guimenuitem>Play Disc</guimenuitem>
- </menuchoice>.</para>
- <para>To eject a DVD or VCD, choose
- <menuchoice>
- <shortcut><keycombo><keycap>Ctrl</keycap><keycap>E</keycap></keycombo></shortcut>
- <guimenu>Movie</guimenu>
- <guimenuitem>Eject</guimenuitem>
- </menuchoice>.
- </para>
- </sect2>
-
- <sect2 id="totem-usage-pause">
- <title>To Pause a Movie or Song</title>
- <para>To pause a movie or song that is playing, click on the
- <inlinemediaobject>
- <imageobject><imagedata fileref="figures/totem_pause_button.png" format="PNG"/></imageobject>
- <textobject><phrase>Shows pause button.</phrase></textobject>
- </inlinemediaobject> button, or choose
- <menuchoice>
- <shortcut><keycombo><keycap>Ctrl</keycap><keycap>Space</keycap></keycombo></shortcut>
- <guimenu>Movie</guimenu>
- <guimenuitem>Play / Pause</guimenuitem>
- </menuchoice>. You may also use the <keycap>P</keycap> key to pause or play a movie.
- </para>
- <para>To resume playing a movie or song, click on the
- <inlinemediaobject>
- <imageobject><imagedata fileref="figures/totem_play_button.png" format="PNG"/></imageobject>
- <textobject><phrase>Shows play button.</phrase></textobject>
- </inlinemediaobject> button again, or choose
- <menuchoice>
- <shortcut><keycombo><keycap>Ctrl</keycap><keycap>Space</keycap></keycombo></shortcut>
- <guimenu>Movie</guimenu>
- <guimenuitem>Play / Pause</guimenuitem>
- </menuchoice>.
- </para>
- </sect2>
-
- <sect2 id="totem-usage-view-properties">
- <title>To View Properties of a Movie or Song</title>
- <para>To view the properties of a movie or song, choose
- <menuchoice>
- <guimenu>View</guimenu>
- <guimenuitem>Sidebar</guimenuitem></menuchoice> to make the sidebar
- appear, and choose <guimenu>Properties</guimenu> in the drop-down list at the top of the sidebar.</para>
- </sect2>
-
- <sect2 id="totem-usage-seek">
- <title>To Seek Through Movies or Songs</title>
- <para>To seek through movies or songs, you can use the following methods:
- </para>
- <variablelist>
- <varlistentry>
- <term>To skip forward</term>
- <listitem>
- <para>To skip forward through a movie or song, choose
- <menuchoice>
- <shortcut><keycap>Right</keycap></shortcut>
- <guimenu>Go</guimenu>
- <guimenuitem>Skip Forward</guimenuitem>
- </menuchoice>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>To skip backward</term>
- <listitem>
- <para>To skip backwards through a movie or song, choose
- <menuchoice>
- <shortcut><keycap>Left</keycap></shortcut>
- <guimenu>Go</guimenu>
- <guimenuitem>Skip Backwards</guimenuitem>
- </menuchoice>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>To skip to a time</term>
- <listitem>
- <para>To skip to a specific elapsed time in the movie or song, choose
- <menuchoice>
- <shortcut><keycombo><keycap>Ctrl</keycap><keycap>K</keycap></keycombo></shortcut>
- <guimenu>Go</guimenu>
- <guimenuitem>Skip to</guimenuitem>
- </menuchoice>. The <application>Skip to</application> dialog is displayed. Use the
- spin box to specify the elapsed time (in seconds) to skip to, then
- click <guibutton>OK</guibutton>.
- </para>
- <para>The spin box also allows more natural language to be used. You can enter a time in the
- formats "hh:mm:ss", "mm:ss" or "ss"; where "hh" is the hour, "mm" is the minute and "ss" is the
- second to skip to.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>To move to the next movie or song</term>
- <listitem>
- <para>To move to the next movie or song, choose
- <menuchoice>
- <shortcut><keycombo><keycap>Alt</keycap><keycap>Right</keycap></keycombo></shortcut>
- <guimenu>Go</guimenu>
- <guimenuitem>Next Chapter/Movie</guimenuitem>
- </menuchoice> or click on the
- <inlinemediaobject>
- <imageobject><imagedata fileref="figures/totem_next_button.png" format="PNG"/></imageobject>
- <textobject><phrase>Shows a seek next button</phrase></textobject>
- </inlinemediaobject> button.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>To move to the previous movie or song</term>
- <listitem>
- <para>To move to the previous movie or song, choose
- <menuchoice>
- <shortcut><keycombo><keycap>Alt</keycap><keycap>Left</keycap></keycombo></shortcut>
- <guimenu>Go</guimenu>
- <guimenuitem>Previous Chapter/Movie</guimenuitem>
- </menuchoice> or click on the
- <inlinemediaobject>
- <imageobject><imagedata fileref="figures/totem_previous_button.png" format="PNG"/></imageobject>
- <textobject><phrase>Shows a seek previous button</phrase></textobject>
- </inlinemediaobject> button.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </sect2>
-
- <sect2 id="totem-usage-change-zoom">
- <title>To Change the Zoom Factor</title>
- <sect3 id="totem-usage-change-size">
- <title>To Change the Video Size</title>
- <para>To change the zoom factor of the display area, you can use the
- following methods:
- </para>
- <itemizedlist>
- <listitem>
- <para>To zoom to fullscreen mode, choose
- <menuchoice><shortcut><keycap>F11</keycap></shortcut>
- <guimenu>View</guimenu><guimenuitem>Fullscreen</guimenuitem></menuchoice>. You can also
- use the <keycap>F</keycap> key to toggle fullscreen mode.
- To exit fullscreen mode, click on the
- <guibutton>Leave Fullscreen</guibutton> button or press
- <keycap>Esc</keycap>, <keycap>F11</keycap> or <keycap>F</keycap>.
- </para>
- </listitem>
- <listitem>
- <para>To change the size of the original movie or visualization,
- choose
- <menuchoice>
- <shortcut><keycombo><keycap>Ctrl</keycap><keycap>0</keycap></keycombo></shortcut>
- <guimenu>View</guimenu><guimenuitem>Fit Window to Movie</guimenuitem>
- </menuchoice> and choose a scale ratio.
- </para>
- </listitem>
- </itemizedlist>
- </sect3>
- <sect3 id="totem-usage-change-ratio">
- <title>To Change the Video Aspect Ratio</title>
- <para>To switch between different aspect ratios, choose
- <menuchoice>
- <shortcut><keycap>A</keycap></shortcut>
- <guimenu>View</guimenu>
- <guisubmenu>Aspect Ratio</guisubmenu>
- </menuchoice>.</para>
- </sect3>
- </sect2>
-
- <sect2 id="totem-usage-adjust-volume">
- <title>To Adjust the Volume</title>
- <para>To increase the volume, choose
- <menuchoice>
- <shortcut><keycap>Up</keycap></shortcut>
- <guimenu>Sound</guimenu>
- <guimenuitem>Volume Up</guimenuitem>
- </menuchoice>.
- To decrease the volume, choose
- <menuchoice>
- <shortcut><keycap>Down</keycap></shortcut>
- <guimenu>Sound</guimenu>
- <guimenuitem>Volume Down</guimenuitem>
- </menuchoice>.
- </para>
- <para>You can also use the volume button: click on the volume button and choose the volume level with the slider.</para>
- </sect2>
-
- <sect2 id="totem-usage-on-top">
- <title>To Make the Window Always on Top</title>
- <para>To make the <application>&app;</application> window always on top of other application windows,
- choose
- <menuchoice>
- <guimenu>Edit</guimenu>
- <guimenuitem>Plugins</guimenuitem>
- </menuchoice>. Select the <guilabel>Always on Top</guilabel> plugin to enable it. The <application>&app;</application> window will now stay on
- top of all other windows while a movie is playing, but not while audio or visualizations are playing.
- </para>
- <para>To stop the window from always being on top, disable the <guilabel>Always on Top</guilabel> plugin again.
- See <xref linkend="totem-plugins-always-on-top"/> for more information.</para>
- </sect2>
-
- <sect2 id="totem-usage-show-control">
- <title>To Show or Hide Controls</title>
- <para>To show or hide the <application>&app;</application> window controls, choose
- <menuchoice>
- <shortcut><keycombo><keycap>Ctrl</keycap><keycap>H</keycap></keycombo></shortcut>
- <guimenu>View</guimenu>
- <guimenuitem>Show Controls</guimenuitem>
- </menuchoice>, or press the <keycap>H</keycap> key.
- You can also right-click on the <application>&app;</application> window, then choose
- <menuchoice>
- <shortcut><keycombo><keycap>Ctrl</keycap><keycap>H</keycap></keycombo></shortcut>
- <guimenuitem>Show Controls</guimenuitem>
- </menuchoice> from the popup menu.
- </para>
- <para>If the <guilabel>Show Controls</guilabel> option is selected,
- <application>&app;</application> will show the menubar, elapsed time slider,
- seek control buttons, volume slider and statusbar on the window. If
- the <guilabel>Show Controls</guilabel> option is unselected, the application
- will hide these controls and show only the display area.
- </para>
- </sect2>
-
- <sect2 id="totem-usage-playlist">
- <title>To Manage the Playlist</title>
-
- <sect3 id="totem-usage-playlist-show-hide">
- <title>To Show or Hide the Playlist</title>
- <para>To show or hide the playlist, choose
- <menuchoice>
- <guimenu>View</guimenu><guimenuitem>Sidebar</guimenuitem>
- </menuchoice> or click on the <guibutton>Sidebar</guibutton> button, and
- choose <guimenu>Playlist</guimenu> on the top of
- the sidebar.</para>
- </sect3>
-
- <sect3 id="totem-usage-playlist-manage">
- <title>Manage a Playlist</title>
- <para>You can use the <application>Playlist</application> dialog to do the following:
- <variablelist>
- <varlistentry>
- <term>To add a track or movie</term>
- <listitem>
- <para>To add a track or movie to the playlist, click on the <guibutton>Add</guibutton>
- button. The <application>Select Movies or Playlists</application> dialog is displayed. Select the file that you
- want to add to the playlist, then click <guibutton>Add</guibutton>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>To remove a track or movie</term>
- <listitem>
- <para>To remove a track or movie from the playlist, select the item or items to remove from the
- playlist, then click on the <guibutton>Remove</guibutton> button.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>To save the playlist to a file</term>
- <listitem>
- <para>To save the playlist to a file, click on the <guibutton>Save Playlist</guibutton>
- button. The <application>Save Playlist</application> dialog is displayed; specify
- the filename as which you want to save the playlist, and click <guibutton>Save</guibutton>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>To move a track or movie up the playlist</term>
- <listitem>
- <para>To move a track or movie up the playlist, select the item from the
- playlist, then click on the <guibutton>Move Up</guibutton> button.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>To move a track or movie down the playlist</term>
- <listitem>
- <para>To move a track or movie down the playlist, select the item from the
- playlist, then click on the <guibutton>Move Down</guibutton> button.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
- </sect3>
- <sect3 id="totem-usage-playlist-repeat">
- <title>To Select or Unselect Repeat Mode</title>
- <para>To enable or disable repeat mode, choose
- <menuchoice><guimenu>Edit</guimenu><guimenuitem>Repeat Mode</guimenuitem></menuchoice>.
- </para>
- </sect3>
- <sect3 id="totem-usage-playlist-shuffle">
- <title>To Select or Unselect Shuffle Mode</title>
- <para>To enable or disable shuffle mode, choose
- <menuchoice><guimenu>Edit</guimenu><guimenuitem>Shuffle
- Mode</guimenuitem></menuchoice>.
- </para>
- </sect3>
- </sect2>
-
- <sect2 id="totem-usage-subtitle">
- <title>To Choose Subtitles</title>
- <para>To choose
- the language of the subtitles, select
- <menuchoice><guimenu>View</guimenu><guisubmenu>Subtitles</guisubmenu></menuchoice>
- and choose the subtitle language you want to display.</para>
- <para>To disable the display of subtitles, select
- <menuchoice><guimenu>View</guimenu><guisubmenu>Subtitles</guisubmenu><guimenuitem>None</guimenuitem></menuchoice>.</para>
- <note><para>By default, <application>&app;</application> will choose the same language for the
- subtitles as the one you normally use on your computer.</para></note>
- <para><application>&app;</application> will automatically load and display subtitles for a video if it finds a subtitle file with the
- same name as the video being played, and the extension <filename class="extension">asc</filename>, <filename class="extension">txt</filename>,
- <filename class="extension">sub</filename>, <filename class="extension">srt</filename>, <filename class="extension">smi</filename>,
- <filename class="extension">ssa</filename> or <filename class="extension">ass</filename>.
- </para>
- <para>If the file containing the subtitles has a different name from the video being played, you can
- right-click on the video in the playlist and choose <menuchoice><guimenuitem>Select Text Subtitles</guimenuitem></menuchoice>
- from the popup menu to load the correct subtitle file. You may also choose subtitles by choosing
- <menuchoice><guimenu>View</guimenu><guimenuitem>Select Text Subtitles</guimenuitem></menuchoice>.</para>
- <para>Using the <guilabel>Subtitle Downloader</guilabel> plugin, you can also download subtitles from the OpenSubtitles service. See
- <xref linkend="totem-plugins-opensubtitles"/> for more information.</para>
- </sect2>
-
- <sect2 id="totem-usage-take-screenshot">
- <title>To Take a Screenshot</title>
- <para>To take a screenshot of the movie or visualization that is playing, choose
- <menuchoice>
- <guimenu>Edit</guimenu>
- <guimenuitem>Take Screenshot</guimenuitem>
- </menuchoice>. The <application>Save Screenshot</application> dialog is displayed. Choose a location and
- insert the filename as which you want to save the screenshot, then click on the <guibutton>Save</guibutton> button
- to save the screenshot.
- </para>
- <tip><para><application>&app;</application> will display a preview of the screenshot which is to be saved on the left-hand side of the <application>Save Screenshot</application> dialog.</para></tip>
- </sect2>
-
- <sect2 id="totem-usage-create-screenshot-gallery">
- <title>To Create a Screenshot Gallery</title>
- <para>To create a gallery of screenshots of the movie or visualization that is playing, choose
- <menuchoice>
- <guimenu>Edit</guimenu>
- <guimenuitem>Create Screenshot Gallery</guimenuitem>
- </menuchoice>. The <application>Save Gallery</application> dialog is displayed. Choose a location and
- insert the filename as which you want to save the gallery image, then click on the <guibutton>Save</guibutton> button
- to save the screenshot.
- </para>
- <tip><para>You may specify the width of the individual screenshots in the gallery using the <guilabel>Screenshot width</guilabel> entry.
- The default width is 128 pixels.</para>
- <para>You may also specify the number of screenshots to be put in the gallery. By default, this is calculated based on the length of the movie;
- however, this may be overridden by deselecting the <guilabel>Calculate the number of screenshots</guilabel> checkbox and entering the new
- number in the <guilabel>Number of screenshots</guilabel> spin box.</para></tip>
- </sect2>
- </sect1>
-
-<!-- =========== Plugins ======================================= -->
- <sect1 id="totem-plugins">
- <title>Plugins</title>
- <para><application>&app;</application> has many features which are present in the form of plugins ? pieces of the software which are only loaded
- if necessary.</para>
- <sect2 id="totem-plugins-load">
- <title>To Enable a Plugin</title>
- <para>To view the list of installed plugins, choose <menuchoice><guimenu>Edit</guimenu><guimenuitem>Plugins</guimenuitem></menuchoice>. The
- <application>Configure Plugins</application> dialog is displayed. On the left is a list of all the plugins you have installed, while on the right is
- a description of the currently selected plugin. Plugins which have options which can be changed will have a sensitive <guibutton>Configure</guibutton>
- button on the right.</para>
- <para>To enable a plugin, simply select the checkbox to the left of its name in the plugin list, and the plugin will be loaded immediately. If
- there is any error loading the plugin, an error dialog will also be displayed immediately.</para>
- <para>To disable a plugin again, deselect its checkbox. Plugins will remain enabled or disabled as set even when <application>&app;</application> is
- closed.</para>
- </sect2>
- <sect2 id="totem-plugins-always-on-top">
- <title>Always on Top</title>
- <para>When enabled, the <guilabel>Always on Top</guilabel> plugin will force the main <application>&app;</application> window to be on top of
- all other windows while a movie is playing, but not while audio or visualizations are playing. To stop the window being on top, disable
- the plugin again.</para>
- </sect2>
- <sect2 id="totem-plugins-coherence">
- <title>Coherence DLNA/UPnP Client</title>
- <para>The <guilabel>Coherence DLNA/UPnP Client</guilabel> plugin allows <application>&app;</application> to play multimedia content from
- UPnP media servers (such as Coherence servers) on the local network.</para>
- <para>With the <guilabel>Coherence DLNA/UPnP Client</guilabel> plugin enabled, choose
- <menuchoice><shortcut><keycap>F9</keycap></shortcut><guimenu>View</guimenu><guimenuitem>Sidebar</guimenuitem></menuchoice> or click on the
- <guibutton>Sidebar</guibutton> button to show the sidebar. Select <guilabel>Coherence DLNA/UPnP Client</guilabel> from the drop-down list at the
- top of the sidebar to display the <guilabel>Coherence DLNA/UPnP Client</guilabel> sidebar.</para>
- <para>The tree view in the sidebar will list the available media servers. Clicking on one will expand it to show the types of media it can serve,
- and clicking on a media folder will expand it to list the media files available. Double-clicking on a media file will add it to
- <application>&app;</application>'s playlist and play it. You may alternatively right-click on a file and choose
- <menuchoice><guimenuitem>Play</guimenuitem></menuchoice> or <menuchoice><guimenuitem>Enqueue</guimenuitem></menuchoice> to play the file
- immediately or add it to the playlist, respectively.</para>
- <para>If the media server allows it, choosing <menuchoice><guimenuitem>Delete</guimenuitem></menuchoice> from a file's context menu allows you to
- delete that file from the media server.</para>
- </sect2>
- <sect2 id="totem-plugins-gromit">
- <title>Gromit Annotations</title>
- <para>The <guilabel>Gromit Annotations</guilabel> plugin allows you to draw on top of movies as they are played using
- <ulink type="http" url="http://www.home.unix-ag.org/simon/gromit/";><application>Gromit</application></ulink>. You must have
- <application>Gromit</application> installed before you can enable the plugin ? consult your operating system documentation for
- information on how to do this.</para>
- <para>With the plugin enabled, press <keycombo><keycap>Ctrl</keycap><keycap>D</keycap></keycombo> to toggle <application>Gromit</application>
- on or off. When <application>Gromit</application> is enabled, your pointer will change to a crosshair. To draw on the screen, hold down your
- mouse button and drag your pointer around, before releasing your mouse button. Press <keycombo><keycap>Ctrl</keycap><keycap>D</keycap></keycombo>
- again to toggle <application>Gromit</application> off.</para>
- <para>To clear the screen of annotations, press <keycombo><keycap>Ctrl</keycap><keycap>E</keycap></keycombo>, or close
- <application>&app;</application>.</para>
- </sect2>
- <sect2 id="totem-plugins-jamendo">
- <title>Jamendo</title>
- <para>The <guilabel>Jamendo</guilabel> plugin allows you to listen to the collection of Creative Commons-licensed music on the
- <ulink type="http" url="http://www.jamendo.com/en/";>Jamendo</ulink> service.</para>
- <sect3 id="totem-plugins-jamendo-configuration">
- <title>To Configure the Plugin</title>
- <para>The <guilabel>Jamendo</guilabel> plugin can be configured. Click on the <guibutton>Configure</guibutton> button when enabling the plugin,
- and the <application>Jamendo Plugin Configuration</application> dialog will be displayed. Here, you can choose whether to download songs in Ogg or
- MP3 format (Ogg is preferred due to its open-source nature); and the number of albums to retrieve when doing a search (choose more albums if
- you have a faster Internet connection).</para>
- <para>Once you're done, click <guibutton>OK</guibutton>.</para>
- </sect3>
- <sect3 id="totem-plugins-jamendo-setup">
- <title>To Display the Jamendo Sidebar</title>
- <para>With the <guilabel>Jamendo</guilabel> plugin enabled, choose
- <menuchoice><shortcut><keycap>F9</keycap></shortcut><guimenu>View</guimenu><guimenuitem>Sidebar</guimenuitem></menuchoice> or click on the
- <guibutton>Sidebar</guibutton> button to show the sidebar. Select <guilabel>Jamendo</guilabel> from the drop-down list at the top of the sidebar
- to display the <guilabel>Jamendo</guilabel> sidebar.</para>
- </sect3>
- <sect3 id="totem-plugins-jamendo-search">
- <title>To Search for Music</title>
- <para>Enter your search terms in the search entry at the top of the <guilabel>Jamendo</guilabel> sidebar. You can search by either artist or
- by tags. Click on the search button to start your search.</para>
- <para>Search results will be displayed in the tree view in the <guilabel>Search Results</guilabel> page of the sidebar, and can be browsed
- through using the arrow buttons at the bottom of the sidebar. Albums are listed, and if you click on an album, its tracks will be listed
- below it. Click again to hide the album's tracks.</para>
- <para>With an artist selected, you can click on the <guibutton>Jamendo Album Page</guibutton> button to open that album's page on the
- Jamendo website. Double-clicking an album, or choosing <menuchoice><guimenuitem>Add to Playlist</guimenuitem></menuchoice> from the album's
- context menu, will replace your playlist with all the tracks on that album and begin streaming the first track from Jamendo's website.
- Double-clicking an individual track will replace your playlist with just that track.</para>
- </sect3>
- <sect3 id="totem-plugins-jamendo-popular">
- <title>Popular Albums and Latest Releases</title>
- <para>Viewing the <guilabel>Popular</guilabel> page in the <guilabel>Jamendo</guilabel> sidebar will load a list of the most popular albums
- on Jamendo at the moment, which can be played as with search results. Viewing the <guilabel>Latest Releases</guilabel> page will likewise
- load a list of the latest albums released on Jamendo.</para>
- </sect3>
- </sect2>
- <sect2 id="totem-plugins-tracker">
- <title>Local Search</title>
- <para>The <guilabel>Local Search</guilabel> plugin allows you to search for playable movies and audio files on your computer from within
- <application>&app;</application>. With the plugin enabled, choose
- <menuchoice><shortcut><keycap>F9</keycap></shortcut><guimenu>View</guimenu><guimenuitem>Sidebar</guimenuitem></menuchoice> or click on the
- <guibutton>Sidebar</guibutton> button to show the sidebar. Select <guilabel>Local Search</guilabel> from the drop-down list at the top of the
- sidebar to display the <guilabel>Local Search</guilabel> sidebar.</para>
- <para>To perform a search, enter your search terms in the search entry at the top of the sidebar and click <guibutton>Find</guibutton>. Your
- search terms may include wildcards such as <literal>*</literal>, which will match any character. For example, the search
- <userinput>*.mpg</userinput> will find all movies with the <filename class="extension">.mpg</filename> file extension.</para>
- <para>Search results may be browsed using the <guibutton>Back</guibutton> and <guibutton>Forward</guibutton> buttons at the bottom of the
- sidebar, and you may jump to a specific results page by entering its number in the spin box.</para>
- </sect2>
- <sect2 id="totem-plugins-publish">
- <title>Publish Playlist</title>
- <para>The <guilabel>Publish Playlist</guilabel> plugin allows you to publish playlists on your local network to allow other computers to access
- and play them.</para>
- <sect3 id="totem-plugins-publish-configuration">
- <title>To Configure the Plugin</title>
- <para>The <guilabel>Publish Playlist</guilabel> plugin can be configured. Click on the <guibutton>Configure</guibutton> button when enabling the
- plugin, and the configuration dialog will be displayed. Here, you can change the name which will appear for your playlist share. The following
- strings will be replaced when playlists are published:
- <variablelist>
- <varlistentry>
- <term><literal>%a</literal></term>
- <listitem><para>Replaced with the program's name: <application>&app;</application>.</para></listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>%h</literal></term>
- <listitem><para>Replaced with your computer's host name.</para></listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>%u</literal></term>
- <listitem><para>Replaced with your username.</para></listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>%U</literal></term>
- <listitem><para>Replaced with your real name.</para></listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>%%</literal></term>
- <listitem><para>Replaced with a literal percent sign.</para></listitem>
- </varlistentry>
- </variablelist>
- </para>
- <para>You can also select the <guilabel>Use encrypted transport protocol</guilabel> checkbox if you wish to encrypt the shared playlists when
- they're transmitted over the network.</para>
- <para>Once you're done, click <guibutton>Close</guibutton>.</para>
- </sect3>
- <sect3 id="totem-plugins-publish-publishing">
- <title>To Publish Playlists</title>
- <para>With the plugin enabled, you do not need to explicitly publish playlists; they are automatically made available on the network as
- a Zeroconf website.</para>
- </sect3>
- <sect3 id="totem-plugins-publish-neighborhood">
- <title>To Browse your Neighborhood</title>
- <para>To view the shared playlists of others on your network, select <guilabel>Neighborhood</guilabel> from the drop-down list at the top of the
- sidebar. If any playlists have been published on the network, they will be listed here. Double-click on a playlist to load and play it on
- your computer.</para>
- </sect3>
- </sect2>
- <sect2 id="totem-plugins-opensubtitles">
- <title>Subtitle Downloader</title>
- <para>The <guilabel>Subtitle Downloader</guilabel> plugin allows you to find and download subtitle files from the
- <ulink type="http" url="http://www.opensubtitles.org/en";>OpenSubtitles</ulink> service.</para>
- <para>Subtitles can only be downloaded for local movies; not audio files, DVDs, DVB streams, VCDs or HTTP streams. To search for subtitles for
- the currently playing movie, choose <menuchoice><guimenu>View</guimenu><guimenuitem>Download Movie Subtitles</guimenuitem></menuchoice>, which
- will display the <application>Download Movie Subtitles</application> dialog.</para>
- <para>Select the language in which you wish to have your subtitles from the drop-down list at the top of the dialog, then click on the
- <guibutton>Find</guibutton> button to search for subtitles for the current movie. Subtitles are found on the basis of the movie's content,
- rather than its filename or tags.</para>
- <para>Search results are listed in the tree view in the middle of the dialog. Currently, subtitles can only be used with a movie by
- <emphasis>reloading</emphasis> the movie with the subtitles, so after selecting the subtitle file you wish to download, click on the
- <guibutton>Play with Subtitle</guibutton> button to download the subtitles and reload the movie.</para>
- <note><para>Downloaded subtitle files are cached (in <filename>~/.cache/totem/subtitles</filename>, by default) so that they do not need to be downloaded
- again when playing the movie again. When downloading new subtitles for a movie, any previously downloaded subtitles for that movie are deleted.</para></note>
- </sect2>
- <sect2 id="totem-plugins-thumbnail">
- <title>Thumbnail</title>
- <para>The <guilabel>Thumbnail</guilabel> plugin sets <application>&app;</application>'s main window icon to a thumbnail of the current movie,
- and updates the icon when new movies are loaded.</para>
- <note><para>If a thumbnail doesn't exist for the current movie (or if you're playing an audio file), the main window icon will be reset to the
- <application>&app;</application> logo.</para></note>
- </sect2>
- <sect2 id="totem-plugins-brasero">
- <title>Video Disc Recorder</title>
- <para>The <guilabel>Video Disc Recorder</guilabel> plugin allows you to burn the current playlist to a DVD or VCD using <application>Brasero</application>.</para>
- <para>To burn the current playlist, choose <menuchoice><guimenu>Movie</guimenu><guimenuitem>Create Video Disc</guimenuitem></menuchoice>.
- A <application>Brasero</application> dialog will be displayed, giving options for converting the movies to the appropriate format and burning them to disc. For more
- information, see the <ulink type="help" url="ghelp:brasero?brasero-new-project-video">Brasero documentation</ulink>.</para>
- </sect2>
- <sect2 id="totem-plugins-youtube">
- <title>YouTube Browser</title>
- <para>The <guilabel>YouTube Browser</guilabel> plugin allows you to search and browse
- <ulink type="http" url="http://www.youtube.com/";>YouTube</ulink>, and play YouTube videos directly in
- <application>&app;</application>. With the plugin enabled, choose
- <menuchoice><shortcut><keycap>F9</keycap></shortcut><guimenu>View</guimenu><guimenuitem>Sidebar</guimenuitem></menuchoice> or click on the
- <guibutton>Sidebar</guibutton> button to show the sidebar. Select <guilabel>YouTube</guilabel> from the drop-down list at the top of the
- sidebar to display the <guilabel>YouTube</guilabel> sidebar.</para>
- <para>To search for a YouTube video, enter your search terms in the entry at the top of the sidebar, then click <guibutton>Find</guibutton>.
- The search results will be listed in the tree view below. More results will be loaded automatically as you scroll down the list.</para>
- <para>To play a video, double-click it in the results list, or choose <menuchoice><guimenuitem>Add to Playlist</guimenuitem></menuchoice> from
- its context menu. When a video is played, a list of related videos will automatically be loaded in the <guilabel>Related Videos</guilabel>
- page of the <guilabel>YouTube</guilabel> sidebar.</para>
- <para>YouTube videos can be opened in a web browser by choosing <menuchoice><guimenuitem>Open in Web Browser</guimenuitem></menuchoice> from
- their context menu. This will open the video in its original location on the YouTube website.</para>
- </sect2>
- <sect2 id="totem-plugins-dbus-service">
- <title>D-Bus Service</title>
- <para>The <guilabel>D-Bus Service</guilabel> plugin broadcasts notifications of which track is playing in <application>&app;</application>
- on the D-Bus session bus. Applications such as <application>Gajim</application> can listen for such notifications and respond accordingly by,
- for example, updating your instant messaging status message to display the video currently being played in
- <application>&app;</application>.</para>
- </sect2>
- </sect1>
-
-<!-- =========== Usage ======================================= -->
-<!-- Use this section to describe how to customize the
- application. -->
- <sect1 id="totem-prefs">
- <title>Preferences</title>
- <para>To modify the preferences of <application>&app;</application>, choose
- <menuchoice>
- <guimenu>Edit</guimenu>
- <guimenuitem>Preferences</guimenuitem>
- </menuchoice>.</para>
-
- <sect2 id="totem-prefs-general">
- <title>General</title>
- <variablelist>
- <varlistentry>
- <term>Networking</term>
- <listitem>
- <para>Select network connection speed from the <guilabel>Connection speed</guilabel>
- drop-down list.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Text Subtitles</term>
- <listitem>
- <itemizedlist>
- <listitem>
- <para><guilabel>Automatically load subtitle files</guilabel>: select this option to automatically load any subtitle
- files with the same filename as a movie when the movie is loaded.</para>
- </listitem>
- <listitem>
- <para><guilabel>Font</guilabel>: select this option to change
- the font used to display subtitles.</para>
- </listitem>
- <listitem>
- <para><guilabel>Encoding</guilabel>: select this option to change the
- encoding used to display subtitles.</para>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
- </variablelist>
- </sect2>
- <sect2 id="totem-prefs-display">
- <title>Display</title>
- <variablelist>
- <varlistentry>
- <term>Display</term>
- <listitem>
- <itemizedlist>
- <listitem>
- <para>Select the resize option if you want <application>&app;</application>
- to automatically resize the window to the size of the video when a new video is loaded.
- </para>
- </listitem>
- <listitem>
- <para>Select the screensaver option if you want to allow the screensaver to activate when
- playing audio files. Some monitors with integrated speakers may stop playing music when the screensaver is activated.</para>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Visual Effects</term>
- <listitem>
- <itemizedlist>
- <listitem>
- <para><guilabel>Visual</guilabel>: select this option to show visual effects
- while an audio file is playing.
- </para>
- </listitem>
- <listitem>
- <para><guilabel>Type of visualization</guilabel>: select type of visualization from the
- drop-down list.
- </para>
- </listitem>
- <listitem>
- <para><guilabel>Visualization size</guilabel>: select visualization size from the
- drop-down list.
- </para>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>Color balance</term>
- <listitem>
- <itemizedlist>
- <listitem>
- <para><guilabel>Brightness</guilabel>: use the slider to specify the level of brightness.</para>
- </listitem>
- <listitem>
- <para><guilabel>Contrast</guilabel>: use the slider to specify the level of contrast.</para>
- </listitem>
- <listitem>
- <para><guilabel>Saturation</guilabel>: use the slider to specify the
- level of saturation.</para>
- </listitem>
- <listitem>
- <para><guilabel>Hue</guilabel>: use the slider to specify the level
- of hue.</para>
- </listitem>
- </itemizedlist>
- <tip><para>You may use the <guilabel>Reset to Defaults</guilabel> button to reset the color balance controls to their
- default positions.</para></tip>
- </listitem>
- </varlistentry>
- </variablelist>
- </sect2>
- <sect2 id="totem-prefs-audio">
- <title>Audio</title>
- <variablelist>
- <varlistentry>
- <term>Audio Output</term>
- <listitem>
- <para>Select audio output type from the <guilabel>Audio output type</guilabel>
- drop-down list.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </sect2>
- </sect1>
-
-<!-- ============= Bugs ================================== -->
-<!-- This section is optional and is commented out by default.
- You can use it to describe known bugs and limitations of the
- program if there are any - please be frank and list all
- problems you know of.
-
- <sect1 id="mayapp-bugs">
- <title>Known Bugs and Limitations</title>
- <para> </para>
- </sect1>
--->
-
-<!-- ============= About ================================== -->
-<!-- This section contains info about the program (not docs), such as
- author's name(s), web page, license, feedback address. This
- section is optional: primary place for this info is "About.." box of
- the program. However, if you do wish to include this info in the
- manual, this is the place to put it. Alternatively, you can put this information in the title page.-->
- <sect1 id="totem-about">
- <title>About <application>&app;</application></title>
- <para><application>&app;</application> is written by
- Bastien Nocera (<email>hadess hadess net</email>),
- Julien Moutte (<email>julien moutte net</email>) for the GStreamer backend,
- and Guenter Bartsch (<email>guenter users sourceforge net</email>).
- To find more information about <application>&app;</application>, please visit the
- <ulink url="http://projects.gnome.org/totem/"; type="http"><application>&app;</application>
- website</ulink>.
- </para>
- <para>
- To report a bug or make a suggestion regarding the <application>&app;</application> application or
- this manual, follow the directions in the
- <ulink url="ghelp:user-guide#feedback" type="help">GNOME Feedback Page</ulink>.
- </para>
- <para> This program is distributed under the terms of the GNU
- General Public license as published by the Free Software
- Foundation; either version 2 of the License, or (at your option)
- any later version. A copy of this license can be found at this
- <ulink url="ghelp:gpl" type="help">link</ulink>, or in the file
- COPYING included with the source code of this program. </para>
- </sect1>
-</article>
\ No newline at end of file
+<?xml version='1.0' encoding='UTF-8'?>
+<!-- This document was created with Syntext Serna Free. -->
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [
+ <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
+
+ <!-- name and version of the application -->
+ <!ENTITY prodname "<productname>Nautilus-Actions</productname>">
+ <!ENTITY appname "<application>Nautilus-Actions Configuration Tool</application>">
+ <!ENTITY appversion "3.0">
+
+ <!-- revision number and release date of this manual -->
+ <!ENTITY manrevision "3.0">
+ <!ENTITY mandate "August 2010">
+
+ <!ENTITY nautilus "<productname>Nautilus</productname>">
+
+ <!-- this is defined as an entity rather than a xi:include because
+ db2omf complains about missing author -->
+ <!ENTITY articleinfo SYSTEM "articleinfo.xml">
+ <!ENTITY legalnotice SYSTEM "legalnotice.xml">
+]>
+
+<!-- ========================= Document Header ======================== -->
+<!-- Please do not change the id!
+ For translations, change lang to appropriate code -->
+
+<article id="index" lang="en" xmlns:xi="http://www.w3.org/2003/XInclude";>
+
+ &articleinfo;
+
+ <xi:include href="appendix-gnu-fdl.xml" />
+ <xi:include href="appendix-feedback.xml" />
+
+ <indexterm zone="index">
+ <primary>&nautilus;</primary>
+ </indexterm>
+ <indexterm zone="index">
+ <primary>&prodname;</primary>
+ </indexterm>
+
+<!-- =========================== Document Body ======================== -->
+<!-- =========================== Introduction ========================= -->
+<!-- Use the Introduction section to give a brief overview of what
+ the application is and what it does. -->
+
+ <sect1 id="introduction">
+ <title>Introduction</title>
+ <para>
+ &prodname; is a &nautilus; extension which lets the user
+ define new actions in the file-manager context menus, and group them
+ into his own menus.
+ </para>
+ <para>
+ The &appname; application is the user interface which lets you precisely
+ configure how, where and when your actions should appear in &nautilus;
+ context menus, and how they will be executed.
+ </para>
+ <para>
+ &appname; provides the following features:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>Define and configure actions from scratch.</para>
+ </listitem>
+ <listitem>
+ <para>Organize actions into menus, submenus and so on.</para>
+ </listitem>
+ <listitem>
+ <para>Import and export actions and menus from and to outside world.</para>
+ </listitem>
+ </itemizedlist>
+ <note>
+ <para>
+ &prodname; also comes with additional features such as:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ A &nautilus; plugin which exports in real time to D-Bus the currently
+ selected files.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ A command-line program which is able to run any action.
+ </para>
+ <para>
+ Associated with the D-Bus interface, this program lets the user
+ run any action from a keyboard shortcut.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ A command-line program which is able to create a new action.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ All these features are more throughly described in the global
+ &prodname; documentation.
+ </para>
+ </note>
+ </sect1>
+
+<!-- ========================= Getting Started ======================== -->
+<!-- Use the Getting Started section to describe the steps required
+ to start the application and to describe the user interface components
+ of the application. If there is other information that it is important
+ for readers to know before they start using the application, you should
+ also include this information here.
+ If the information about how to get started is very short, you can
+ include it in the Introduction and omit this section. -->
+
+ <sect1 id="getting-started">
+ <title>Getting Started</title>
+ <sect2 id="starting">
+ <title>Starting &appname;</title>
+ <para>
+ You can start &appname; in the following ways:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term><guimenu>System</guimenu> menu</term>
+ <listitem>
+ <para>
+ Choose
+ <menuchoice>
+ <guisubmenu>Preferences</guisubmenu>
+ <guimenuitem>Look and Feel</guimenuitem>
+ </menuchoice>
+ .
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Command line</term>
+ <listitem>
+ <para>
+ To start &appname; from a command line, type the following command,
+ then press <keycap>Return</keycap>:
+ </para>
+ <para>
+ <command>nautilus-actions-config-tool</command>
+ </para>
+ <tip>
+ <para>
+ To view other command line options that are available,
+ type <command>totem --help</command>, then press <keycap>Return</keycap>.
+ </para>
+ </tip>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect2>
+ <sect2 id="when-start">
+ <title>The first run</title>
+ <para>
+ When you start &appname;, the following window is displayed.
+ </para>
+ <figure id="nact-FIG-main-empty">
+ <title>&appname; Start Up Window</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="figures/nact-main-empty.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase> Shows &appname; main window. Contains menubar, display area, an empty items list in the left, several disabled properties tab, and statusbar. </phrase>
+ </textobject>
+ <caption>
+ <para>The empty &appname; main window</para>
+ </caption>
+ </mediaobject>
+ </screenshot>
+ </figure>
+ <!-- Include any descriptions of the GUI immediately after the screenshot
+ of the main UI, for example, the items on the menubar and on the toolbar.
+ This section is optional. -->
+ <para>
+ The &appname; main window contains the following elements:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term>Menubar.</term>
+ <listitem>
+ <para>
+ The menus on the menubar contain all of the commands
+ you need to use in &appname;.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Items list.</term>
+ <listitem>
+ <para>
+ The list on the left of the main window contains all items,
+ whether they are actions or menus, currently available.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Properties tabs.</term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Statusbar.</term>
+ <listitem>
+ <para>
+ The statusbar displays some status informations about the
+ currently selected row in the items list.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect2>
+ </sect1>
+
+<!-- ============================== Usage ============================= -->
+<!-- Use this section to describe how to use the application to perform the
+ tasks for which the application is designed. -->
+
+ <sect1 id="usage">
+ <title>Using &appname;</title>
+
+<!-- ====================== Usage Subsection ========================== -->
+ <sect2 id="totem-open-file">
+ <title>To Open a File</title>
+ <para>To open a video or an audio file, choose
+ <menuchoice>
+ <shortcut>
+ <keycombo>
+ <keycap>Ctrl</keycap>
+ <keycap>O</keycap>
+ </keycombo>
+ </shortcut>
+ <guimenu>Movie</guimenu>
+ <guisubmenu>Open</guisubmenu>
+ </menuchoice>.
+ The <application>Select Movies or Playlists</application> dialog is displayed.
+ Select the file or files you want to open, then click
+ <guibutton>OK</guibutton>.
+ </para>
+ <para>You can drag a file from another application such as a file manager to the
+ <application>
+&appname; </application> window. If you drag the file to the display area, the file will replace the current
+ playlist and will start playing immediately. If you drag the file to the playlist in the sidebar, the file will be
+ appended to the current playlist. The <application>
+&appname; </application> application
+ will open the file and play the movie or song. <application>
+&appname; </application>
+ displays the title of the movie or song in the titlebar of
+ the window and in the playlist in the sidebar.
+ </para>
+ <para>If you try to open a file format that <application>
+&appname; </application> does
+ not recognize, the application displays an error message. This error is most often encountered
+ if you do not have the correct codecs installed. Information on getting codecs working can be found on
+ the <ulink url="http://projects.gnome.org/totem/#codecs"; type="http"><application>
+&appname; </application> website</ulink>.
+ </para>
+ <tip>
+ <para>You can double-click on a video or an audio file in the <application>Nautilus</application>
+ file manager to open it in the <application>
+&appname; </application> window.
+ </para>
+ </tip>
+ </sect2>
+
+ <sect2 id="totem-usage-open-location">
+ <title>To Open a Location</title>
+ <para>To open a file by URI (location), choose
+ <menuchoice>
+ <shortcut>
+ <keycombo>
+ <keycap>Ctrl</keycap>
+ <keycap>L</keycap>
+ </keycombo>
+ </shortcut>
+ <guimenu>Movie</guimenu>
+ <guimenuitem>Open Location</guimenuitem>
+ </menuchoice>. The <application>Open Location</application> dialog is displayed. Use the drop-down
+ combination box to specify the URI you would like to open (it lists URIs which have
+ previously been opened) â?? or type one in directly â?? then click on the <guibutton>Open</guibutton> button.
+ </para>
+ <para>If you have a URI in the clipboard already, it will automatically be pasted into the combination box.</para>
+ </sect2>
+
+ <sect2 id="totem-usage-play">
+ <title>To Play a Movie (DVD or VCD)</title>
+ <para>Insert the disc in the optical device of your computer, then choose
+ <menuchoice>
+ <guimenu>Movie</guimenu>
+ <guimenuitem>Play Disc</guimenuitem>
+ </menuchoice>.</para>
+ <para>To eject a DVD or VCD, choose
+ <menuchoice>
+ <shortcut>
+ <keycombo>
+ <keycap>Ctrl</keycap>
+ <keycap>E</keycap>
+ </keycombo>
+ </shortcut>
+ <guimenu>Movie</guimenu>
+ <guimenuitem>Eject</guimenuitem>
+ </menuchoice>.
+ </para>
+
+ </sect2>
+ <sect2 id="totem-usage-pause">
+ <title>To Pause a Movie or Song</title>
+ <para>To pause a movie or song that is playing, click on the
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="figures/totem_pause_button.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Shows pause button.</phrase>
+ </textobject>
+ </inlinemediaobject> button, or choose
+ <menuchoice>
+ <shortcut>
+ <keycombo>
+ <keycap>Ctrl</keycap>
+ <keycap>Space</keycap>
+ </keycombo>
+ </shortcut>
+ <guimenu>Movie</guimenu>
+ <guimenuitem>Play / Pause</guimenuitem>
+ </menuchoice>. You may also use the <keycap>P</keycap> key to pause or play a movie.
+ </para>
+ <para>To resume playing a movie or song, click on the
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="figures/totem_play_button.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Shows play button.</phrase>
+ </textobject>
+ </inlinemediaobject> button again, or choose
+ <menuchoice>
+ <shortcut>
+ <keycombo>
+ <keycap>Ctrl</keycap>
+ <keycap>Space</keycap>
+ </keycombo>
+ </shortcut>
+ <guimenu>Movie</guimenu>
+ <guimenuitem>Play / Pause</guimenuitem>
+ </menuchoice>.
+ </para>
+ </sect2>
+
+ <sect2 id="totem-usage-view-properties">
+ <title>To View Properties of a Movie or Song</title>
+ <para>To view the properties of a movie or song, choose
+ <menuchoice>
+ <guimenu>View</guimenu>
+ <guimenuitem>Sidebar</guimenuitem>
+ </menuchoice> to make the sidebar
+ appear, and choose <guimenu>Properties</guimenu> in the drop-down list at the top of the sidebar.</para>
+ </sect2>
+
+ <sect2 id="totem-usage-seek">
+ <title>To Seek Through Movies or Songs</title>
+ <para>To seek through movies or songs, you can use the following methods:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term>To skip forward</term>
+ <listitem>
+ <para>To skip forward through a movie or song, choose
+ <menuchoice>
+ <shortcut>
+ <keycap>Right</keycap>
+ </shortcut>
+ <guimenu>Go</guimenu>
+ <guimenuitem>Skip Forward</guimenuitem>
+ </menuchoice>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>To skip backward</term>
+ <listitem>
+ <para>To skip backwards through a movie or song, choose
+ <menuchoice>
+ <shortcut>
+ <keycap>Left</keycap>
+ </shortcut>
+ <guimenu>Go</guimenu>
+ <guimenuitem>Skip Backwards</guimenuitem>
+ </menuchoice>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>To skip to a time</term>
+ <listitem>
+ <para>To skip to a specific elapsed time in the movie or song, choose
+ <menuchoice>
+ <shortcut>
+ <keycombo>
+ <keycap>Ctrl</keycap>
+ <keycap>K</keycap>
+ </keycombo>
+ </shortcut>
+ <guimenu>Go</guimenu>
+ <guimenuitem>Skip to</guimenuitem>
+ </menuchoice>. The <application>Skip to</application> dialog is displayed. Use the
+ spin box to specify the elapsed time (in seconds) to skip to, then
+ click <guibutton>OK</guibutton>.
+ </para>
+ <para>The spin box also allows more natural language to be used. You can enter a time in the
+ formats "hh:mm:ss", "mm:ss" or "ss"; where "hh" is the hour, "mm" is the minute and "ss" is the
+ second to skip to.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>To move to the next movie or song</term>
+ <listitem>
+ <para>To move to the next movie or song, choose
+ <menuchoice>
+ <shortcut>
+ <keycombo>
+ <keycap>Alt</keycap>
+ <keycap>Right</keycap>
+ </keycombo>
+ </shortcut>
+ <guimenu>Go</guimenu>
+ <guimenuitem>Next Chapter/Movie</guimenuitem>
+ </menuchoice> or click on the
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="figures/totem_next_button.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Shows a seek next button</phrase>
+ </textobject>
+ </inlinemediaobject> button.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>To move to the previous movie or song</term>
+ <listitem>
+ <para>To move to the previous movie or song, choose
+ <menuchoice>
+ <shortcut>
+ <keycombo>
+ <keycap>Alt</keycap>
+ <keycap>Left</keycap>
+ </keycombo>
+ </shortcut>
+ <guimenu>Go</guimenu>
+ <guimenuitem>Previous Chapter/Movie</guimenuitem>
+ </menuchoice> or click on the
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="figures/totem_previous_button.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Shows a seek previous button</phrase>
+ </textobject>
+ </inlinemediaobject> button.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect2>
+
+ <sect2 id="totem-usage-change-zoom">
+ <title>To Change the Zoom Factor</title>
+ <sect3 id="totem-usage-change-size">
+ <title>To Change the Video Size</title>
+ <para>To change the zoom factor of the display area, you can use the
+ following methods:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>To zoom to fullscreen mode, choose
+ <menuchoice>
+ <shortcut>
+ <keycap>F11</keycap>
+ </shortcut>
+ <guimenu>View</guimenu>
+ <guimenuitem>Fullscreen</guimenuitem>
+ </menuchoice>. You can also
+ use the <keycap>F</keycap> key to toggle fullscreen mode.
+ To exit fullscreen mode, click on the
+ <guibutton>Leave Fullscreen</guibutton> button or press
+ <keycap>Esc</keycap>, <keycap>F11</keycap> or <keycap>F</keycap>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>To change the size of the original movie or visualization,
+ choose
+ <menuchoice>
+ <shortcut>
+ <keycombo>
+ <keycap>Ctrl</keycap>
+ <keycap>0</keycap>
+ </keycombo>
+ </shortcut>
+ <guimenu>View</guimenu>
+ <guimenuitem>Fit Window to Movie</guimenuitem>
+ </menuchoice> and choose a scale ratio.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </sect3>
+ <sect3 id="totem-usage-change-ratio">
+ <title>To Change the Video Aspect Ratio</title>
+ <para>To switch between different aspect ratios, choose
+ <menuchoice>
+ <shortcut>
+ <keycap>A</keycap>
+ </shortcut>
+ <guimenu>View</guimenu>
+ <guisubmenu>Aspect Ratio</guisubmenu>
+ </menuchoice>.</para>
+ </sect3>
+ </sect2>
+ <sect2 id="totem-usage-adjust-volume">
+ <title>To Adjust the Volume</title>
+ <para>To increase the volume, choose
+ <menuchoice>
+ <shortcut>
+ <keycap>Up</keycap>
+ </shortcut>
+ <guimenu>Sound</guimenu>
+ <guimenuitem>Volume Up</guimenuitem>
+ </menuchoice>.
+ To decrease the volume, choose
+ <menuchoice>
+ <shortcut>
+ <keycap>Down</keycap>
+ </shortcut>
+ <guimenu>Sound</guimenu>
+ <guimenuitem>Volume Down</guimenuitem>
+ </menuchoice>.
+ </para>
+ <para>You can also use the volume button: click on the volume button and choose the volume level with the slider.</para>
+ </sect2>
+ <sect2 id="totem-usage-on-top">
+ <title>To Make the Window Always on Top</title>
+ <para>To make the <application>
+&appname; </application> window always on top of other application windows,
+ choose
+ <menuchoice>
+ <guimenu>Edit</guimenu>
+ <guimenuitem>Plugins</guimenuitem>
+ </menuchoice>. Select the <guilabel>Always on Top</guilabel> plugin to enable it. The <application>
+&appname; </application> window will now stay on
+ top of all other windows while a movie is playing, but not while audio or visualizations are playing.
+ </para>
+ <para>To stop the window from always being on top, disable the <guilabel>Always on Top</guilabel> plugin again.
+ See <xref linkend="totem-plugins-always-on-top"/> for more information.</para>
+ </sect2>
+ <sect2 id="totem-usage-show-control">
+ <title>To Show or Hide Controls</title>
+ <para>To show or hide the <application>
+&appname; </application> window controls, choose
+ <menuchoice>
+ <shortcut>
+ <keycombo>
+ <keycap>Ctrl</keycap>
+ <keycap>H</keycap>
+ </keycombo>
+ </shortcut>
+ <guimenu>View</guimenu>
+ <guimenuitem>Show Controls</guimenuitem>
+ </menuchoice>, or press the <keycap>H</keycap> key.
+ You can also right-click on the <application>
+&appname; </application> window, then choose
+ <menuchoice>
+ <shortcut>
+ <keycombo>
+ <keycap>Ctrl</keycap>
+ <keycap>H</keycap>
+ </keycombo>
+ </shortcut>
+ <guimenuitem>Show Controls</guimenuitem>
+ </menuchoice> from the popup menu.
+ </para>
+ <para>If the <guilabel>Show Controls</guilabel> option is selected,
+ <application>
+&appname; </application> will show the menubar, elapsed time slider,
+ seek control buttons, volume slider and statusbar on the window. If
+ the <guilabel>Show Controls</guilabel> option is unselected, the application
+ will hide these controls and show only the display area.
+ </para>
+ </sect2>
+ <sect2 id="totem-usage-playlist">
+ <title>To Manage the Playlist</title>
+ <sect3 id="totem-usage-playlist-show-hide">
+ <title>To Show or Hide the Playlist</title>
+ <para>To show or hide the playlist, choose
+ <menuchoice>
+ <guimenu>View</guimenu>
+ <guimenuitem>Sidebar</guimenuitem>
+ </menuchoice> or click on the <guibutton>Sidebar</guibutton> button, and
+ choose <guimenu>Playlist</guimenu> on the top of
+ the sidebar.</para>
+ </sect3>
+ <sect3 id="totem-usage-playlist-manage">
+ <title>Manage a Playlist</title>
+ <para>You can use the <application>Playlist</application> dialog to do the following:
+ <variablelist>
+ <varlistentry>
+ <term>To add a track or movie</term>
+ <listitem>
+ <para>To add a track or movie to the playlist, click on the <guibutton>Add</guibutton>
+ button. The <application>Select Movies or Playlists</application> dialog is displayed. Select the file that you
+ want to add to the playlist, then click <guibutton>Add</guibutton>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>To remove a track or movie</term>
+ <listitem>
+ <para>To remove a track or movie from the playlist, select the item or items to remove from the
+ playlist, then click on the <guibutton>Remove</guibutton> button.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>To save the playlist to a file</term>
+ <listitem>
+ <para>To save the playlist to a file, click on the <guibutton>Save Playlist</guibutton>
+ button. The <application>Save Playlist</application> dialog is displayed; specify
+ the filename as which you want to save the playlist, and click <guibutton>Save</guibutton>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>To move a track or movie up the playlist</term>
+ <listitem>
+ <para>To move a track or movie up the playlist, select the item from the
+ playlist, then click on the <guibutton>Move Up</guibutton> button.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>To move a track or movie down the playlist</term>
+ <listitem>
+ <para>To move a track or movie down the playlist, select the item from the
+ playlist, then click on the <guibutton>Move Down</guibutton> button.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </sect3>
+ <sect3 id="totem-usage-playlist-repeat">
+ <title>To Select or Unselect Repeat Mode</title>
+ <para>To enable or disable repeat mode, choose
+ <menuchoice>
+ <guimenu>Edit</guimenu>
+ <guimenuitem>Repeat Mode</guimenuitem>
+ </menuchoice>.
+ </para>
+ </sect3>
+ <sect3 id="totem-usage-playlist-shuffle">
+ <title>To Select or Unselect Shuffle Mode</title>
+ <para>To enable or disable shuffle mode, choose
+ <menuchoice>
+ <guimenu>Edit</guimenu>
+ <guimenuitem>Shuffle Mode</guimenuitem>
+ </menuchoice>.
+ </para>
+ </sect3>
+ </sect2>
+ <sect2 id="totem-usage-subtitle">
+ <title>To Choose Subtitles</title>
+ <para>To choose
+ the language of the subtitles, select
+ <menuchoice>
+ <guimenu>View</guimenu>
+ <guisubmenu>Subtitles</guisubmenu>
+ </menuchoice>
+ and choose the subtitle language you want to display.</para>
+ <para>To disable the display of subtitles, select
+ <menuchoice>
+ <guimenu>View</guimenu>
+ <guisubmenu>Subtitles</guisubmenu>
+ <guimenuitem>None</guimenuitem>
+ </menuchoice>.</para>
+ <note>
+ <para>By default, <application>
+&appname; </application> will choose the same language for the
+ subtitles as the one you normally use on your computer.</para>
+ </note>
+ <para><application>
+&appname; </application> will automatically load and display subtitles for a video if it finds a subtitle file with the
+ same name as the video being played, and the extension <filename class="extension">asc</filename>, <filename class="extension">txt</filename>,
+ <filename class="extension">sub</filename>, <filename class="extension">srt</filename>, <filename class="extension">smi</filename>,
+ <filename class="extension">ssa</filename> or <filename class="extension">ass</filename>.
+ </para>
+ <para>If the file containing the subtitles has a different name from the video being played, you can
+ right-click on the video in the playlist and choose <menuchoice>
+ <guimenuitem>Select Text Subtitles</guimenuitem>
+ </menuchoice>
+ from the popup menu to load the correct subtitle file. You may also choose subtitles by choosing
+ <menuchoice>
+ <guimenu>View</guimenu>
+ <guimenuitem>Select Text Subtitles</guimenuitem>
+ </menuchoice>.</para>
+ <para>Using the <guilabel>Subtitle Downloader</guilabel> plugin, you can also download subtitles from the OpenSubtitles service. See
+ <xref linkend="totem-plugins-opensubtitles"/> for more information.</para>
+ </sect2>
+ <sect2 id="totem-usage-take-screenshot">
+ <title>To Take a Screenshot</title>
+ <para>To take a screenshot of the movie or visualization that is playing, choose
+ <menuchoice>
+ <guimenu>Edit</guimenu>
+ <guimenuitem>Take Screenshot</guimenuitem>
+ </menuchoice>. The <application>Save Screenshot</application> dialog is displayed. Choose a location and
+ insert the filename as which you want to save the screenshot, then click on the <guibutton>Save</guibutton> button
+ to save the screenshot.
+ </para>
+ <tip>
+ <para><application>
+&appname; </application> will display a preview of the screenshot which is to be saved on the left-hand side of the <application>Save Screenshot</application> dialog.</para>
+ </tip>
+ </sect2>
+ <sect2 id="totem-usage-create-screenshot-gallery">
+ <title>To Create a Screenshot Gallery</title>
+ <para>To create a gallery of screenshots of the movie or visualization that is playing, choose
+ <menuchoice>
+ <guimenu>Edit</guimenu>
+ <guimenuitem>Create Screenshot Gallery</guimenuitem>
+ </menuchoice>. The <application>Save Gallery</application> dialog is displayed. Choose a location and
+ insert the filename as which you want to save the gallery image, then click on the <guibutton>Save</guibutton> button
+ to save the screenshot.
+ </para>
+ <tip>
+ <para>You may specify the width of the individual screenshots in the gallery using the <guilabel>Screenshot width</guilabel> entry.
+ The default width is 128 pixels.</para>
+ <para>You may also specify the number of screenshots to be put in the gallery. By default, this is calculated based on the length of the movie;
+ however, this may be overridden by deselecting the <guilabel>Calculate the number of screenshots</guilabel> checkbox and entering the new
+ number in the <guilabel>Number of screenshots</guilabel> spin box.</para>
+ </tip>
+ </sect2>
+ </sect1>
+<!-- =========================== Plugins ============================== --> <sect1 id="totem-plugins">
+ <title>Plugins</title>
+ <para><application>
+&appname; </application> has many features which are present in the form of plugins � pieces of the software which are only loaded
+ if necessary.</para>
+ <sect2 id="totem-plugins-load">
+ <title>To Enable a Plugin</title>
+ <para>To view the list of installed plugins, choose <menuchoice>
+ <guimenu>Edit</guimenu>
+ <guimenuitem>Plugins</guimenuitem>
+ </menuchoice>. The
+ <application>Configure Plugins</application> dialog is displayed. On the left is a list of all the plugins you have installed, while on the right is
+ a description of the currently selected plugin. Plugins which have options which can be changed will have a sensitive <guibutton>Configure</guibutton>
+ button on the right.</para>
+ <para>To enable a plugin, simply select the checkbox to the left of its name in the plugin list, and the plugin will be loaded immediately. If
+ there is any error loading the plugin, an error dialog will also be displayed immediately.</para>
+ <para>To disable a plugin again, deselect its checkbox. Plugins will remain enabled or disabled as set even when <application>
+&appname; </application> is
+ closed.</para>
+ </sect2>
+ <sect2 id="totem-plugins-always-on-top">
+ <title>Always on Top</title>
+ <para>When enabled, the <guilabel>Always on Top</guilabel> plugin will force the main <application>
+&appname; </application> window to be on top of
+ all other windows while a movie is playing, but not while audio or visualizations are playing. To stop the window being on top, disable
+ the plugin again.</para>
+ </sect2>
+ <sect2 id="totem-plugins-coherence">
+ <title>Coherence DLNA/UPnP Client</title>
+ <para>The <guilabel>Coherence DLNA/UPnP Client</guilabel> plugin allows <application>
+&appname; </application> to play multimedia content from
+ UPnP media servers (such as Coherence servers) on the local network.</para>
+ <para>With the <guilabel>Coherence DLNA/UPnP Client</guilabel> plugin enabled, choose
+ <menuchoice>
+ <shortcut>
+ <keycap>F9</keycap>
+ </shortcut>
+ <guimenu>View</guimenu>
+ <guimenuitem>Sidebar</guimenuitem>
+ </menuchoice> or click on the
+ <guibutton>Sidebar</guibutton> button to show the sidebar. Select <guilabel>Coherence DLNA/UPnP Client</guilabel> from the drop-down list at the
+ top of the sidebar to display the <guilabel>Coherence DLNA/UPnP Client</guilabel> sidebar.</para>
+ <para>The tree view in the sidebar will list the available media servers. Clicking on one will expand it to show the types of media it can serve,
+ and clicking on a media folder will expand it to list the media files available. Double-clicking on a media file will add it to
+ <application>
+&appname; </application>'s playlist and play it. You may alternatively right-click on a file and choose
+ <menuchoice>
+ <guimenuitem>Play</guimenuitem>
+ </menuchoice> or <menuchoice>
+ <guimenuitem>Enqueue</guimenuitem>
+ </menuchoice> to play the file
+ immediately or add it to the playlist, respectively.</para>
+ <para>If the media server allows it, choosing <menuchoice>
+ <guimenuitem>Delete</guimenuitem>
+ </menuchoice> from a file's context menu allows you to
+ delete that file from the media server.</para>
+ </sect2>
+ <sect2 id="totem-plugins-gromit">
+ <title>Gromit Annotations</title>
+ <para>The <guilabel>Gromit Annotations</guilabel> plugin allows you to draw on top of movies as they are played using
+ <ulink url="http://www.home.unix-ag.org/simon/gromit/"; type="http">
+ <application>Gromit</application>
+ </ulink>. You must have
+ <application>Gromit</application> installed before you can enable the plugin � consult your operating system documentation for
+ information on how to do this.</para>
+ <para>With the plugin enabled, press <keycombo>
+ <keycap>Ctrl</keycap>
+ <keycap>D</keycap>
+ </keycombo> to toggle <application>Gromit</application>
+ on or off. When <application>Gromit</application> is enabled, your pointer will change to a crosshair. To draw on the screen, hold down your
+ mouse button and drag your pointer around, before releasing your mouse button. Press <keycombo>
+ <keycap>Ctrl</keycap>
+ <keycap>D</keycap>
+ </keycombo>
+ again to toggle <application>Gromit</application> off.</para>
+ <para>To clear the screen of annotations, press <keycombo>
+ <keycap>Ctrl</keycap>
+ <keycap>E</keycap>
+ </keycombo>, or close
+ <application>
+&appname; </application>.</para>
+ </sect2>
+ <sect2 id="totem-plugins-jamendo">
+ <title>Jamendo</title>
+ <para>The <guilabel>Jamendo</guilabel> plugin allows you to listen to the collection of Creative Commons-licensed music on the
+ <ulink url="http://www.jamendo.com/en/"; type="http">Jamendo</ulink> service.</para>
+ <sect3 id="totem-plugins-jamendo-configuration">
+ <title>To Configure the Plugin</title>
+ <para>The <guilabel>Jamendo</guilabel> plugin can be configured. Click on the <guibutton>Configure</guibutton> button when enabling the plugin,
+ and the <application>Jamendo Plugin Configuration</application> dialog will be displayed. Here, you can choose whether to download songs in Ogg or
+ MP3 format (Ogg is preferred due to its open-source nature); and the number of albums to retrieve when doing a search (choose more albums if
+ you have a faster Internet connection).</para>
+ <para>Once you're done, click <guibutton>OK</guibutton>.</para>
+ </sect3>
+ <sect3 id="totem-plugins-jamendo-setup">
+ <title>To Display the Jamendo Sidebar</title>
+ <para>With the <guilabel>Jamendo</guilabel> plugin enabled, choose
+ <menuchoice>
+ <shortcut>
+ <keycap>F9</keycap>
+ </shortcut>
+ <guimenu>View</guimenu>
+ <guimenuitem>Sidebar</guimenuitem>
+ </menuchoice> or click on the
+ <guibutton>Sidebar</guibutton> button to show the sidebar. Select <guilabel>Jamendo</guilabel> from the drop-down list at the top of the sidebar
+ to display the <guilabel>Jamendo</guilabel> sidebar.</para>
+ </sect3>
+ <sect3 id="totem-plugins-jamendo-search">
+ <title>To Search for Music</title>
+ <para>Enter your search terms in the search entry at the top of the <guilabel>Jamendo</guilabel> sidebar. You can search by either artist or
+ by tags. Click on the search button to start your search.</para>
+ <para>Search results will be displayed in the tree view in the <guilabel>Search Results</guilabel> page of the sidebar, and can be browsed
+ through using the arrow buttons at the bottom of the sidebar. Albums are listed, and if you click on an album, its tracks will be listed
+ below it. Click again to hide the album's tracks.</para>
+ <para>With an artist selected, you can click on the <guibutton>Jamendo Album Page</guibutton> button to open that album's page on the
+ Jamendo website. Double-clicking an album, or choosing <menuchoice>
+ <guimenuitem>Add to Playlist</guimenuitem>
+ </menuchoice> from the album's
+ context menu, will replace your playlist with all the tracks on that album and begin streaming the first track from Jamendo's website.
+ Double-clicking an individual track will replace your playlist with just that track.</para>
+ </sect3>
+ <sect3 id="totem-plugins-jamendo-popular">
+ <title>Popular Albums and Latest Releases</title>
+ <para>Viewing the <guilabel>Popular</guilabel> page in the <guilabel>Jamendo</guilabel> sidebar will load a list of the most popular albums
+ on Jamendo at the moment, which can be played as with search results. Viewing the <guilabel>Latest Releases</guilabel> page will likewise
+ load a list of the latest albums released on Jamendo.</para>
+ </sect3>
+ </sect2>
+ <sect2 id="totem-plugins-tracker">
+ <title>Local Search</title>
+ <para>The <guilabel>Local Search</guilabel> plugin allows you to search for playable movies and audio files on your computer from within
+ <application>
+&appname; </application>. With the plugin enabled, choose
+ <menuchoice>
+ <shortcut>
+ <keycap>F9</keycap>
+ </shortcut>
+ <guimenu>View</guimenu>
+ <guimenuitem>Sidebar</guimenuitem>
+ </menuchoice> or click on the
+ <guibutton>Sidebar</guibutton> button to show the sidebar. Select <guilabel>Local Search</guilabel> from the drop-down list at the top of the
+ sidebar to display the <guilabel>Local Search</guilabel> sidebar.</para>
+ <para>To perform a search, enter your search terms in the search entry at the top of the sidebar and click <guibutton>Find</guibutton>. Your
+ search terms may include wildcards such as <literal>*</literal>, which will match any character. For example, the search
+ <userinput>*.mpg</userinput> will find all movies with the <filename class="extension">.mpg</filename> file extension.</para>
+ <para>Search results may be browsed using the <guibutton>Back</guibutton> and <guibutton>Forward</guibutton> buttons at the bottom of the
+ sidebar, and you may jump to a specific results page by entering its number in the spin box.</para>
+ </sect2>
+ <sect2 id="totem-plugins-publish">
+ <title>Publish Playlist</title>
+ <para>The <guilabel>Publish Playlist</guilabel> plugin allows you to publish playlists on your local network to allow other computers to access
+ and play them.</para>
+ <sect3 id="totem-plugins-publish-configuration">
+ <title>To Configure the Plugin</title>
+ <para>The <guilabel>Publish Playlist</guilabel> plugin can be configured. Click on the <guibutton>Configure</guibutton> button when enabling the
+ plugin, and the configuration dialog will be displayed. Here, you can change the name which will appear for your playlist share. The following
+ strings will be replaced when playlists are published:
+ <variablelist>
+ <varlistentry>
+ <term>
+ <literal>%a</literal>
+ </term>
+ <listitem>
+ <para>Replaced with the program's name: <application>
+&appname; </application>.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <literal>%h</literal>
+ </term>
+ <listitem>
+ <para>Replaced with your computer's host name.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <literal>%u</literal>
+ </term>
+ <listitem>
+ <para>Replaced with your username.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <literal>%U</literal>
+ </term>
+ <listitem>
+ <para>Replaced with your real name.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <literal>%%</literal>
+ </term>
+ <listitem>
+ <para>Replaced with a literal percent sign.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ <para>You can also select the <guilabel>Use encrypted transport protocol</guilabel> checkbox if you wish to encrypt the shared playlists when
+ they're transmitted over the network.</para>
+ <para>Once you're done, click <guibutton>Close</guibutton>.</para>
+ </sect3>
+ <sect3 id="totem-plugins-publish-publishing">
+ <title>To Publish Playlists</title>
+ <para>With the plugin enabled, you do not need to explicitly publish playlists; they are automatically made available on the network as
+ a Zeroconf website.</para>
+ </sect3>
+ <sect3 id="totem-plugins-publish-neighborhood">
+ <title>To Browse your Neighborhood</title>
+ <para>To view the shared playlists of others on your network, select <guilabel>Neighborhood</guilabel> from the drop-down list at the top of the
+ sidebar. If any playlists have been published on the network, they will be listed here. Double-click on a playlist to load and play it on
+ your computer.</para>
+ </sect3>
+ </sect2>
+ <sect2 id="totem-plugins-opensubtitles">
+ <title>Subtitle Downloader</title>
+ <para>The <guilabel>Subtitle Downloader</guilabel> plugin allows you to find and download subtitle files from the
+ <ulink url="http://www.opensubtitles.org/en"; type="http">OpenSubtitles</ulink> service.</para>
+ <para>Subtitles can only be downloaded for local movies; not audio files, DVDs, DVB streams, VCDs or HTTP streams. To search for subtitles for
+ the currently playing movie, choose <menuchoice>
+ <guimenu>View</guimenu>
+ <guimenuitem>Download Movie Subtitles</guimenuitem>
+ </menuchoice>, which
+ will display the <application>Download Movie Subtitles</application> dialog.</para>
+ <para>Select the language in which you wish to have your subtitles from the drop-down list at the top of the dialog, then click on the
+ <guibutton>Find</guibutton> button to search for subtitles for the current movie. Subtitles are found on the basis of the movie's content,
+ rather than its filename or tags.</para>
+ <para>Search results are listed in the tree view in the middle of the dialog. Currently, subtitles can only be used with a movie by
+ <emphasis>reloading</emphasis> the movie with the subtitles, so after selecting the subtitle file you wish to download, click on the
+ <guibutton>Play with Subtitle</guibutton> button to download the subtitles and reload the movie.</para>
+ <note>
+ <para>Downloaded subtitle files are cached (in <filename>~/.cache/totem/subtitles</filename>, by default) so that they do not need to be downloaded
+ again when playing the movie again. When downloading new subtitles for a movie, any previously downloaded subtitles for that movie are deleted.</para>
+ </note>
+ </sect2>
+ <sect2 id="totem-plugins-thumbnail">
+ <title>Thumbnail</title>
+ <para>The <guilabel>Thumbnail</guilabel> plugin sets <application>
+&appname; </application>'s main window icon to a thumbnail of the current movie,
+ and updates the icon when new movies are loaded.</para>
+ <note>
+ <para>If a thumbnail doesn't exist for the current movie (or if you're playing an audio file), the main window icon will be reset to the
+ <application>
+&appname; </application> logo.</para>
+ </note>
+ </sect2>
+ <sect2 id="totem-plugins-brasero">
+ <title>Video Disc Recorder</title>
+ <para>The <guilabel>Video Disc Recorder</guilabel> plugin allows you to burn the current playlist to a DVD or VCD using <application>Brasero</application>.</para>
+ <para>To burn the current playlist, choose <menuchoice>
+ <guimenu>Movie</guimenu>
+ <guimenuitem>Create Video Disc</guimenuitem>
+ </menuchoice>.
+ A <application>Brasero</application> dialog will be displayed, giving options for converting the movies to the appropriate format and burning them to disc. For more
+ information, see the <ulink url="ghelp:brasero?brasero-new-project-video" type="help">Brasero documentation</ulink>.</para>
+ </sect2>
+ <sect2 id="totem-plugins-youtube">
+ <title>YouTube Browser</title>
+ <para>The <guilabel>YouTube Browser</guilabel> plugin allows you to search and browse
+ <ulink url="http://www.youtube.com/"; type="http">YouTube</ulink>, and play YouTube videos directly in
+ <application>
+&appname; </application>. With the plugin enabled, choose
+ <menuchoice>
+ <shortcut>
+ <keycap>F9</keycap>
+ </shortcut>
+ <guimenu>View</guimenu>
+ <guimenuitem>Sidebar</guimenuitem>
+ </menuchoice> or click on the
+ <guibutton>Sidebar</guibutton> button to show the sidebar. Select <guilabel>YouTube</guilabel> from the drop-down list at the top of the
+ sidebar to display the <guilabel>YouTube</guilabel> sidebar.</para>
+ <para>To search for a YouTube video, enter your search terms in the entry at the top of the sidebar, then click <guibutton>Find</guibutton>.
+ The search results will be listed in the tree view below. More results will be loaded automatically as you scroll down the list.</para>
+ <para>To play a video, double-click it in the results list, or choose <menuchoice>
+ <guimenuitem>Add to Playlist</guimenuitem>
+ </menuchoice> from
+ its context menu. When a video is played, a list of related videos will automatically be loaded in the <guilabel>Related Videos</guilabel>
+ page of the <guilabel>YouTube</guilabel> sidebar.</para>
+ <para>YouTube videos can be opened in a web browser by choosing <menuchoice>
+ <guimenuitem>Open in Web Browser</guimenuitem>
+ </menuchoice> from
+ their context menu. This will open the video in its original location on the YouTube website.</para>
+ </sect2>
+ <sect2 id="totem-plugins-dbus-service">
+ <title>D-Bus Service</title>
+ <para>The <guilabel>D-Bus Service</guilabel> plugin broadcasts notifications of which track is playing in <application>
+&appname; </application>
+ on the D-Bus session bus. Applications such as <application>Gajim</application> can listen for such notifications and respond accordingly by,
+ for example, updating your instant messaging status message to display the video currently being played in
+ <application>
+&appname; </application>.</para>
+ </sect2>
+ </sect1>
+<!-- ========================= Usage ================================== --><!-- Use this section to describe how to customize the application. --> <sect1 id="totem-prefs">
+ <title>Preferences</title>
+ <para>To modify the preferences of <application>
+&appname; </application>, choose
+ <menuchoice>
+ <guimenu>Edit</guimenu>
+ <guimenuitem>Preferences</guimenuitem>
+ </menuchoice>.</para>
+ <sect2 id="totem-prefs-general">
+ <title>General</title>
+ <variablelist>
+ <varlistentry>
+ <term>Networking</term>
+ <listitem>
+ <para>Select network connection speed from the <guilabel>Connection speed</guilabel>
+ drop-down list.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Text Subtitles</term>
+ <listitem>
+ <itemizedlist>
+ <listitem>
+ <para><guilabel>Automatically load subtitle files</guilabel>: select this option to automatically load any subtitle
+ files with the same filename as a movie when the movie is loaded.</para>
+ </listitem>
+ <listitem>
+ <para><guilabel>Font</guilabel>: select this option to change
+ the font used to display subtitles.</para>
+ </listitem>
+ <listitem>
+ <para><guilabel>Encoding</guilabel>: select this option to change the
+ encoding used to display subtitles.</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect2>
+ <sect2 id="totem-prefs-display">
+ <title>Display</title>
+ <variablelist>
+ <varlistentry>
+ <term>Display</term>
+ <listitem>
+ <itemizedlist>
+ <listitem>
+ <para>Select the resize option if you want <application>
+&appname; </application>
+ to automatically resize the window to the size of the video when a new video is loaded.
+ </para>
+ </listitem>
+ <listitem>
+ <para>Select the screensaver option if you want to allow the screensaver to activate when
+ playing audio files. Some monitors with integrated speakers may stop playing music when the screensaver is activated.</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Visual Effects</term>
+ <listitem>
+ <itemizedlist>
+ <listitem>
+ <para><guilabel>Visual</guilabel>: select this option to show visual effects
+ while an audio file is playing.
+ </para>
+ </listitem>
+ <listitem>
+ <para><guilabel>Type of visualization</guilabel>: select type of visualization from the
+ drop-down list.
+ </para>
+ </listitem>
+ <listitem>
+ <para><guilabel>Visualization size</guilabel>: select visualization size from the
+ drop-down list.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Color balance</term>
+ <listitem>
+ <itemizedlist>
+ <listitem>
+ <para><guilabel>Brightness</guilabel>: use the slider to specify the level of brightness.</para>
+ </listitem>
+ <listitem>
+ <para><guilabel>Contrast</guilabel>: use the slider to specify the level of contrast.</para>
+ </listitem>
+ <listitem>
+ <para><guilabel>Saturation</guilabel>: use the slider to specify the
+ level of saturation.</para>
+ </listitem>
+ <listitem>
+ <para><guilabel>Hue</guilabel>: use the slider to specify the level
+ of hue.</para>
+ </listitem>
+ </itemizedlist>
+ <tip>
+ <para>You may use the <guilabel>Reset to Defaults</guilabel> button to reset the color balance controls to their
+ default positions.</para>
+ </tip>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect2>
+ <sect2 id="totem-prefs-audio">
+ <title>Audio</title>
+ <variablelist>
+ <varlistentry>
+ <term>Audio Output</term>
+ <listitem>
+ <para>Select audio output type from the <guilabel>Audio output type</guilabel>
+ drop-down list.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </sect2>
+ </sect1>
+<!-- ============= Bugs ================================== --><!-- This section is optional and is commented out by default.
+ You can use it to describe known bugs and limitations of the
+ program if there are any - please be frank and list all
+ problems you know of.
+
+ <sect1 id="mayapp-bugs">
+ <title>Known Bugs and Limitations</title>
+ <para> </para>
+ </sect1>
+--><!-- ========================== About ================================= --><!-- This section contains info about the program (not docs), such as
+ author's name(s), web page, license, feedback address. This
+ section is optional: primary place for this info is "About.." box of
+ the program. However, if you do wish to include this info in the
+ manual, this is the place to put it.
+ Alternatively, you can put this information in the title page.--> <sect1 id="totem-about">
+ <title>About <application>
+&appname; </application></title>
+ <para><application>
+&appname; </application> is written by
+ Bastien Nocera (<email>hadess hadess net</email>),
+ Julien Moutte (<email>julien moutte net</email>) for the GStreamer backend,
+ and Guenter Bartsch (<email>guenter users sourceforge net</email>).
+ To find more information about <application>
+&appname; </application>, please visit the
+ <ulink url="http://projects.gnome.org/totem/"; type="http"><application>
+&appname; </application> website</ulink>.
+ </para>
+ <para>
+ To report a bug or make a suggestion regarding the <application>
+&appname; </application> application or
+ this manual, follow the directions in the
+ <ulink url="ghelp:user-guide#feedback" type="help">GNOME Feedback Page</ulink>.
+ </para>
+ <para> This program is distributed under the terms of the GNU
+ General Public license as published by the Free Software
+ Foundation; either version 2 of the License, or (at your option)
+ any later version. A copy of this license can be found at this
+ <ulink url="ghelp:gpl" type="help">link</ulink>, or in the file
+ COPYING included with the source code of this program. </para>
+ </sect1>
+</article>
diff --git a/doc/nact/ChangeLog b/doc/nact/ChangeLog
new file mode 100644
index 0000000..e69de29
diff --git a/doc/nact/Makefile.am b/doc/nact/Makefile.am
index ecc5405..3a577ff 100644
--- a/doc/nact/Makefile.am
+++ b/doc/nact/Makefile.am
@@ -36,13 +36,13 @@ dist-hook: doc-dist-hook
DOC_MODULE = nautilus-actions-config-tool
DOC_ENTITIES = \
+ articleinfo.xml \
+ legalnotice.xml \
$(NULL)
DOC_INCLUDES = \
appendix-feedback.xml \
appendix-gnu-fdl-1.3.xml \
- articleinfo.xml \
- legalnotice.xml \
$(NULL)
DOC_FIGURES = \
diff --git a/doc/nact/nautilus-actions-config-tool.omf.in b/doc/nact/nautilus-actions-config-tool.omf.in
new file mode 100644
index 0000000..f7a4f5b
--- /dev/null
+++ b/doc/nact/nautilus-actions-config-tool.omf.in
@@ -0,0 +1,9 @@
+<?xml version="1.0" standalone="no"?>
+<omf>
+ <resource>
+ <subject category="GNOME|Desktop|User Guides"/>
+ <type>manual</type>
+ <relation seriesid="0ef1bb15-2edd-ef24-7941-18db1cc3da9c90"/>
+ <rights type="GNU FDL" license.version="1.3" holder="Pierre Wieser"/>
+ </resource>
+</omf>
diff --git a/doc/product/Makefile.am b/doc/product/Makefile.am
new file mode 100644
index 0000000..93cbc52
--- /dev/null
+++ b/doc/product/Makefile.am
@@ -0,0 +1,27 @@
+# Nautilus Actions
+# A Nautilus extension which offers configurable context menu actions.
+#
+# Copyright (C) 2005 The GNOME Foundation
+# Copyright (C) 2006, 2007, 2008 Frederic Ruaudel and others (see AUTHORS)
+# Copyright (C) 2009, 2010 Pierre Wieser and others (see AUTHORS)
+#
+# This Program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as
+# published by the Free Software Foundation; either version 2 of
+# the License, or (at your option) any later version.
+#
+# This Program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public
+# License along with this Library; see the file COPYING. If not,
+# write to the Free Software Foundation, Inc., 59 Temple Place,
+# Suite 330, Boston, MA 02111-1307, USA.
+#
+# Authors:
+# Frederic Ruaudel <grumz grumz net>
+# Rodrigo Moya <rodrigo gnome-db org>
+# Pierre Wieser <pwieser trychlos org>
+# ... and many others (see AUTHORS)
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
