commit b87a03aeb9e10e24221950e95b7829627c79434e Author: Robert Krátký rkratky@redhat.com Date: Fri Aug 8 16:21:15 2014 +0200
Fix lang., typos., and mark up.
en-US/publican.xml | 20 ++++++++++---------- 1 files changed, 10 insertions(+), 10 deletions(-) --- diff --git a/en-US/publican.xml b/en-US/publican.xml index 15e6cc5..94c8fb8 100644 --- a/en-US/publican.xml +++ b/en-US/publican.xml @@ -9,7 +9,7 @@ <application>Publican</application> is an open-source publishing system for documentation authored in DocBook XML. It can be used to create and build individual articles and books, manage multiple book sets, or to maintain entire documentation websites. In addition, it can also be used to create RPM packages for easy distribution of documentation builds to other machines. </para> <para> - Publican produces high-quality documents in a number of commonly used file formats such as HTML, PDF, or EPUB. To ensure that all documents produced for a specific project have a consistent look, it uses so called <firstterm>brands</firstterm> to add logos, define color schemes, and set the overall visual style of the output files. + Publican produces high-quality documents in a number of commonly used file formats such as HTML, PDF, or EPUB. To ensure that all documents produced for a specific project have a consistent look, it uses so-called <firstterm>brands</firstterm> to add logos, define color schemes, and set the overall visual style of the output files. </para> <para> The Fedora Documentation Project uses Publican to produce all documents located on the <ulink url="http://docs.fedoraproject.org/">Fedora Documentation</ulink> website. @@ -19,7 +19,7 @@ <para> To install <application>Publican</application> itself and the <systemitem>fedora</systemitem> brand that is used by the Fedora Documentation Project, type the following at a shell prompt as <systemitem class="username">root</systemitem>: </para> - <synopsis><command>yum</command> <option>install</option> <option>publican</option> <option>publican-fedora</option></synopsis> + <synopsis><command>yum install publican publican-fedora</command></synopsis> <para> By default, only the <systemitem>common</systemitem> brand is installed with the <package>publican</package> package. There are many brands in Fedora repositories, such as <systemitem>oVirt</systemitem> (<package>publican-ovirt</package>), <systemitem>JBoss</systemitem> (<package>publican-jboss</package>), or <systemitem>genome</systemitem> (<package>publican-genome</package>). </para> @@ -27,16 +27,16 @@ <section id="sect-publican-creating"> <title>Creating a New Document</title> <para> - When creating a new document, <application>Publican</application> allows you to choose between a book and an article. Compared to books, articles have a simpler structure, do not have a preface or a separate title page, and generally tend to be much shorter. Use an article if you intend to write a text with only few pages. For a larger documents, it is usually better to use a book. + When creating a new document, <application>Publican</application> allows you to choose between a book and an article. Compared to books, articles have a simpler structure, do not have a preface or a separate title page, and generally tend to be much shorter. Use an article if you intend to write a text with only a few pages. For larger documents, it is usually better to use a book. </para> <para> To create a new book, type the following at a shell prompt: </para> - <synopsis><command>publican</command> <option>create</option> <option>--type</option> <option>book</option> <option>--name</option> "<replaceable>Document Name</replaceable>" <option>--brand</option> <replaceable>brand</replaceable></synopsis> + <synopsis><command>publican create --type book --name "<replaceable>Document Name</replaceable>" --brand <replaceable>brand</replaceable></command></synopsis> <para> Replace <replaceable>Document Name</replaceable> with the document title and <replaceable>brand</replaceable> with the brand you want to use (typically <literal>fedora</literal>). Similarly, to create a new article, run the following command: </para> - <synopsis><command>publican</command> <option>create</option> <option>--type</option> <option>article</option> <option>--name</option> "<replaceable>Document Name</replaceable>" <option>--brand</option> <replaceable>brand</replaceable></synopsis> + <synopsis><command>publican create --type article --name "<replaceable>Document Name</replaceable>" --brand <replaceable>brand</replaceable></command></synopsis> <para> Additionally, you can specify the <option>--lang</option> option followed by a language code (such as <literal>pt-BR</literal> or <literal>cs-CZ</literal>) to write the book in a language different than English. </para> @@ -71,7 +71,7 @@ <filename><replaceable>Document_Name</replaceable>.ent</filename> </entry> <entry> - Contains local entities such as <literal>YEAR</literal> and <literal>HOLDER</literal> that are used in the copyright notice. + Contains local entities, such as <literal>YEAR</literal> and <literal>HOLDER</literal>, that are used in the copyright notice. </entry> </row> <row> @@ -159,14 +159,14 @@ <para> To build a document in order to review it, use the following command: </para> - <synopsis><command>publican</command> <option>build</option> <option>--langs</option> <replaceable>languages</replaceable> <option>--formats</option> <replaceable>formats</replaceable></synopsis> + <synopsis><command>publican build --langs <replaceable>languages</replaceable> --formats <replaceable>formats</replaceable></command></synopsis> <para> Replace <replaceable>languages</replaceable> with a comma-separated list of language codes (such as <literal>en-US</literal> or <literal>cs-CZ</literal>) and <replaceable>formats</replaceable> with a comma-separated list of file formats as described in <xref linkend="tabl-publican-building" />. </para> <para> By default, the <command>publican build</command> command stores the created files in the <filename class="directory">tmp/</filename> directory where you can review the output. To build a final version of the document, add the <option>--publish</option> option as follows: </para> - <synopsis><command>publican</command> <option>build</option> <option>--publish</option> <option>--langs</option> <replaceable>languages</replaceable> <option>--formats</option> <replaceable>formats</replaceable></synopsis> + <synopsis><command>publican build --publish --langs <replaceable>languages</replaceable> --formats <replaceable>formats</replaceable></command></synopsis> <para> This places the generated files in the <filename class="directory">publish/</filename> directory. For information on how to publish your document on the Fedora Documentation website, see <xref linkend="sect-publican-publishing" />. </para> @@ -231,7 +231,7 @@ <literal>txt</literal> </entry> <entry> - Generates a plain text file. + Generates a plain-text file. </entry> </row> <row> @@ -312,7 +312,7 @@ </step> <step> <para> - Push the SRPM package created in the previous step to Koji: + Push the SRPM package created in the previous step to <application>Koji</application>: </para> <synopsis><command>koji build el6-docs <replaceable>package_name</replaceable></command></synopsis> <para>