summaryrefslogtreecommitdiffstats
path: root/po/documentation-guide.pot
diff options
context:
space:
mode:
Diffstat (limited to 'po/documentation-guide.pot')
-rw-r--r--po/documentation-guide.pot194
1 files changed, 119 insertions, 75 deletions
diff --git a/po/documentation-guide.pot b/po/documentation-guide.pot
index 5f5841f..946d40a 100644
--- a/po/documentation-guide.pot
+++ b/po/documentation-guide.pot
@@ -1,7 +1,7 @@
msgid ""
msgstr ""
"Project-Id-Version: PACKAGE VERSION\n"
-"POT-Creation-Date: 2007-08-03 12:42-0400\n"
+"POT-Creation-Date: 2007-11-14 21:12-0500\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
@@ -50,22 +50,30 @@ msgid "Guidelines and procedures for producing documentation for Fedora"
msgstr ""
#: en_US/rpm-info.xml:38(details)
-msgid "Add new chapter on publishing"
+msgid "Add link to DocBook XML help for Windows"
msgstr ""
#: en_US/rpm-info.xml:42(details)
-msgid "Include information on LINGUAS usage"
+msgid "Add guidance on CVS web access and previewing work"
msgstr ""
#: en_US/rpm-info.xml:46(details)
-msgid "Remove unnecessary chapter on XML tags"
+msgid "Add new chapter on publishing"
msgstr ""
#: en_US/rpm-info.xml:50(details)
+msgid "Include information on LINGUAS usage"
+msgstr ""
+
+#: en_US/rpm-info.xml:54(details)
+msgid "Remove unnecessary chapter on XML tags"
+msgstr ""
+
+#: en_US/rpm-info.xml:58(details)
msgid "Assorted fixes to reflect newer version of reality"
msgstr ""
-#: en_US/rpm-info.xml:57(details)
+#: en_US/rpm-info.xml:65(details)
msgid "Update to new content and build requirements"
msgstr ""
@@ -146,172 +154,180 @@ msgstr ""
msgid "cd ~/fedora\ncvs -d :ext:<placeholder-1/>@cvs.fedoraproject.org:/cvs/fedora co web"
msgstr ""
+#: en_US/publishing.xml:64(title)
+msgid "Web CVS Access"
+msgstr ""
+
#: en_US/publishing.xml:65(para)
+msgid "You must have access to the <systemitem>cvsweb</systemitem> module through the Fedora Account System to check in changes. If you do not have access, you can use <userinput><![CDATA[:pserver:anonymous]]></userinput> in place of <userinput><![CDATA[:ext:username]]></userinput> above. Visit the Fedora Account System at <ulink url=\"http://admin.fedoraproject.org/accounts/\"/> for more information."
+msgstr ""
+
+#: en_US/publishing.xml:77(para)
msgid "Edit the <filename>/etc/hosts</filename> file and add the following line <emphasis>after</emphasis> all other lines:"
msgstr ""
-#: en_US/publishing.xml:68(screen)
+#: en_US/publishing.xml:80(screen)
#, no-wrap
msgid "127.0.0.1 docs.localhost.localdomain"
msgstr ""
-#: en_US/publishing.xml:71(para)
+#: en_US/publishing.xml:83(para)
msgid "Create a file <filename>/etc/httpd/conf.d/fpo.conf</filename> with the following content:"
msgstr ""
-#: en_US/publishing.xml:85(para)
+#: en_US/publishing.xml:97(para)
msgid "Create a file <filename>/etc/php.d/fpo.ini</filename> with the following content:"
msgstr ""
-#: en_US/publishing.xml:87(screen)
+#: en_US/publishing.xml:99(screen)
#, no-wrap
msgid "include_path = \".:/var/www/fedora/web/include\""
msgstr ""
-#: en_US/publishing.xml:90(para)
+#: en_US/publishing.xml:102(para)
msgid "Start the web server using the following command:"
msgstr ""
-#: en_US/publishing.xml:91(screen)
+#: en_US/publishing.xml:103(screen)
#, no-wrap
msgid "su -c '/sbin/service httpd start'"
msgstr ""
-#: en_US/publishing.xml:92(para)
+#: en_US/publishing.xml:104(para)
msgid "To have the web server start at every boot, use the following command:"
msgstr ""
-#: en_US/publishing.xml:94(screen)
+#: en_US/publishing.xml:106(screen)
#, no-wrap
msgid "su -c '/sbin/chkconfig httpd on'"
msgstr ""
-#: en_US/publishing.xml:97(para)
+#: en_US/publishing.xml:109(para)
msgid "To test the new sandbox site, open a Web browser and point it at the URL <uri>http://docs.localhost.localdomain</uri>."
msgstr ""
-#: en_US/publishing.xml:101(title)
+#: en_US/publishing.xml:113(title)
msgid "Creating a New Publication"
msgstr ""
-#: en_US/publishing.xml:103(title)
+#: en_US/publishing.xml:115(title)
msgid "General Guidelines"
msgstr ""
-#: en_US/publishing.xml:104(para)
+#: en_US/publishing.xml:116(para)
msgid "Follow these guidelines to ensure maintainability and ease of use for all publishers."
msgstr ""
-#: en_US/publishing.xml:108(para)
+#: en_US/publishing.xml:120(para)
msgid "Use a short, descriptive name for the document directory. The module name from its Docs CVS location is usually appropriate. Good examples include <filename class=\"directory\">install-guide/</filename> or <filename class=\"directory\">example-tutorial/</filename>."
msgstr ""
-#: en_US/publishing.xml:115(para)
+#: en_US/publishing.xml:127(para)
msgid "Under the document directory, include a branch directory if the document references specific features of a particular Fedora release."
msgstr ""
-#: en_US/publishing.xml:120(para)
+#: en_US/publishing.xml:132(para)
msgid "Under the branch directory (or document directory if no branches are necessary), make at least a <filename class=\"directory\">en_US/</filename> directory. Make an additional directory for each locale that has been fully translated."
msgstr ""
-#: en_US/publishing.xml:129(title)
+#: en_US/publishing.xml:141(title)
msgid "Adding Content"
msgstr ""
-#: en_US/publishing.xml:130(para)
+#: en_US/publishing.xml:142(para)
msgid "To add content, follow the procedure below. The following commands show an example of adding content for a new document called the <citetitle>Foobar Tutorial</citetitle>. This document includes a translation for the \"zz_XX\" locale and follows specifics of each Fedora release."
msgstr ""
-#: en_US/publishing.xml:137(para)
+#: en_US/publishing.xml:149(para)
msgid "Make the required directory structure."
msgstr ""
-#: en_US/publishing.xml:138(screen)
+#: en_US/publishing.xml:150(screen)
#, no-wrap
msgid "cd ~/fedora/web/html/docs/\nmkdir foobar-tutorial\nmkdir foobar-tutorial/f7\nmkdir foobar-tutorial/f7/{en_US,zz_XX}"
msgstr ""
-#: en_US/publishing.xml:144(para)
+#: en_US/publishing.xml:156(para)
msgid "Build the HTML version of each translation of the document from Docs CVS."
msgstr ""
-#: en_US/publishing.xml:146(replaceable)
+#: en_US/publishing.xml:158(replaceable)
msgid "~/my-docs/foobar-tutorial/F-7/"
msgstr ""
-#: en_US/publishing.xml:146(screen)
+#: en_US/publishing.xml:158(screen)
#, no-wrap
msgid "cd <placeholder-1/>\nmake html-en_US html-zz_XX"
msgstr ""
-#: en_US/publishing.xml:150(para)
+#: en_US/publishing.xml:162(para)
msgid "Copy the HTML content to the web sandbox."
msgstr ""
-#: en_US/publishing.xml:151(screen)
+#: en_US/publishing.xml:163(screen)
#, no-wrap
msgid "cd ~/fedora/web/html/docs/foobar-tutorial/f7/\ncp -r ~/my-docs/foobar-tutorial/F-7/foobar-tutorial-en_US/ en_US/\ncp -r ~/my-docs/foobar-tutorial/F-7/foobar-tutorial-zz_XX/ zz_XX/"
msgstr ""
-#: en_US/publishing.xml:156(para)
+#: en_US/publishing.xml:168(para)
msgid "Convert the HTML in each directory to PHP using the provided <filename>docbookhtml2php.py</filename> script."
msgstr ""
-#: en_US/publishing.xml:165(para)
+#: en_US/publishing.xml:177(para)
msgid "Create any necessary <filename>index.php</filename> files for the overall directories. Each document and branch directory must have an <filename>index.php</filename> file directing users to appropriate content. In this example, the necessary files are <filename>foobar-tutorial/index.php</filename> and <filename>foobar-tutorial/f7/index.php</filename>. You do not need to write these files from scratch. Copy an existing file from another document, and change it as needed to suit the new document."
msgstr ""
-#: en_US/publishing.xml:175(para)
+#: en_US/publishing.xml:187(para)
msgid "Depending on content, publication may include changing a higher-level <filename>index.php</filename> file."
msgstr ""
-#: en_US/publishing.xml:179(para)
+#: en_US/publishing.xml:191(para)
msgid "To test the changes in your sandbox, open a web browser and point it at <uri>http://docs.localhost.localdomain/</uri>."
msgstr ""
-#: en_US/publishing.xml:183(title)
+#: en_US/publishing.xml:195(title)
msgid "Always Test Changes"
msgstr ""
-#: en_US/publishing.xml:184(para)
+#: en_US/publishing.xml:196(para)
msgid "<emphasis>Do not proceed further until you test all changes.</emphasis> Check that all links and index pages work."
msgstr ""
-#: en_US/publishing.xml:192(title)
+#: en_US/publishing.xml:204(title)
msgid "Pushing Content to the Web"
msgstr ""
-#: en_US/publishing.xml:193(para)
+#: en_US/publishing.xml:205(para)
msgid "To push your new content to the web site, follow this procedure:"
msgstr ""
-#: en_US/publishing.xml:197(para)
+#: en_US/publishing.xml:209(para)
msgid "Add all the new file content to CVS."
msgstr ""
-#: en_US/publishing.xml:198(screen)
+#: en_US/publishing.xml:210(screen)
#, no-wrap
msgid "cd ~/fedora/web/html/docs/\ncvs add foobar-tutorial\ncd foobar-tutorial\ncvs add f7\ncd f7\ncvs add en_US/ zz_XX/\ncvs add en_US/*php en_US/stylesheet-images/\ncvs add zz_XX/*php zz_XX/stylesheet-images/\ncvs add en_US/stylesheet-images/*png\ncvs add zz_XX/stylesheet-images/*png\ncd ../../\ncvs add foobar-tutorial/index.php\ncvs add foobar-tutorial/f7/index.php\n"
msgstr ""
-#: en_US/publishing.xml:214(para)
+#: en_US/publishing.xml:226(para)
msgid "Commit the changes to CVS. Use a message that describes the document being committed."
msgstr ""
-#: en_US/publishing.xml:216(replaceable)
+#: en_US/publishing.xml:228(replaceable)
msgid "message about document"
msgstr ""
-#: en_US/publishing.xml:216(screen)
+#: en_US/publishing.xml:228(screen)
#, no-wrap
msgid "cvs ci -m '<placeholder-1/>' foobar-tutorial/"
msgstr ""
-#: en_US/publishing.xml:219(para)
+#: en_US/publishing.xml:231(para)
msgid "Tag the content <systemitem>LIVE</systemitem> in CVS."
msgstr ""
-#: en_US/publishing.xml:221(screen)
+#: en_US/publishing.xml:233(screen)
#, no-wrap
msgid "cvs tag -F LIVE foobar-tutorial/"
msgstr ""
@@ -1838,7 +1854,7 @@ msgid "XML Entities"
msgstr ""
#: en_US/style.xml:1951(para)
-msgid "Use the entities provided by the Fedora Documentation Project. These entities are found in the <filename>common/</filename> folder in the <filename>fedora-docs</filename> distribution. (Refer also to <xref linkend=\"ch-getting-files\"/>.) For instance, do not use abbreviations such as \"FC2.\" Instead, use the predefined entities \"&amp;FC; &amp;FCVER;,\" which produces the text \"Fedora 7.\""
+msgid "Use the entities provided by the Fedora Documentation Project. These entities are found in the <filename>common/</filename> folder in the <filename>fedora-docs</filename> distribution. (Refer also to <xref linkend=\"ch-getting-files\"/>.) For instance, do not use abbreviations such as \"FC2.\" Instead, use the predefined entities \"&amp;FC; &amp;FCVER;,\" which produces the text \"Fedora 8.\""
msgstr ""
#: en_US/writing-guidelines.xml:11(title)
@@ -2283,6 +2299,30 @@ msgstr ""
msgid " 2564 ? S 0:23 /usr/sbin/sshd\n 3092 ? S 0:00 /usr/bin/ssh-agent /etc/X11/xinit/Xclients\n 8032 pts/0 S 0:00 ssh user@host.example.com\n 8032 pts/1 S 0:00 ssh root@backup.example.com"
msgstr ""
+#: en_US/writing-guidelines.xml:648(title)
+msgid "Previewing Your Work"
+msgstr ""
+
+#: en_US/writing-guidelines.xml:649(para)
+msgid "The GNOME <application>Help</application> browser, also known as <command>yelp</command>, and the KDE <application>Khelp</application> documentation browser can render DocBook XML information as needed. Use these applications to preview your work if you prefer reading your work in a browser-like environment. Run the following command:"
+msgstr ""
+
+#: en_US/writing-guidelines.xml:656(para)
+msgid "Make sure to point the preferred help browser at the top parent file of your XML document. Once the document loads, you can add a bookmark for it for ease of use later."
+msgstr ""
+
+#: en_US/writing-guidelines.xml:660(title)
+msgid "Using Bookmarks"
+msgstr ""
+
+#: en_US/writing-guidelines.xml:661(para)
+msgid "Keeping your documents in the same place for every checkout session makes help browser bookmarks more effective."
+msgstr ""
+
+#: en_US/writing-guidelines.xml:664(para)
+msgid "Once you have a bookmark stored, it will appear in the help browser at every use. You can now hit <keycap>F1</keycap> during any GUI session to launch the help browser. Then choose your bookmark from the menu to preview your document at any time."
+msgstr ""
+
#: en_US/module-struct.xml:12(title)
msgid "How Modules Work"
msgstr ""
@@ -2815,124 +2855,128 @@ msgstr ""
msgid "DocBook XML, like a computer program, has version numbers. The version used by Fedora Documentation Project right now is 4.4. The DocBook web site may document a slightly newer version, but the majority of the schema still applies."
msgstr ""
-#: en_US/getting-files.xml:106(title)
+#: en_US/getting-files.xml:103(para)
+msgid "Contributors who use the Microsoft Windows operating system can still make use of DocBook tools. For more information, refer to <ulink url=\"http://www.codeproject.com/winhelp/docbook_howto.asp\"/>."
+msgstr ""
+
+#: en_US/getting-files.xml:110(title)
msgid "Naming Conventions"
msgstr ""
-#: en_US/getting-files.xml:107(para)
+#: en_US/getting-files.xml:111(para)
msgid "The Fedora Documentation Project provides the tools, scripts, and stylesheets to transform your <abbrev>XML</abbrev> documents into other output formats such as <abbrev>HTML</abbrev>. In addition, these tools can build your document into a <abbrev>RPM</abbrev> package. To take advantage of these services, follow the conventions in this section to name your files."
msgstr ""
-#: en_US/getting-files.xml:115(para)
+#: en_US/getting-files.xml:119(para)
msgid "On the CVS server, directories that contain document files are called <firstterm>modules</firstterm>. Each module represents a single document. Each document may consist of several <firstterm>branches</firstterm> if that document changes with each release of Fedora. Contributors can check out single branches of these modules or the entire module. Each document or branch may contain multiple XML source files."
msgstr ""
-#: en_US/getting-files.xml:122(para)
+#: en_US/getting-files.xml:126(para)
msgid "Use the <command>cvs co -c</command> command to view existing module names."
msgstr ""
-#: en_US/getting-files.xml:125(title)
+#: en_US/getting-files.xml:129(title)
msgid "Partial List of CVS Modules"
msgstr ""
-#: en_US/getting-files.xml:126(userinput)
+#: en_US/getting-files.xml:130(userinput)
#, no-wrap
msgid "cd ~/localrepo/fedora-docs/"
msgstr ""
-#: en_US/getting-files.xml:145(para)
+#: en_US/getting-files.xml:149(para)
msgid "The leftmost entry in each line is the name of a module you can check out from CVS. The rest of the line ensures that checkouts include the proper branch of a document and the common build tools. For more information on CVS, refer to <xref linkend=\"ch-cvs\"/>."
msgstr ""
-#: en_US/getting-files.xml:150(para)
+#: en_US/getting-files.xml:154(para)
msgid "Note in the listing above that the <systemitem>about-fedora</systemitem> module has two branches available. One branch is for Fedora 7 and one is for forward development to match the current work of developers. On the other hand, the <systemitem>documentation-guide</systemitem> module is not branched."
msgstr ""
-#: en_US/getting-files.xml:157(title)
+#: en_US/getting-files.xml:161(title)
msgid "Modules Labeled <filename>-dir</filename>"
msgstr ""
-#: en_US/getting-files.xml:158(para)
+#: en_US/getting-files.xml:162(para)
msgid "Modules ending with the suffix <filename>-dir</filename> are not usually helpful to checkout directly. These modules do not include the common build tools and thus do not provide many of the functions contributors require."
msgstr ""
-#: en_US/getting-files.xml:164(title)
+#: en_US/getting-files.xml:168(title)
msgid "Module Names"
msgstr ""
-#: en_US/getting-files.xml:165(para)
+#: en_US/getting-files.xml:169(para)
msgid "Choose a module name that accurately reflects your document's subject, but avoid any name already taken. The document title without any use of the word <wordasword>fedora</wordasword> is a reasonable choice in most cases. Use the length descriptors <wordasword>tutorial</wordasword> or <wordasword>guide</wordasword> in the module name where appropriate."
msgstr ""
-#: en_US/getting-files.xml:174(title)
+#: en_US/getting-files.xml:178(title)
msgid "Avoid Redundancy"
msgstr ""
-#: en_US/getting-files.xml:175(para)
+#: en_US/getting-files.xml:179(para)
msgid "Do not use the word <wordasword>fedora</wordasword> to name modules in the Fedora Documentation Project CVS repository."
msgstr ""
-#: en_US/getting-files.xml:181(title)
+#: en_US/getting-files.xml:185(title)
msgid "Correct Module Naming"
msgstr ""
-#: en_US/getting-files.xml:182(segtitle)
+#: en_US/getting-files.xml:186(segtitle)
msgid "Document Name"
msgstr ""
-#: en_US/getting-files.xml:183(segtitle)
+#: en_US/getting-files.xml:187(segtitle)
msgid "CVS Module Name"
msgstr ""
-#: en_US/getting-files.xml:185(seg)
+#: en_US/getting-files.xml:189(seg)
msgid "Desktop User Guide"
msgstr ""
-#: en_US/getting-files.xml:186(seg)
+#: en_US/getting-files.xml:190(seg)
msgid "desktop-user-guide"
msgstr ""
-#: en_US/getting-files.xml:190(application)
+#: en_US/getting-files.xml:194(application)
msgid "Yum"
msgstr ""
-#: en_US/getting-files.xml:189(seg)
+#: en_US/getting-files.xml:193(seg)
msgid "Software Management with <placeholder-1/>"
msgstr ""
-#: en_US/getting-files.xml:191(seg)
+#: en_US/getting-files.xml:195(seg)
msgid "yum-guide"
msgstr ""
-#: en_US/getting-files.xml:194(application)
+#: en_US/getting-files.xml:198(application)
msgid "Pup"
msgstr ""
-#: en_US/getting-files.xml:194(seg)
+#: en_US/getting-files.xml:198(seg)
msgid "Using <placeholder-1/>"
msgstr ""
-#: en_US/getting-files.xml:195(seg)
+#: en_US/getting-files.xml:199(seg)
msgid "pup-tutorial"
msgstr ""
-#: en_US/getting-files.xml:200(title)
+#: en_US/getting-files.xml:204(title)
msgid "File Names"
msgstr ""
-#: en_US/getting-files.xml:201(para)
+#: en_US/getting-files.xml:205(para)
msgid "Follow these guidelines for naming files to make collaboration and document reuse easy:"
msgstr ""
-#: en_US/getting-files.xml:205(para)
+#: en_US/getting-files.xml:209(para)
msgid "As with module names, avoid using the word <wordasword>fedora</wordasword> in file names since it is redundant."
msgstr ""
-#: en_US/getting-files.xml:210(para)
+#: en_US/getting-files.xml:214(para)
msgid "If the document is comprised of many XML files, avoid repeating the name of the document when naming the constituent files."
msgstr ""
-#: en_US/getting-files.xml:215(para)
+#: en_US/getting-files.xml:219(para)
msgid "Avoid numbering files to show order, since editors and authors often rearrange documents or reuse their files in other documents."
msgstr ""