diff options
| -rw-r--r-- | help/mate-fish/C/fish-introduction.duck | 28 | ||||
| -rw-r--r-- | help/mate-fish/C/fish-settings.duck | 27 | ||||
| -rw-r--r-- | help/mate-fish/C/fish-usage.duck | 7 | ||||
| -rw-r--r-- | help/mate-fish/C/index.docbook | 287 | ||||
| -rw-r--r-- | help/mate-fish/C/index.duck | 26 | ||||
| -rw-r--r-- | help/mate-fish/C/legal.xml | 147 | ||||
| -rw-r--r-- | help/mate-fish/Makefile.am | 10 |
7 files changed, 171 insertions, 361 deletions
diff --git a/help/mate-fish/C/fish-introduction.duck b/help/mate-fish/C/fish-introduction.duck new file mode 100644 index 00000000..9591ac39 --- /dev/null +++ b/help/mate-fish/C/fish-introduction.duck @@ -0,0 +1,28 @@ +@ducktype/1.0 +@define applet Fish + += Introduction + [topic #fish-introduction] +@link[guide >index group="fish-introduction"] + +[figure id=fish-fig] + [title] + $applet; Applet + + $media[image src=figures/fish_applet.png] + +The $app($applet;) applet displays an animated fish in the panel. You can customize the fish's name and the program that is run when the fish is clicked in the panel. By default, the program that is run when the fish is clicked is $app(Fortune), which displays a usually comical random message from a database of quotations. + +You can customize the image shown and the command that is run when it is clicked. + +== To Add $applet; to a Panel + [topic #fish-introduction-add] +@link[guide groups="fish-introduction"] + +Perform the following steps: + +[steps] +* Right-click on the panel. +* Choose $gui[.menuitem](Add to Panel). +* Scroll down the list of items in the $gui(Add to Panel) dialog, then select $gui(Fish). +* Click $gui[.button](Add). diff --git a/help/mate-fish/C/fish-settings.duck b/help/mate-fish/C/fish-settings.duck new file mode 100644 index 00000000..e446deb7 --- /dev/null +++ b/help/mate-fish/C/fish-settings.duck @@ -0,0 +1,27 @@ +@ducktype/1.0 +@define applet Fish + += Preferences + [topic #fish-settings] +@link[guide >index group="fish-settings"] + +To configure $app($applet;), right-click on the $app($applet;) applet, then choose $gui[.menu](Preferences). + +[terms] +- $gui(Name of fish) +* Use this text box to specify the name of the fish. + +- $gui(Command to run when clicked) +* By default, $app($applet;) runs the $cmd(fortune) command when you click on the applet. Use this text box to specify an alternative command to run. + +- $gui(File) +* Use this field to select the image to display in the applet. You can select an image that is supplied with the applet or a personal image. + +- $gui(Total frames in animation) +* Use this spin box to specify the number of frames in the animation. + +- $gui(Pause per frame) +* Use this spin box to specify the pause in seconds between each frame in the animation. + +- $gui(Rotate on vertical panels) +* Select this option to rotate the applet image when you add the applet to a vertical panel. diff --git a/help/mate-fish/C/fish-usage.duck b/help/mate-fish/C/fish-usage.duck new file mode 100644 index 00000000..98cfa67c --- /dev/null +++ b/help/mate-fish/C/fish-usage.duck @@ -0,0 +1,7 @@ +@ducktype/1.0 + += Usage + [topic #fish-usage] +@link[guide >index group="fish-usage"] + +Click on the applet to display the $gui(Wanda the Fish) dialog. The dialog typically displays a fortune cookie. You can configure the applet to specify the command to run when you click on the applet. See $link[>fish-settings] for more information. diff --git a/help/mate-fish/C/index.docbook b/help/mate-fish/C/index.docbook deleted file mode 100644 index 8ad297fa..00000000 --- a/help/mate-fish/C/index.docbook +++ /dev/null @@ -1,287 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" -"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ - <!ENTITY legal SYSTEM "legal.xml"> - <!ENTITY appletversion "1.10.1"> - <!ENTITY manrevision "2.6"> - <!ENTITY date "July 2015"> - <!ENTITY applet "Fish"> -]> - -<!-- - (Do not remove this comment block.) - Maintained by the MATE Documentation Project - http://wiki.mate-desktop.org/dev-doc:doc-team-guide - Template version: 2.0 beta - Template last modified Mar 12, 2002 - ---> - -<article id="index" lang="en"> -<!-- please do not change the id; for translations, change lang to --> -<!-- appropriate code --> - <articleinfo> - <title>&applet; Manual</title> - <copyright> - <year>2015-2021</year> - <holder>MATE Documentation Project</holder> - </copyright> - <copyright> - <year>2009</year> - <holder>Paul Cutler</holder> - </copyright> - <copyright> - <year>2002</year> - <year>2003</year> - <holder>Sun Microsystems</holder> - </copyright> - <copyright> - <year>2000</year> - <holder>Telsa Gwynne</holder> - </copyright> -<!-- translators: uncomment this: - - <copyright> - <year>2002</year> - <holder>ME-THE-TRANSLATOR (Latin translation)</holder> - </copyright> - - --> - - <publisher role="maintainer"> - <publishername>MATE Documentation Project</publishername> - </publisher> - <publisher role="maintainer"> - <publishername>GNOME Documentation Project</publishername> - </publisher> - -&legal; - - - <authorgroup> - <author> - <firstname>MATE Documentation Project</firstname> - <surname></surname> - <affiliation> - <orgname>MATE Documentation Project</orgname> - </affiliation> - </author> - <author> - <firstname>Paul</firstname> - <surname>Cutler</surname> - <affiliation> - <orgname>GNOME Documentation Project</orgname> - <address> <email>[email protected]</email> </address> - </affiliation> - </author> - <author> - <firstname>Sun</firstname> - <surname>GNOME Documentation Team</surname> - <affiliation> - <orgname>Sun Microsystems</orgname> - <address></address> - </affiliation> - </author> - <author> - <firstname>Telsa</firstname> - <surname>Gwynne</surname> - <affiliation> - <orgname>GNOME Documentation Project</orgname> - <address> <email>[email protected]</email> </address> - </affiliation> - </author> - <!-- This is appropriate place for other contributors: translators, - maintainers, etc. Commented out by default. - <othercredit role="translator"> - <firstname>Latin</firstname> - <surname>Translator 1</surname> - <affiliation> - <orgname>Latin Translation Team</orgname> - <address> <email>[email protected]</email> </address> - </affiliation> - <contrib>Latin translation</contrib> - </othercredit> ---> - </authorgroup> - - <releaseinfo revision="1.10.1" role="review"> - </releaseinfo> - - <revhistory> - <revision> - <revnumber>&applet; Applet Manual V&manrevision;</revnumber> - <date>&date;</date> - <revdescription> - <para role="author">MATE Documentation Team</para> - <para role="publisher">MATE Documentation Project</para> - </revdescription> - </revision> - <revision> - <revnumber>&applet; Applet Manual V2.5;</revnumber> - <date>&date;</date> - <revdescription> - <para role="author">Sun GNOME Documentation Team</para> - <para role="publisher">GNOME Documentation Project</para> - </revdescription> - </revision> - <revision> - <revnumber>Fish Applet Manual V2.4</revnumber> - <date>&date;</date> - <revdescription> - <para role="author">Sun GNOME Documentation Team</para> - <para role="publisher">GNOME Documentation Project</para> - </revdescription> - </revision> - <revision> - <revnumber>Fish Applet Manual V2.2</revnumber> - <date>January 2003</date> - <revdescription> - <para role="author">Sun GNOME Documentation Team</para> - <para role="publisher">GNOME Documentation Project</para> - </revdescription> - </revision> - <revision> - <revnumber>Fish Applet Manual V2.1</revnumber> - <date>August 2002</date> - <revdescription> - <para role="author">Sun GNOME Documentation Team</para> - <para role="publisher">GNOME Documentation Project</para> - </revdescription> - </revision> - <revision> - <revnumber>Fish Applet Manual V2.0</revnumber> - <date>May 2002</date> - <revdescription> - <para role="author">Sun GNOME Documentation Team</para> - <para role="publisher">GNOME Documentation Project</para> - </revdescription> - </revision> - <revision> - <revnumber>Fish Applet Manual</revnumber> - <date>2000</date> - <revdescription> - <para role="author">Telsa Gwynne - <email>[email protected]</email></para> - <para role="publisher">GNOME Documentation Project</para> - </revdescription> - </revision> - </revhistory> - <releaseinfo> This manual describes version &appletversion; of &applet;. - </releaseinfo> - <legalnotice> - <title>Feedback</title> - <para> To report a bug or make a suggestion regarding the &applet; applet or this - manual, follow the directions in the - <ulink url="help:mate-user-guide/feedback" type="help">MATE Feedback Page</ulink>. </para> - - </legalnotice> - <abstract role="description"> - <para>The &applet; applet displays an animated image in the panel and gives you - your fortune when clicked.</para> - </abstract> - </articleinfo> - <indexterm> - <primary>Fish</primary> - </indexterm> - -<!-- ============= Document Body ============================= --> -<!-- ============= Introduction ============================== --> -<sect1 id="fish-introduction"> -<title>Introduction</title> -<!-- ==== Figure ============================================= --> - <figure id="fish-fig"> - <title>&applet; Applet</title> - <screenshot> - <mediaobject> - <imageobject><imagedata fileref="figures/fish_applet.png" format="PNG"/> - </imageobject> - <textobject> - <phrase>Shows Fish applet.</phrase> - </textobject> - </mediaobject> - </screenshot> - </figure> - <!-- ==== End of Figure ======================================= --> -<para>The <application>&applet;</application> applet displays an animated fish in the panel. You can customize the fish's name and the program that is run when the fish is clicked in the panel. By default, the program that is run when the fish is clicked is <application>Fortune</application>, which displays a usually comical random message from a database of quotations.</para> - - - - -<para>You can customize the image shown and the command that is run when it is clicked.</para> -<sect2 id="fish-introduction-add"> -<title>To Add &applet; to a Panel</title> - <para>Perform the following steps:</para> - <orderedlist> - <listitem> - <para> - Right-click on the panel. - </para> - </listitem> - <listitem> - <para> - Choose <guimenuitem>Add to Panel</guimenuitem>. - </para> - </listitem> - <listitem> - <para> - Scroll down the list of items in the <guilabel>Add to Panel</guilabel> dialog, then select <guilabel>Fish</guilabel>. - </para> - </listitem> - <listitem> - <para> - Click <guibutton>Add</guibutton>. - </para> - </listitem> - </orderedlist> - </sect2></sect1> - -<sect1 id="fish-usage"> -<title>Usage</title> -<para>Click on the applet to display the <guilabel>Wanda the Fish</guilabel> dialog. The dialog typically displays a fortune cookie. You can configure the applet to specify the command to run when you click on the applet. See <xref linkend="fish-settings"/> for more information.</para> -</sect1> - -<!-- ============= Preferences ================================ --> -<sect1 id="fish-settings"> -<title>Preferences</title> -<para>To configure <application>&applet;</application>, right-click on the <application> -&applet;</application> applet, then choose <guimenu>Preferences</guimenu>. </para> -<variablelist> -<varlistentry> -<term><guilabel>Name of fish</guilabel> </term> -<listitem> -<para>Use this text box to specify the name of the fish.</para> -</listitem> -</varlistentry> -<varlistentry> -<term><guilabel>Command to run when clicked</guilabel> </term> -<listitem> -<para>By default, <application>&applet;</application> runs the <literal>fortune</literal> command when you click on the applet. Use this text box to specify an alternative command to run. </para> -</listitem> -</varlistentry> -<varlistentry> -<term><guilabel>File</guilabel> </term> -<listitem> -<para>Use this field to select the image to display in the applet. You can select an image that is supplied with the applet or a personal image.</para> -</listitem> -</varlistentry> -<varlistentry> -<term><guilabel>Total frames in animation</guilabel> </term> -<listitem> -<para>Use this spin box to specify the number of frames in the animation. </para> -</listitem> -</varlistentry> -<varlistentry> -<term><guilabel>Pause per frame</guilabel> </term> -<listitem> -<para>Use this spin box to specify the pause in seconds between each frame in the animation.</para> -</listitem> -</varlistentry> -<varlistentry> -<term><guilabel>Rotate on vertical panels</guilabel> </term> -<listitem> -<para>Select this option to rotate the applet image when you add the applet to a vertical panel.</para> -</listitem> -</varlistentry> -</variablelist> -</sect1> -</article> diff --git a/help/mate-fish/C/index.duck b/help/mate-fish/C/index.duck new file mode 100644 index 00000000..7a7a338b --- /dev/null +++ b/help/mate-fish/C/index.duck @@ -0,0 +1,26 @@ +@ducktype/1.0 +@define appname $app(MyApp) +@define applet Fish +@define version 3.26 + += $applet; Manual + [guide #index] + +@credit[copyright] + @name MATE Documentation Project + @year 2015-2021 +@credit[copyright] + @name Paul Cutler + @year 2009 +@credit[copyright] + @name Sun Microsystems + @year 2002 +@credit[copyright] + @name Telsa Gwynne + @year 2000 +@credit[publisher] + @name MATE Documentation Project +@credit[publisher] + @name GNOME Documentation Project + +@include[>>legal.xml xmlns="http://www.w3.org/2001/XInclude"] diff --git a/help/mate-fish/C/legal.xml b/help/mate-fish/C/legal.xml index 9c4e2480..c56ebabb 100644 --- a/help/mate-fish/C/legal.xml +++ b/help/mate-fish/C/legal.xml @@ -1,76 +1,77 @@ - <legalnotice id="legalnotice"> - <para> - Permission is granted to copy, distribute and/or modify this - document under the terms of the GNU Free Documentation - License (GFDL), Version 1.1 or any later version published - by the Free Software Foundation with no Invariant Sections, - no Front-Cover Texts, and no Back-Cover Texts. You can find - a copy of the GFDL at this <ulink type="help" - url="help:fdl">link</ulink> or in the file COPYING-DOCS - distributed with this manual. - </para> - <para> This manual is part of a collection of MATE manuals - distributed under the GFDL. If you want to distribute this - manual separately from the collection, you can do so by - adding a copy of the license to the manual, as described in - section 6 of the license. - </para> +<legalnotice xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + version="5.0" xml:id="legalnotice" xml:lang="en"> +<para> + Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU Free Documentation + License (GFDL), Version 1.1 or any later version published + by the Free Software Foundation with no Invariant Sections, + no Front-Cover Texts, and no Back-Cover Texts. You can find + a copy of the GFDL at this <ulink type="help" + url="help:fdl">link</ulink> or in the file COPYING-DOCS + distributed with this manual. + </para> + <para> This manual is part of a collection of MATE manuals + distributed under the GFDL. If you want to distribute this + manual separately from the collection, you can do so by + adding a copy of the license to the manual, as described in + section 6 of the license. +</para> - <para> - Many of the names used by companies to distinguish their - products and services are claimed as trademarks. Where those - names appear in any MATE documentation, and the members of - the MATE Documentation Project are made aware of those - trademarks, then the names are in capital letters or initial - capital letters. - </para> +<para> + Many of the names used by companies to distinguish their + products and services are claimed as trademarks. Where those + names appear in any MATE documentation, and the members of + the MATE Documentation Project are made aware of those + trademarks, then the names are in capital letters or initial + capital letters. +</para> - <para> - DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT ARE PROVIDED - UNDER THE TERMS OF THE GNU FREE DOCUMENTATION LICENSE - WITH THE FURTHER UNDERSTANDING THAT: - - <orderedlist> - <listitem> - <para>DOCUMENT IS PROVIDED ON AN "AS IS" BASIS, - WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR - IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES - THAT THE DOCUMENT OR MODIFIED VERSION OF THE - DOCUMENT IS FREE OF DEFECTS MERCHANTABLE, FIT FOR - A PARTICULAR PURPOSE OR NON-INFRINGING. THE ENTIRE - RISK AS TO THE QUALITY, ACCURACY, AND PERFORMANCE - OF THE DOCUMENT OR MODIFIED VERSION OF THE - DOCUMENT IS WITH YOU. SHOULD ANY DOCUMENT OR - MODIFIED VERSION PROVE DEFECTIVE IN ANY RESPECT, - YOU (NOT THE INITIAL WRITER, AUTHOR OR ANY - CONTRIBUTOR) ASSUME THE COST OF ANY NECESSARY - SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER - OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS - LICENSE. NO USE OF ANY DOCUMENT OR MODIFIED - VERSION OF THE DOCUMENT IS AUTHORIZED HEREUNDER - EXCEPT UNDER THIS DISCLAIMER; AND - </para> - </listitem> - <listitem> - <para>UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL - THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE), - CONTRACT, OR OTHERWISE, SHALL THE AUTHOR, - INITIAL WRITER, ANY CONTRIBUTOR, OR ANY - DISTRIBUTOR OF THE DOCUMENT OR MODIFIED VERSION - OF THE DOCUMENT, OR ANY SUPPLIER OF ANY OF SUCH - PARTIES, BE LIABLE TO ANY PERSON FOR ANY - DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR - CONSEQUENTIAL DAMAGES OF ANY CHARACTER - INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS - OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR - MALFUNCTION, OR ANY AND ALL OTHER DAMAGES OR - LOSSES ARISING OUT OF OR RELATING TO USE OF THE - DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT, - EVEN IF SUCH PARTY SHALL HAVE BEEN INFORMED OF - THE POSSIBILITY OF SUCH DAMAGES. - </para> - </listitem> - </orderedlist> - </para> - </legalnotice> +<para> + DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT ARE PROVIDED + UNDER THE TERMS OF THE GNU FREE DOCUMENTATION LICENSE + WITH THE FURTHER UNDERSTANDING THAT: + <orderedlist> + <listitem> + <para>DOCUMENT IS PROVIDED ON AN "AS IS" BASIS, + WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR + IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES + THAT THE DOCUMENT OR MODIFIED VERSION OF THE + DOCUMENT IS FREE OF DEFECTS MERCHANTABLE, FIT FOR + A PARTICULAR PURPOSE OR NON-INFRINGING. THE ENTIRE + RISK AS TO THE QUALITY, ACCURACY, AND PERFORMANCE + OF THE DOCUMENT OR MODIFIED VERSION OF THE + DOCUMENT IS WITH YOU. SHOULD ANY DOCUMENT OR + MODIFIED VERSION PROVE DEFECTIVE IN ANY RESPECT, + YOU (NOT THE INITIAL WRITER, AUTHOR OR ANY + CONTRIBUTOR) ASSUME THE COST OF ANY NECESSARY + SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER + OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS + LICENSE. NO USE OF ANY DOCUMENT OR MODIFIED + VERSION OF THE DOCUMENT IS AUTHORIZED HEREUNDER + EXCEPT UNDER THIS DISCLAIMER; AND + </para> + </listitem> + <listitem> + <para>UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL + THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE), + CONTRACT, OR OTHERWISE, SHALL THE AUTHOR, + INITIAL WRITER, ANY CONTRIBUTOR, OR ANY + DISTRIBUTOR OF THE DOCUMENT OR MODIFIED VERSION + OF THE DOCUMENT, OR ANY SUPPLIER OF ANY OF SUCH + PARTIES, BE LIABLE TO ANY PERSON FOR ANY + DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR + CONSEQUENTIAL DAMAGES OF ANY CHARACTER + INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS + OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR + MALFUNCTION, OR ANY AND ALL OTHER DAMAGES OR + LOSSES ARISING OUT OF OR RELATING TO USE OF THE + DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT, + EVEN IF SUCH PARTY SHALL HAVE BEEN INFORMED OF + THE POSSIBILITY OF SUCH DAMAGES. + </para> + </listitem> + </orderedlist> +</para> +</legalnotice> diff --git a/help/mate-fish/Makefile.am b/help/mate-fish/Makefile.am index fce56d14..c2f406c6 100644 --- a/help/mate-fish/Makefile.am +++ b/help/mate-fish/Makefile.am @@ -3,9 +3,17 @@ HELP_ID = mate-fish HELP_FILES = \ - index.docbook \ + fish-introduction.page \ + fish-settings.page \ + fish-usage.page \ + index.page \ legal.xml +DUCK_FILES = $(wildcard C/*.duck) +PAGE_FILES = $(patsubst %.duck,%.page,$(DUCK_FILES)) +$(PAGE_FILES): %.page: %.duck + ducktype $^ + HELP_MEDIA = figures/fish_applet.png # Add linguas to be ignored, e.g. IGNORE_HELP_LINGUAS = ca de es fr |