[documentation-guide] Adjusted the formatting a bit and added a few remarks.
Jaromir Hradilek
jhradile at fedoraproject.org
Sun Oct 2 21:32:11 UTC 2011
commit 86ce10825a4c26f2f516276af6b9eb0dcba37680
Author: Jaromir Hradilek <jhradile at redhat.com>
Date: Sun Oct 2 11:44:29 2011 +0200
Adjusted the formatting a bit and added a few remarks.
en-US/publican.xml | 351 ++++++++++++++++++++++++++++++++++------------------
1 files changed, 230 insertions(+), 121 deletions(-)
---
diff --git a/en-US/publican.xml b/en-US/publican.xml
index ae7b249..481f731 100644
--- a/en-US/publican.xml
+++ b/en-US/publican.xml
@@ -4,125 +4,234 @@
%BOOK_ENTITIES;
]>
<chapter id="chap-documentation_guide-publican">
- <title>Publican</title>
- <para><application>Publican</application> is a program that creates the end product that our customers see. The program creates html, html-single, PDF, and ePub formatted files from DocBook XML source code. The files that Publican builds can then be uploaded to a website or packaged in an RPM.
- </para>
- <section id="chap-documentation_guide-publican-installing">
- <title>Installing Publican</title>
- <para>Installing <package>Publican</package> is quite easy to do. Running <command>yum install publican-fedora</command> as root will install not only the Fedora brand, which will be explained later, but will bring in the <application>Publican</application> package and its dependencies.</para>
- </section>
- <section id="chap-documentation_guide-publican-workflow">
- <title>Publican Workflow</title>
- <para><application>Publican</application> is a command line interface (CLI) program that uses several commands for creating user files from DocBook XML source code. <application>Publican</application> will take care of several tasks for you including building a new book or article, build the book in several formats, and create an RPM package that can be used to install the document locally onto a computer.</para>
-
- <section id="chap-documentation_guide-publican-workflow-blank_document">
- <title>Creating a Blank Document</title>
- <para>Creating a new book or article is easy using this command: <command>publican create --name=<replaceable>Book_Name</replaceable> --brand=fedora --lang=<replaceable>language identifier</replaceable> --type=book <replaceable>or</replaceable> article.</command> This string will create a new directory with the same name as <literal>Book_Name</literal>, with a directory of the language identifier inside the <literal>Book_Name</literal> directory. Also created is a publican.cfg configuration file that handles some <application>Publican</application> configuration switches.</para>
- <para>The type of document can be a bit confusing. The type <literal>article</literal> is best used for documents that will be five pages or less. <literal>Book</literal> on the other hand is best for documents that are longer than five pages and includes a title page, preface, and an index, among other differences.</para>
- </section>
- <section id="chap-documentation_guide-publican-workflow-validating_XML">
- <title>Validating XML Code</title>
- <para></para>
- </section>
-
- <section id="chap-documentation_guide-publican-workflow-building">
- <title>Building a Document</title>
- <para></para>
- </section>
- <section id="chap-documentation_guide-publican-workflow-Publishing_to_web">
- <title>Publishing a Document to the Web</title>
- <para>Publishing a document to the Fedora Documentation website isn't that difficult when <application>Publican</application> is doing the heavy lifting. It is assumed that you already have the repository cloned on the computer that <application>Publican</application> will be working from and that your configuration is complete.</para>
- <warning><para>Documents produced with versions of Publican prior to 2.5 are not compatible with the current website structure. Always make sure that you have the latest version of Publican installed before you publish documents.</para></warning>
-
- <section id="chap-documentation_guide-publican-workflow-Publishing_to_web-Getting_setup">
- <title>Preparing Your System</title>
- <para>Before we start building your documents into the proper formats for user consumption we need to pull down the webpage source which you'll later add your document into and commit. The following procedure will instruct you on how to do this.</para>
- <itemizedlist>
- <listitem>
- <para>Create a local copy of the git repository of the docs.fedoraproject.org website: <command>git clone ssh://USERNAME@git.fedorahosted.org/git/docs/web.git</command> where <literal>USERNAME</literal> is your FAS username.</para>
-<note><para>This download will take some time, even on fast connections.</para></note>
- </listitem>
- <listitem>
- <para>Change into the directory into which you downloaded the <literal>web.git</literal> repo, and make a copy of <literal>homepage.tmp</literal> named <literal>homepage.cfg</literal>:<command>cp homepage.tmp homepage.cfg</command></para>
- </listitem>
- <listitem>
- <para>Edit the <literal>homepage.cfg</literal> file to provide the absolute paths to the <literal>fedoradocs.db</literal> file and the <literal>public_html</literal> directory. For example, if you downloaded the <literal>web.git</literal> repo to the <literal>fedoradocs</literal> subdirectory of your home directory, your homepage.cfg file might look like: <command>
-db_file: /home/jsmith/fedoradocs/web/fedoradocs.db
-toc_path: /home/jsmith/fedoradocs/web/public_html
-host: http://docs.fedoraproject.org
-title: "Fedora Documentation"
-search:</command></para>
- </listitem>
- <listitem><para>Make sure you have the latest version of Publican and the Fedora brand package. As root, run: <command>yum update publican publican-fedora</command></para>
- </listitem>
- </itemizedlist>
- </section>
- <section id="chap-documentation_guide-publican-workflow-Publishing_a_Document">
- <title>Publishing a Document</title>
- <warning><para>Publican now controls the directory structure and the SQLite database that manages the site and its tables of contents. Do not add or remove directories from the directory tree manually as we did in the past.</para></warning>
- <warning><para>If you are publishing draft documentation, be sure to follow the instructions described at Publishing draft documentation first.</para></warning>
- <warning><para>If you are publishing the final version of documentation that was first published in the "Draft Documentation" category, be sure to follow the instructions described at Unpublishing draft documentation first.</para></warning>
- <itemizedlist>
- <listitem><para>Update your copy of the docs.fedoraproject.org website. In the directory where you keep your local copy of the site, run: <command>git pull</command></para>
- </listitem>
- <listitem><para>Change to the directory where you keep a checked-out copy of the document that you want to publish, then run: <command>publican build -- embedtoc -- publish -- formats epub,html,html-single,pdf -- langs LANGUAGE_CODES</command> where <literal>LANGUAGE_CODES</literal> is a comma-separated list of the languages in which you want to publish this document.</para></listitem>
- <listitem><para>Browse to the publish subdirectory and to the documents themselves inside it to ensure that the documents have built as you expected. In particular, verify the product name is <literal>Fedora</literal> (note capitalization), the version number is correct, the document title is properly capitalized and spaced: for example, <literal>Foo Guide</literal>, not <literal>foo-guide</literal></para></listitem>
- <listitem><para>Install the book to the Fedora website:
-<command>publican install_book --site_config PATH_TO_SITE_CONFIG_FILE --lang LANGUAGE_CODE</command>
-where <literal>PATH_TO_SITE_CONFIG_FILE</literal> is the path to the <literal>homepage.cfg</literal> file in your local copy of the docs.fedoraproject.org website, and <literal>LANGUAGE_CODE</literal> is the language in which you are publishing the document. Note that you can only run <command>publican install_book</command> for one language at a time.</para></listitem>
- <listitem><para>Change to the directory in which you keep your local copy of the site and run: <command>git add .
-git commit -m "DESCRIPTION_OF_YOUR_CHANGES"
-git push</command></para></listitem>
- </itemizedlist>
- </section>
- <section id="chap-documentation_guide-publican-workflow-Removing_a_document">
- <title>Removing a Document from the Web</title>
- <para>To remove a document for a particular version of Fedora in a particular language:</para>
- <itemizedlist>
- <listitem><para>Update your copy of the docs.fedoraproject.org website. In the directory where you keep your local copy of the site, run:
-<command>git pull</command></para></listitem>
- <listitem><para>Change to the directory where you keep a checked-out copy of the document that you want to remove, then run: <command>publican remove_book --site_config PATH_TO_SITE_CONFIG_FILE --lang LANGUAGE_CODE</command> where <literal>PATH_TO_SITE_CONFIG_FILE</literal> is the path to the <literal>homepage.cfg</literal> file in your local copy of the docs.fedoraproject.org website, and <literal>LANGUAGE_CODE</literal> is the language in which you are removing the document. Note that you can only run <command>publican remove_book</command> for one language at a time.</para></listitem>
- <listitem><para>Change to the directory in which you keep your local copy of the site and run: <command>git add .
-git commit -m "DESCRIPTION_OF_YOUR_CHANGES"
-git push</command></para></listitem>
- <listitem><para>Publican can only remove the local files and directories on your system, not their record in Git. To remove the deleted files from your local Git repo, run:
-<command>for f in $(git ls-files --deleted); do git rm $f; done </command>. Then push these changes to the remote repo:<command>git commit -m "rm unused files" git push</command></para>
-<warning><para>A <command>git rm</command> command gone wrong can cause widespread damage to the documentation site. If you are not absolutely sure of what you are doing, ask for help.</para></warning></listitem></itemizedlist>
- </section>
- <section id="chap-documentation_guide-publican-workflow-Updating_a_Document">
- <title>Updating a Document</title>
- <para>To update a document previously published in a particular language for a particular version of Fedora, change into the directory in which you keep a checked-out copy of the document, then run <command>publican install_book</command>, as if you were installing it for the first time. Publican automatically replaces the old version with the new one.</para>
- </section>
- </section>
- </section>
- <section id="chap-documentation_guide-publican-Formats">
- <title>Documentation Formats</title>
- <para><application>Publican</application> creates documents in four formats for users to select from: PDF, HTML, HTML-Single, and ePub.</para>
- </section>
- <section id="chap-documentation_guide-publican-Branding">
- <title>Publican Branding</title>
- <para><application>Publican</application> uses modules called "brands" to add logos and colour schemes to documents produced for a specific project. For example, the <package>publican-fedora</package> package adds the Fedora logos and colour scheme to documents produced for the Fedora Project.</para>
- <para>At the top right of every HTML page, the Fedora brand includes a link back to the Fedora documentation site, from a graphic containing the English word "Documentation". We can localise this graphic so that the word "Documentation appears in the same language into which the document itself is translated.</para>
- </section>
- <section id="chap-documentation_guide-publican-draft">
- <title>Marking a Documentation as Draft</title>
- <para>Release early, release often.</para>
- <para>Documents can be released before they are completely ready for the users. When this happens it's important to mark and publish the document as a draft. To do this there are three things that need to be done so that everyone knows that the guide isn't complete and ready for public consumption.</para>
- <para>The first is setting the draft switch in the document itself. To do this you need to add <command>status="draft"</command> to your <literal>Doc_Name.xml</literal> file in the <literal>book</literal> or <literal>article</literal> heading so it looks like <command>book status="draft"</command>. This provides a draft watermark on all pages of the text.</para>
- <para>The next task is to modify your <literal>Book_Info.xml</literal> or <literal>Article_Info.xml</literal> file. Change the <literal>productname</literal>tag to Fedora Draft Documentation and remove the contents of <literal>productnumber</literal>. Optionally, if you plan to release the document for a particular Fedora release, include the Fedora release number in the <literal>edition</literal> tag. For example, if you plan to release the book for Fedora 14, you would set edition to: <command>14.0.1</command>. Here 14.0.1 signifies Fedora 14, edition 0.1.</para>
- <para>Lastly, in the <literal>Publican.cfg</literal> add the following lines: <command>version: 0.1</command> and <command>web_version_label: UNUSED</command>.</para>
- <para>After completing the above tasks your guide will be sufficiently marked as draft and can safely be published to the Docs website.</para>
- </section>
- <section id="chap-documentation_guide-publican-Building_RPMs">
- <title>Building RPMs</title>
- <para></para>
- </section>
- <section id="chap-documentation_guide-publican-Translations">
- <title>Translating Documentation</title>
- <para>Documentation translation is discussed in a separate <xref linkend="chap-documentation_guide-translations"/>.</para>
- </section>
- <section id="chap-documentation_guide-publican-TipsAndTricks">
- <title>Tips and Tricks</title>
- <para></para>
- </section>
+ <title>Publican</title>
+ <para>
+ <application>Publican</application> is a program that creates the end product that our customers see. The program creates html, html-single, PDF, and ePub formatted files from DocBook XML source code. The files that Publican builds can then be uploaded to a website or packaged in an RPM.
+ </para>
+ <section id="chap-documentation_guide-publican-installing">
+ <title>Installing Publican</title>
+ <para>
+ Installing <package>Publican</package> is quite easy to do. Running <command>yum install publican-fedora</command> as root will install not only the Fedora brand, which will be explained later, but will bring in the <application>Publican</application> package and its dependencies.
+ </para>
+ </section>
+ <section id="chap-documentation_guide-publican-workflow">
+ <title>Publican Workflow</title>
+ <para>
+ <application>Publican</application> is a command line interface (CLI) program that uses several commands for creating user files from DocBook XML source code. <application>Publican</application> will take care of several tasks for you including building a new book or article, build the book in several formats, and create an RPM package that can be used to install the document locally onto a computer.
+ </para>
+ <section id="chap-documentation_guide-publican-workflow-blank_document">
+ <title>Creating a Blank Document</title>
+ <para>
+ Creating a new book or article is easy using this command: <command>publican create --name=<replaceable>Book_Name</replaceable> --brand=fedora --lang=<replaceable>language identifier</replaceable> --type=book <replaceable>or</replaceable> article.</command> This string will create a new directory with the same name as <literal>Book_Name</literal>, with a directory of the language identifier inside the <literal>Book_Name</literal> directory. Also created is a publican.cfg configuration file that handles some <application>Publican</application> configuration switches.
+ </para>
+ <para>
+ The type of document can be a bit confusing. The type <literal>article</literal> is best used for documents that will be five pages or less. <literal>Book</literal> on the other hand is best for documents that are longer than five pages and includes a title page, preface, and an index, among other differences.
+ </para>
+ </section>
+ <section id="chap-documentation_guide-publican-workflow-validating_XML">
+ <title>Validating XML Code</title>
+ <para>
+ <remark>Hic sunt leones.</remark>
+ </para>
+ </section>
+ <section id="chap-documentation_guide-publican-workflow-building">
+ <title>Building a Document</title>
+ <para>
+ <remark>Hic sunt leones.</remark>
+ </para>
+ </section>
+ <section id="chap-documentation_guide-publican-workflow-Publishing_to_web">
+ <title>Publishing a Document to the Web</title>
+ <para>
+ Publishing a document to the Fedora Documentation website isn't that difficult when <application>Publican</application> is doing the heavy lifting. It is assumed that you already have the repository cloned on the computer that <application>Publican</application> will be working from and that your configuration is complete.
+ </para>
+ <warning>
+ <para>
+ Documents produced with versions of Publican prior to 2.5 are not compatible with the current website structure. Always make sure that you have the latest version of Publican installed before you publish documents.
+ </para>
+ </warning>
+ <section id="chap-documentation_guide-publican-workflow-Publishing_to_web-Getting_setup">
+ <title>Preparing Your System</title>
+ <para>
+ Before we start building your documents into the proper formats for user consumption we need to pull down the webpage source which you'll later add your document into and commit. The following procedure will instruct you on how to do this.
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Create a local copy of the git repository of the docs.fedoraproject.org website: <command>git clone ssh://USERNAME@git.fedorahosted.org/git/docs/web.git</command> where <literal>USERNAME</literal> is your FAS username.
+ </para>
+ <note>
+ <para>
+ This download will take some time, even on fast connections.
+ </para>
+ </note>
+ </listitem>
+ <listitem>
+ <para>
+ Change into the directory into which you downloaded the <literal>web.git</literal> repo, and make a copy of <literal>homepage.tmp</literal> named <literal>homepage.cfg</literal>:<command>cp homepage.tmp homepage.cfg</command>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Edit the <literal>homepage.cfg</literal> file to provide the absolute paths to the <literal>fedoradocs.db</literal> file and the <literal>public_html</literal> directory. For example, if you downloaded the <literal>web.git</literal> repo to the <literal>fedoradocs</literal> subdirectory of your home directory, your homepage.cfg file might look like:
+ </para>
+ <programlisting>db_file: /home/jsmith/fedoradocs/web/fedoradocs.db
+ toc_path: /home/jsmith/fedoradocs/web/public_html
+ host: http://docs.fedoraproject.org
+ title: "Fedora Documentation"
+ search:</programlisting>
+ </listitem>
+ <listitem>
+ <para>
+ Make sure you have the latest version of Publican and the Fedora brand package. As root, run: <command>yum update publican publican-fedora</command>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </section>
+ <section id="chap-documentation_guide-publican-workflow-Publishing_a_Document">
+ <title>Publishing a Document</title>
+ <warning>
+ <para>
+ Publican now controls the directory structure and the SQLite database that manages the site and its tables of contents. Do not add or remove directories from the directory tree manually as we did in the past.
+ </para>
+ </warning>
+ <warning>
+ <para>
+ If you are publishing draft documentation, be sure to follow the instructions described at Publishing draft documentation first.
+ </para>
+ </warning>
+ <warning>
+ <para>
+ If you are publishing the final version of documentation that was first published in the "Draft Documentation" category, be sure to follow the instructions described at Unpublishing draft documentation first.
+ </para>
+ </warning>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Update your copy of the docs.fedoraproject.org website. In the directory where you keep your local copy of the site, run: <command>git pull</command>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Change to the directory where you keep a checked-out copy of the document that you want to publish, then run: <command>publican build -- embedtoc -- publish -- formats epub,html,html-single,pdf -- langs LANGUAGE_CODES</command> where <literal>LANGUAGE_CODES</literal> is a comma-separated list of the languages in which you want to publish this document.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Browse to the publish subdirectory and to the documents themselves inside it to ensure that the documents have built as you expected. In particular, verify the product name is <literal>Fedora</literal> (note capitalization), the version number is correct, the document title is properly capitalized and spaced: for example, <literal>Foo Guide</literal>, not <literal>foo-guide</literal>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Install the book to the Fedora website: <command>publican install_book --site_config PATH_TO_SITE_CONFIG_FILE --lang LANGUAGE_CODE</command> where <literal>PATH_TO_SITE_CONFIG_FILE</literal> is the path to the <literal>homepage.cfg</literal> file in your local copy of the docs.fedoraproject.org website, and <literal>LANGUAGE_CODE</literal> is the language in which you are publishing the document. Note that you can only run <command>publican install_book</command> for one language at a time.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Change to the directory in which you keep your local copy of the site and run:
+ </para>
+ <screen><command>git add .</command>
+<command>git commit -m "DESCRIPTION_OF_YOUR_CHANGES"</command>
+<command>git push</command></screen>
+ </listitem>
+ </itemizedlist>
+ </section>
+ <section id="chap-documentation_guide-publican-workflow-Removing_a_document">
+ <title>Removing a Document from the Web</title>
+ <para>
+ To remove a document for a particular version of Fedora in a particular language:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Update your copy of the docs.fedoraproject.org website. In the directory where you keep your local copy of the site, run: <command>git pull</command>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Change to the directory where you keep a checked-out copy of the document that you want to remove, then run: <command>publican remove_book --site_config PATH_TO_SITE_CONFIG_FILE --lang LANGUAGE_CODE</command> where <literal>PATH_TO_SITE_CONFIG_FILE</literal> is the path to the <literal>homepage.cfg</literal> file in your local copy of the docs.fedoraproject.org website, and <literal>LANGUAGE_CODE</literal> is the language in which you are removing the document. Note that you can only run <command>publican remove_book</command> for one language at a time.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Change to the directory in which you keep your local copy of the site and run:
+ </para>
+ <screen><command>git add .</command>
+<command>git commit -m "DESCRIPTION_OF_YOUR_CHANGES"</command>
+<command>git push</command></screen>
+ </listitem>
+ <listitem>
+ <para>
+ Publican can only remove the local files and directories on your system, not their record in Git. To remove the deleted files from your local Git repo, run: <command>for f in $(git ls-files --deleted); do git rm $f; done </command>. Then push these changes to the remote repo: <command>git commit -m "rm unused files" git push</command>
+ </para>
+ <warning>
+ <para>
+ A <command>git rm</command> command gone wrong can cause widespread damage to the documentation site. If you are not absolutely sure of what you are doing, ask for help.
+ </para>
+ </warning>
+ </listitem>
+ </itemizedlist>
+ </section>
+ <section id="chap-documentation_guide-publican-workflow-Updating_a_Document">
+ <title>Updating a Document</title>
+ <para>
+ To update a document previously published in a particular language for a particular version of Fedora, change into the directory in which you keep a checked-out copy of the document, then run <command>publican install_book</command>, as if you were installing it for the first time. Publican automatically replaces the old version with the new one.
+ </para>
+ </section>
+ </section>
+ </section>
+ <section id="chap-documentation_guide-publican-Formats">
+ <title>Documentation Formats</title>
+ <para>
+ <application>Publican</application> creates documents in four formats for users to select from: PDF, HTML, HTML-Single, and ePub.
+ </para>
+ </section>
+ <section id="chap-documentation_guide-publican-Branding">
+ <title>Publican Branding</title>
+ <para>
+ <application>Publican</application> uses modules called "brands" to add logos and colour schemes to documents produced for a specific project. For example, the <package>publican-fedora</package> package adds the Fedora logos and colour scheme to documents produced for the Fedora Project.
+ </para>
+ <para>
+ At the top right of every HTML page, the Fedora brand includes a link back to the Fedora documentation site, from a graphic containing the English word "Documentation". We can localise this graphic so that the word "Documentation appears in the same language into which the document itself is translated.
+ </para>
+ </section>
+ <section id="chap-documentation_guide-publican-draft">
+ <title>Marking a Documentation as Draft</title>
+ <para>
+ Release early, release often.
+ </para>
+ <para>
+ Documents can be released before they are completely ready for the users. When this happens it's important to mark and publish the document as a draft. To do this there are three things that need to be done so that everyone knows that the guide isn't complete and ready for public consumption.
+ </para>
+ <para>
+ The first is setting the draft switch in the document itself. To do this you need to add <command>status="draft"</command> to your <literal>Doc_Name.xml</literal> file in the <literal>book</literal> or <literal>article</literal> heading so it looks like <command>book status="draft"</command>. This provides a draft watermark on all pages of the text.
+ </para>
+ <para>
+ The next task is to modify your <literal>Book_Info.xml</literal> or <literal>Article_Info.xml</literal> file. Change the <literal>productname</literal>tag to Fedora Draft Documentation and remove the contents of <literal>productnumber</literal>. Optionally, if you plan to release the document for a particular Fedora release, include the Fedora release number in the <literal>edition</literal> tag. For example, if you plan to release the book for Fedora 14, you would set edition to: <command>14.0.1</command>. Here 14.0.1 signifies Fedora 14, edition 0.1.
+ </para>
+ <para>
+ Lastly, in the <literal>Publican.cfg</literal> add the following lines: <command>version: 0.1</command> and <command>web_version_label: UNUSED</command>.
+ </para>
+ <para>
+ After completing the above tasks your guide will be sufficiently marked as draft and can safely be published to the Docs website.
+ </para>
+ </section>
+ <section id="chap-documentation_guide-publican-Building_RPMs">
+ <title>Building RPMs</title>
+ <para>
+ <remark>Hic sunt leones.</remark>
+ </para>
+ </section>
+ <section id="chap-documentation_guide-publican-Translations">
+ <title>Translating Documentation</title>
+ <para>
+ Documentation translation is discussed in a separate <xref linkend="chap-documentation_guide-translations"/>.
+ </para>
+ </section>
+ <section id="chap-documentation_guide-publican-TipsAndTricks">
+ <title>Tips and Tricks</title>
+ <para>
+ <remark>Hic sunt leones.</remark>
+ </para>
+ </section>
</chapter>
More information about the docs-commits
mailing list