msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "POT-Creation-Date: 2008-05-13 02:06+1000\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" #: en_US/rpm-info.xml:22(rights) msgid "OPL" msgstr "" #: en_US/rpm-info.xml:23(version) msgid "1.0" msgstr "" #: en_US/rpm-info.xml:26(year) msgid "2003" msgstr "" #: en_US/rpm-info.xml:27(year) msgid "2004" msgstr "" #: en_US/rpm-info.xml:28(year) msgid "2005" msgstr "" #: en_US/rpm-info.xml:29(year) msgid "2006" msgstr "" #: en_US/rpm-info.xml:30(year) msgid "2007" msgstr "" #: en_US/rpm-info.xml:31(year) msgid "2008" msgstr "" #: en_US/rpm-info.xml:32(holder) msgid "Red Hat, Inc. and others" msgstr "" #: en_US/rpm-info.xml:34(title) msgid "Fedora Documentation Guide" msgstr "" #: en_US/rpm-info.xml:35(desc) msgid "Guidelines and procedures for producing documentation for Fedora" msgstr "" #: en_US/rpm-info.xml:39(details) msgid "Add L10n chapter (#441190)" msgstr "" #: en_US/rpm-info.xml:43(details) msgid "Fix some organization and missing targets (#371531)" msgstr "" #: en_US/rpm-info.xml:47(details) msgid "Add link to DocBook XML help for Windows" msgstr "" #: en_US/rpm-info.xml:51(details) msgid "Add guidance on CVS web access and previewing work" msgstr "" #: en_US/rpm-info.xml:55(details) msgid "Add new chapter on publishing" msgstr "" #: en_US/rpm-info.xml:59(details) msgid "Include information on LINGUAS usage" msgstr "" #: en_US/rpm-info.xml:63(details) msgid "Remove unnecessary chapter on XML tags" msgstr "" #: en_US/rpm-info.xml:67(details) msgid "Assorted fixes to reflect newer version of reality" msgstr "" #: en_US/rpm-info.xml:74(details) msgid "Update to new content and build requirements" msgstr "" #: en_US/l10n.xml:13(title) msgid "Localization (L10n)" msgstr "" #: en_US/l10n.xml:14(para) msgid "This chapter discusses how translations are provided in Fedora documentation." msgstr "" #: en_US/l10n.xml:19(title) msgid "PO Files" msgstr "" #: en_US/l10n.xml:20(para) msgid "The cornerstone of translation when using XML files such as DocBook is the Portable Object or PO file. PO files provide a way for independent individuals or teams to translate documents. The Fedora Documentation Project toolchain includes rules for creating, updating, and maintaining these PO files." msgstr "" #: en_US/l10n.xml:28(para) msgid "PO files are usually found in two forms:" msgstr "" #: en_US/l10n.xml:33(para) msgid "the .pot file, or PO Template (POT)" msgstr "" #: en_US/l10n.xml:41(para) msgid "the .po file, or translation file (PO)" msgstr "" #: en_US/l10n.xml:47(para) msgid "A POT is, as the name suggests, a blank template for new translations. It contains some header information and a list of strings based on the content of the original XML file from which it was created. Translators do not alter the POT. The POT should only be changed after changes are made to the original XML file from which it is derived." msgstr "" #: en_US/l10n.xml:55(para) msgid "A translator who wishes to start working on a new language copies the POT to a locale-specific PO file. Then the translator uses any of a number of command-line or graphical tools to translate each of the strings in the list. A single POT is used to create many POs, one for each locale. These files are normally named for their locale code, such as de.po, it.po, and so on." msgstr "" #: en_US/l10n.xml:67(title) msgid "Creating or Updating a POT" msgstr "" #: en_US/l10n.xml:68(para) msgid "The POT is named after the document from which it is derived. If document named in the Makefile) is foo-tutorial.xml, the POT is named foo-tutorial.pot." msgstr "" #: en_US/l10n.xml:74(para) msgid "To create a new POT, use the following command:" msgstr "" #: en_US/l10n.xml:78(para) msgid "The same command is used to update the POT when the original XML sources change." msgstr "" #: en_US/l10n.xml:83(title) msgid "Keep POT Fresh" msgstr "" #: en_US/l10n.xml:84(para) msgid "Update the POT whenever the original XML changes. Many translators' tools automatically notify them of the change so they can update translations quickly." msgstr "" #: en_US/l10n.xml:92(title) msgid "Updating PO Files" msgstr "" #: en_US/l10n.xml:93(para) msgid "The translation files are created by the individual translators, and document maintainers do not normally need to create them. Translators update a list of locales in the po/LINGUAS file which defines all the locales for which translations exist." msgstr "" #: en_US/l10n.xml:100(para) msgid "Whenever the source XML files are updated, the maintainer must at least update the POT. It is helpful, however, to also merge these changes with the existing translations for those translators who are not automatically notified of changes." msgstr "" #: en_US/l10n.xml:107(title) msgid "Staying Current" msgstr "" #: en_US/l10n.xml:108(para) msgid "Always make sure your local copy of PO is fresh, using the CVS \"update\" command:" msgstr "" #: en_US/l10n.xml:114(para) msgid "To merge new changes into the existing PO translations, use the following command:" msgstr "" #: en_US/l10n.xml:121(title) msgid "Checking Statistics" msgstr "" #: en_US/l10n.xml:122(para) msgid "PO strings fall into three categories:" msgstr "" #: en_US/l10n.xml:127(para) msgid "translated, meaning the string has been handled by a translator and its source has not changed since then" msgstr "" #: en_US/l10n.xml:134(para) msgid "fuzzy, meaning the string has changed since it was last handled by a translator" msgstr "" #: en_US/l10n.xml:140(para) msgid "untranslated, meaning no translation has yet been provided for this string, or it is brand new" msgstr "" #: en_US/l10n.xml:146(para) msgid "To see a rough statistical tally of the string handling inside the PO for a module, use the following command:" msgstr "" #: en_US/l10n.xml:151(para) msgid "For each locale in the list, a count is shown of translated, fuzzy, and untranslated strings in that order. Tallies that only provide two numerals are usually translated followed by untranslated. Tallies with only one numeral are usually fully translated." msgstr "" #: en_US/l10n.xml:158(para) msgid "To see only a specific locale, append a dash and the locale code to the postat target:" msgstr "" #: en_US/publishing.xml:11(title) msgid "Publishing Official Documentation" msgstr "" #: en_US/publishing.xml:12(para) msgid "This chapter shows how to publish official Fedora Documentation Project work to the docs.fedoraproject.org website. To publish official documentation, you must be approved to write to the web repository in CVS. Access for publishing is limited to contributors who have demonstrated capacity for working with CVS and other project tools. Once you have acquired and are comfortable with these skills, contributions as a publisher are welcome." msgstr "" #: en_US/publishing.xml:21(title) msgid "How the Site Works" msgstr "" #: en_US/publishing.xml:22(para) msgid "The docs.fedoraproject.org website is a set of PHP files and scripts. Publishers maintain these files in a CVS repository, and the website host retrieves them hourly to refresh the site. The host does not automatically use the newest content for the website. Instead, it pulls files with the CVS tag LIVE to populate the website." msgstr "" #: en_US/publishing.xml:30(para) msgid "Each publisher sets up a local testing website on an available Fedora system. This site, sometimes called a sandbox, allows the publisher to test and view changes to documents, and ensure stability on the public site." msgstr "" #: en_US/publishing.xml:37(title) msgid "Setting Up a Web Sandbox" msgstr "" #: en_US/publishing.xml:38(para) msgid "To test document publishing, first set up a web sandbox on a local Fedora system." msgstr "" #: en_US/publishing.xml:42(para) msgid "Install the \"Web Server\" package group:" msgstr "" #: en_US/publishing.xml:43(screen) #, no-wrap msgid "su -c 'yum groupinstall \"Web Server\"'" msgstr "" #: en_US/publishing.xml:46(para) msgid "Create a folder for the web server to access the site files." msgstr "" #: en_US/publishing.xml:48(screen) #, no-wrap msgid "su -c 'mkdir /var/www/fedora'" msgstr "" #: en_US/publishing.xml:51(para) msgid "Change the permissions on this directory to make it easier to access for your normal user account." msgstr "" #: en_US/publishing.xml:53(replaceable) en_US/publishing.xml:62(replaceable) msgid "username" msgstr "" #: en_US/publishing.xml:53(screen) #, no-wrap msgid "su -c 'chown /var/www/fedora'" msgstr "" #: en_US/publishing.xml:56(para) msgid "Link to the new directory from your home directory." msgstr "" #: en_US/publishing.xml:57(screen) #, no-wrap msgid "ln -s /var/www/fedora ~/fedora" msgstr "" #: en_US/publishing.xml:60(para) msgid "Retrieve the web module from CVS." msgstr "" #: en_US/publishing.xml:61(screen) #, no-wrap msgid "cd ~/fedora\ncvs -d :ext:@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 cvsweb module through the Fedora Account System to check in changes. If you do not have access, you can use in place of above. Visit the Fedora Account System at for more information." msgstr "" #: en_US/publishing.xml:77(para) msgid "Edit the /etc/hosts file and add the following line after all other lines:" msgstr "" #: en_US/publishing.xml:80(screen) #, no-wrap msgid "127.0.0.1 docs.localhost.localdomain" msgstr "" #: en_US/publishing.xml:83(para) msgid "Create a file /etc/httpd/conf.d/fpo.conf with the following content:" msgstr "" #: en_US/publishing.xml:97(para) msgid "Create a file /etc/php.d/fpo.ini with the following content:" msgstr "" #: en_US/publishing.xml:99(screen) #, no-wrap msgid "include_path = \".:/var/www/fedora/web/include\"" msgstr "" #: en_US/publishing.xml:102(para) msgid "Start the web server using the following command:" msgstr "" #: en_US/publishing.xml:103(screen) #, no-wrap msgid "su -c '/sbin/service httpd start'" msgstr "" #: 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:106(screen) #, no-wrap msgid "su -c '/sbin/chkconfig httpd on'" msgstr "" #: en_US/publishing.xml:109(para) msgid "To test the new sandbox site, open a Web browser and point it at the URL http://docs.localhost.localdomain." msgstr "" #: en_US/publishing.xml:113(title) msgid "Creating a New Publication" msgstr "" #: en_US/publishing.xml:115(title) msgid "General Guidelines" msgstr "" #: 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: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 install-guide/ or example-tutorial/." msgstr "" #: 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:132(para) msgid "Under the branch directory (or document directory if no branches are necessary), make at least a en_US/ directory. Make an additional directory for each locale that has been fully translated." msgstr "" #: en_US/publishing.xml:141(title) msgid "Adding Content" msgstr "" #: 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 Foobar Tutorial. This document includes a translation for the \"zz_XX\" locale and follows specifics of each Fedora release." msgstr "" #: en_US/publishing.xml:149(para) msgid "Make the required directory structure." msgstr "" #: 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:156(para) msgid "Build the HTML version of each translation of the document from Docs CVS." msgstr "" #: en_US/publishing.xml:158(replaceable) msgid "~/my-docs/foobar-tutorial/F-7/" msgstr "" #: en_US/publishing.xml:158(screen) #, no-wrap msgid "cd \nmake html-en_US html-zz_XX" msgstr "" #: en_US/publishing.xml:162(para) msgid "Copy the HTML content to the web sandbox." msgstr "" #: 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:168(para) msgid "Convert the HTML in each directory to PHP using the provided docbookhtml2php.py script." msgstr "" #: en_US/publishing.xml:177(para) msgid "Create any necessary index.php files for the overall directories. Each document and branch directory must have an index.php file directing users to appropriate content. In this example, the necessary files are foobar-tutorial/index.php and foobar-tutorial/f7/index.php. 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:187(para) msgid "Depending on content, publication may include changing a higher-level index.php file." msgstr "" #: en_US/publishing.xml:191(para) msgid "To test the changes in your sandbox, open a web browser and point it at http://docs.localhost.localdomain/." msgstr "" #: en_US/publishing.xml:195(title) msgid "Always Test Changes" msgstr "" #: en_US/publishing.xml:196(para) msgid "Do not proceed further until you test all changes. Check that all links and index pages work." msgstr "" #: en_US/publishing.xml:204(title) msgid "Pushing Content to the Web" msgstr "" #: en_US/publishing.xml:205(para) msgid "To push your new content to the web site, follow this procedure:" msgstr "" #: en_US/publishing.xml:209(para) msgid "Add all the new file content to CVS." msgstr "" #: 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:226(para) msgid "Commit the changes to CVS. Use a message that describes the document being committed." msgstr "" #: en_US/publishing.xml:228(replaceable) msgid "message about document" msgstr "" #: en_US/publishing.xml:228(screen) #, no-wrap msgid "cvs ci -m '' foobar-tutorial/" msgstr "" #: en_US/publishing.xml:231(para) msgid "Tag the content LIVE in CVS." msgstr "" #: en_US/publishing.xml:233(screen) #, no-wrap msgid "cvs tag -F LIVE foobar-tutorial/" msgstr "" #: en_US/vim.xml:13(title) msgid "VIM and DocBook" msgstr "" #: en_US/vim.xml:16(primary) en_US/vim.xml:33(primary) msgid "VIM" msgstr "" #: en_US/vim.xml:19(para) msgid "VIM has many features to help you write XML content such as DocBook, including syntax highlighting and customizable key bindings. Additionally, one can easily use external programs from VIM for features such as spell-checking. This chapter assumes you already know generally how to use VIM; if you want to learn how, try the vimtutor or by typing :help tutor from inside VIM." msgstr "" #: en_US/vim.xml:30(title) msgid "Setting Up Your .vimrc File" msgstr "" #: en_US/vim.xml:34(secondary) en_US/emacs.xml:44(secondary) msgid "configuration file" msgstr "" #: en_US/vim.xml:37(para) msgid "Below is a short sample .vimrc file that turns on some VIM features useful for editing SGML or XML content such as DocBook: \n\" Turn off vi compatibility settings like limited undo\nset nocompatible\n\" Syntax highlighting based on file extension\nsyntax on\n\" Automatically insert newlines after 80 characters\nset textwidth=80\n\" Automatically indent\nset autoindent\n\" Match SGML tags with %\nsource $VIMRUNTIME/macros/matchit.vim\n" msgstr "" #: en_US/vim.xml:55(para) msgid "Some of these features require the vim-enhanced package to be installed. If you are using or the vim-minimal package, or if you are using an older version of VIM, you may not have the $VIMRUNTIME/macros/matchit.vim file. You can still download matchit.zip from Vim.org and load it separately." msgstr "" #: en_US/vim.xml:69(title) msgid "Keymapping with VIM" msgstr "" #: en_US/vim.xml:71(para) msgid "VIM can speed up your DocBook creation by mapping frequently typed tags (or any words or phrases) onto short key combinations. By default, the keymap leader is the backslash (\\), but it can be redefined with a command like let mapleader =\n \",\". There are two ways to use the following example; you can put it directly in your .vimrc, or you can save it in a separate file and load it with a source command in your .vimrc. \ne />:nohlsearcha\n\n\" common tags that start a new text block\nimappa O\nimapsn
jo
O\nimappl O0i\nimapcp O0i\n\n\" common tags that are placed inline\n\" use F>a\nimapen F>a\nimapfi F>a\nimaplt F>a\nimapre F>a\nimapui F>a\nimapul F>a\nimapsi F>a\nimapus F>a\nimapsy F>a\nimapcm F>a \n\" entities\nimap > >\nimap < <]]>\n
" msgstr "" #: en_US/vim.xml:110(para) msgid "Unfortunately, there is not currently a complete macro set for all DocBook commands, so you will need to define them yourself or customize the definitions in the examples from ." msgstr "" #: en_US/vim.xml:119(title) msgid "Additional VIM Resources" msgstr "" #: en_US/vim.xml:121(para) msgid "Additional information about VIM may be found from:" msgstr "" #: en_US/vim.xml:127(para) msgid " Example sgml-vimrc from the Beginner's guide to Vi Improved (VIM)" msgstr "" #: en_US/vim.xml:134(para) msgid "The VIM Quick Reference Card" msgstr "" #: en_US/vim.xml:140(ulink) msgid "Vim as XML Editor" msgstr "" #: en_US/vim.xml:145(para) msgid "The VIM REFERENCE MANUAL, which comes with the vim-common package —/usr/share/vim/<version>/doc/intro.txt or type :help intro from within VIM" msgstr "" #: en_US/tutorial.xml:13(title) msgid "The Layout of a Tutorial" msgstr "" #: en_US/tutorial.xml:14(para) msgid "In this chapter, you will find an example of a very short tutorial as used by the Fedora Documentation Project. This example is specific to the way the Docs Project uses DocBook XML. The example consists of a set of files used to hold the content and metadata for the tutorial." msgstr "" #: en_US/tutorial.xml:19(title) msgid "The Article" msgstr "" #: en_US/tutorial.xml:21(primary) en_US/tutorial.xml:56(primary) msgid "tutorial layout" msgstr "" #: en_US/tutorial.xml:22(secondary) msgid "article" msgstr "" #: en_US/tutorial.xml:24(para) msgid "Below is a sample article:" msgstr "" #: en_US/tutorial.xml:54(title) msgid "The Metadata" msgstr "" #: en_US/tutorial.xml:57(secondary) msgid "metadata" msgstr "" #: en_US/tutorial.xml:59(para) msgid "The rpm-info.xml file contains all the required metadata for the document. This metadata includes title, authorship, licensing, and revision history. illustrates the content of this file:" msgstr "" #: en_US/tutorial.xml:65(title) msgid "Example rpm-info.xml File" msgstr "" #: en_US/tutorial.xml:95(para) msgid "If you are not familiar with XML editing, copy and paste this file from an existing module and then edit the values for the various elements as appropriate. Consult Fedora Documentation Project members and help channels for more assistance if needed." msgstr "" #: en_US/style.xml:14(title) msgid "Style" msgstr "" #: en_US/style.xml:16(para) msgid "Writing good technical documentation is not simply reproducing command lines and instruction sets. Good documentation is easy to read, understand, and translate, and presents a concise logical progression of concepts. Good documentation can also be defined by what it does not contain. Your tutorial should avoid:" msgstr "" #: en_US/style.xml:26(para) msgid "Excessive wordiness" msgstr "" #: en_US/style.xml:31(para) msgid "Unnecessary or undefined jargon" msgstr "" #: en_US/style.xml:36(para) msgid "Grammatical or spelling errors" msgstr "" #: en_US/style.xml:41(para) msgid "References to yourself or your experiences" msgstr "" #: en_US/style.xml:46(para) msgid "Remarks which might offend or confuse any reader" msgstr "" #: en_US/style.xml:51(para) msgid "This chapter contains style rules and guidelines for writing Fedora documentation. Guidelines are not the same as rules. It is acceptable to violate a guideline when it makes your material easier to understand. Follow guidelines whenever possible, but follow rules at all times. Assume any advice is a guideline unless identified otherwise." msgstr "" #: en_US/style.xml:62(title) msgid "Why Style Is Important" msgstr "" #: en_US/style.xml:64(para) msgid "Writing well comes naturally to almost no one. It is a skill that professional writers, even famous ones, must practice constantly. Stylestyle is the quality that separates elegant writing from the merely functional." msgstr "" #: en_US/style.xml:77(para) msgid "For example, refer to. http://www.online-literature.com/james_joyce/ulysses/18/. Please note that this example contains some mature themes and language, and is not suitable for all readers." msgstr "" #: en_US/style.xml:71(para) msgid "Elegance comes in many forms. In prose and poetry, elegant writing may not follow some (or any) common rules of grammar, syntax, or spelling. A good example is Episode 18, \"Penelope,\" in James Joyce's novel Ulysses. There, Joyce uses long streams of words without punctuation to simulate a character's internal consciousness. By violating basic rules of grammar and syntax, Joyce simulates the disorganized but loosely connected thought patterns of the narrator." msgstr "" #: en_US/style.xml:89(para) msgid "Technical documentation, however, should always respect these rules. The more a document departs from standard language usage, the more difficult the material becomes for the reader. For example, readers may not be native speakers of the language used, or they might be reading a translation. If the writer uses slang, idioms, or jargon, a reader or translator may easily become confused. The following example compares two different written executions of the same idea:" msgstr "" #: en_US/style.xml:100(title) msgid "Incorrect style" msgstr "" #. I prefer "incorrect," because I think terms such as #. "problematic" are mealy-mouthed. They remind me of the late #. 1980's English textbook trend toward the politically correct yet #. wholly unhelpful "standard/nonstandard." But then, I tend to be #. dogmatic; it's probably my Catholic upbringing. [PWF] #: en_US/style.xml:108(para) msgid "So you made the changes I showed you in the last section. What's the next thing you should do? Just pop your thumb drive onto your system and read the messages log. When you see \"USB device found,\" then Bob's your uncle." msgstr "" #: en_US/style.xml:116(title) msgid "Correct style" msgstr "" #. I prefer "correct." See above. [PWF] #: en_US/style.xml:120(para) msgid "After you complete the configuration changes above, attach the USB removable media to your system. Use the dmesg command to examine the kernel message log. The message USB device\n\t found indicates that your device was installed successfully." msgstr "" #: en_US/style.xml:129(para) msgid "The first example is more conversational English, which is not appropriate for official written documentation. The second example is more formal, but as a result it is easier to comprehend, both for native readers and translators." msgstr "" #: en_US/style.xml:135(para) msgid "Following style rules and guidelines also makes readers more comfortable with a set of documents. Consistent style enhances the professional appearance of documentation, and its perceived value. On the other hand, lapses in punctuation or poor grammar negatively affect a reader's reaction to written material. A reader can feel that an otherwise correct technical document is lacking in authority, simply because it is poorly written. Readers feel at ease when they do not have to struggle to understand an author's use of language." msgstr "" #: en_US/style.xml:146(para) msgid "This chapter cannot possibly cover enough material to make every reader a good writer. Some manuals devoted entirely to writing style are themselves hundreds of pages long. This chapter provides enough guidelines for intermediate writers to understand style usage in technical documentation." msgstr "" #: en_US/style.xml:153(para) msgid "If you are not a practiced writer, whether of technical documentation or otherwise, you may benefit from other style resources. The following list is far from comprehensive, but provides a starting point:" msgstr "" #: en_US/style.xml:161(para) msgid "The Elements of Style, by William Strunk. Basic rules and links to online versions can be found at: http://en.wikipedia.org/wiki/The_Elements_of_Style" msgstr "" #: en_US/style.xml:176(para) msgid "The Chicago Manual of Style, by the University of Chicago Press. Online version: http://www.chicagomanualofstyle.org/" msgstr "" #: en_US/style.xml:183(para) msgid "Paradigm Online Writing Assistant, maintained by Chuck Guilford, Ph.D. Online only: http://www.powa.org/" msgstr "" #: en_US/style.xml:190(para) msgid "There are many free software documentation projects which have developed their own style guidelines. This chapter, in fact, draws heavily on the GNOME Documentation Style Guidelines (GDSG). You may read the original GDSG at http://developer.gnome.org/documents/style-guide/." msgstr "" #: en_US/style.xml:203(title) msgid "Fundamental Concepts of Technical Documentation" msgstr "" #: en_US/style.xml:206(title) msgid "Bibliographic Information" msgstr "" #: en_US/style.xml:207(para) msgid "This section is drawn primarily from the GDSG." msgstr "" #. This section will reproduce mostly what is in Chapter 1 of #. the GDSG. There may be minor changes. FIXME: Make sure the #. appropriate front matter of the Documentation Guide includes #. attribution as required by the GNU FDL. #: en_US/style.xml:218(para) msgid "This chapter provides a brief introduction to writing technical documentation." msgstr "" #: en_US/style.xml:224(title) msgid "General Style Requirements" msgstr "" #: en_US/style.xml:225(para) msgid "Technical writing for the Fedora Project imposes special constraints beyond the basic requirements of good prose. Good Fedora technical documentation has the following characteristics:" msgstr "" #: en_US/style.xml:232(term) msgid "Comprehensive" msgstr "" #: en_US/style.xml:234(para) msgid "Describe all of the functionality of a product. Do not omit functionality that you regard as irrelevant for the user." msgstr "" #: en_US/style.xml:242(term) msgid "Conforming" msgstr "" #: en_US/style.xml:249(para) msgid "Describe what you see. Do not describe what you want to see. Present your information in the order that users experience the subject matter." msgstr "" #: en_US/style.xml:257(term) msgid "Clear" msgstr "" #: en_US/style.xml:259(para) msgid "Read The Elements of Style (http://en.wikipedia.org/wiki/The_Elements_of_Style) to help make your writing clear." msgstr "" #: en_US/style.xml:275(term) msgid "Consistent" msgstr "" #: en_US/style.xml:277(para) msgid "Use agreed vocabulary throughout your documentation. Use the same vocabulary as other writers who are working on related documentation." msgstr "" #: en_US/style.xml:285(term) msgid "Concise" msgstr "" #: en_US/style.xml:287(para) msgid "Review your work frequently as you write your document. Ask yourself which words you can take out. Refer to for specific guidelines." msgstr "" #: en_US/style.xml:297(title) msgid "Golden Rules" msgstr "" #: en_US/style.xml:298(para) msgid "This section contains some basic style guidelines. Subsequent sections in this chapter expand on these guidelines to give more detailed guidance." msgstr "" #: en_US/style.xml:305(term) msgid "Golden Rule 1: Be brief" msgstr "" #: en_US/style.xml:309(para) msgid "Limit each sentence to fewer than 25 words." msgstr "" #: en_US/style.xml:314(para) msgid "Limit each procedure step to 23 words." msgstr "" #: en_US/style.xml:320(title) msgid "Incorrect: Too long" msgstr "" #: en_US/style.xml:321(para) msgid "Under normal operating conditions, the kernel does not always immediately write file data to the disks, storing it in a memory buffer and then periodically writing to the disks to speed up operations." msgstr "" #: en_US/style.xml:328(title) msgid "Correct: Less wordy" msgstr "" #: en_US/style.xml:329(para) msgid "Normally, the kernel stores the data in memory prior to periodically writing the data to the disk." msgstr "" #: en_US/style.xml:337(term) msgid "Golden Rule 2: Be organized" msgstr "" #: en_US/style.xml:341(para) msgid "Limit each paragraph to one topic." msgstr "" #: en_US/style.xml:346(para) msgid "Limit each sentence to one idea." msgstr "" #: en_US/style.xml:351(para) msgid "Limit each procedure step to one action." msgstr "" #: en_US/style.xml:357(title) msgid "Incorrect: Disorganized topics" msgstr "" #: en_US/style.xml:358(para) msgid "The Workspace Switcher applet helps you navigate all of the virtual desktops available on your system. The X Window system, working in hand with a piece of software called a window manager, allows you to create more than one virtual desktop, known as workspaces, to organize your work, with different applications running in each workspace. The Workspace Switcher applet is a navigational tool to get around the various workspaces, providing a miniature road map in the GNOME panel showing all your workspaces and allowing you to switch easily between them." msgstr "" #: en_US/style.xml:375(title) msgid "Correct: Organized topics" msgstr "" #: en_US/style.xml:376(para) msgid "Use the Workspace Switcher to add new workspaces to the GNOME Desktop. You can run different applications in each workspace. The Workspace Switcher applet provides a miniature map that shows all of your workspaces. You can use the Workspace Switcher applet to switch between workspaces." msgstr "" #: en_US/style.xml:388(para) msgid "Plan the order of paragraphs before you start writing. Decide which topic you want to cover in each paragraph." msgstr "" #: en_US/style.xml:396(term) msgid "Golden Rule 3: Be demonstrative" msgstr "" #: en_US/style.xml:398(para) msgid "Use explicit examples to demonstrate how an application works. Provide instructions rather than descriptions." msgstr "" #: en_US/style.xml:403(title) msgid "Incorrect: Describes but does not demonstrate" msgstr "" #: en_US/style.xml:405(para) msgid "There is a text box that you can use to find out the definition of a word." msgstr "" #: en_US/style.xml:411(title) msgid "Correct: Demonstrates usage" msgstr "" #: en_US/style.xml:412(para) msgid "To request a definition of a word, type the word in the text box, then select Lookup." msgstr "" #: en_US/style.xml:418(para) msgid "Do not apply this guideline too rigidly. Sometimes you must explain how software works to support your how-to examples." msgstr "" #: en_US/style.xml:427(term) msgid "Golden Rule 4: Be objective" msgstr "" #: en_US/style.xml:429(para) msgid "Write in a neutral tone." msgstr "" #: en_US/style.xml:433(title) msgid "Incorrect: Sentence takes sides" msgstr "" #: en_US/style.xml:434(para) msgid "The applet is a handy little screen grabber." msgstr "" #: en_US/style.xml:439(title) msgid "Correct: Sentence is objective" msgstr "" #: en_US/style.xml:440(para) msgid "Use the applet to take screenshots." msgstr "" #: en_US/style.xml:452(title) msgid "Tone" msgstr "" #: en_US/style.xml:453(para) msgid "Inappropriate tone hinders reader access to information. A neutral tone free of opinion or personal flavor improves the reader's comprehension. Neutral tone helps writers to work in parallel on a large technical documentation project. Furthermore, additional writers may join the project at any time. Use of a neutral tone helps to achieve consistency across a documentation set, and thereby facilitates user access to information. The best way to achieve a common, neutral tone is to apply the following principles:" msgstr "" #: en_US/style.xml:466(term) msgid "Avoid humor" msgstr "" #: en_US/style.xml:468(para) msgid "Humor distracts from the information you are trying to provide. Humor also makes documentation difficult to translate. Stay factual." msgstr "" #: en_US/style.xml:476(term) msgid "Avoid personal opinions" msgstr "" #: en_US/style.xml:478(para) msgid "Whether you think a function is useful or woeful is irrelevant. Report the function to the user, with instructions about how to use the function. Stay accurate." msgstr "" #: en_US/style.xml:487(term) msgid "Avoid colloquial language" msgstr "" #: en_US/style.xml:489(para) msgid "Colloquial language is difficult to translate and usually culture-specific. Stay neutral." msgstr "" #: en_US/style.xml:496(term) msgid "Avoid topical expressions" msgstr "" #: en_US/style.xml:498(para) msgid "An expression that is in common use today might convey something completely different tomorrow. Stay technical." msgstr "" #: en_US/style.xml:505(term) msgid "Avoid aspirational statements" msgstr "" #: en_US/style.xml:507(para) msgid "Statements about the future developments of a product do not belong in technical documentation. Write about what you see right now. Stay real." msgstr "" #: en_US/style.xml:517(title) msgid "Reaching the Right Audience" msgstr "" #: en_US/style.xml:518(para) msgid "All of the decisions that you make about the structure and content of a manual follow from an understanding of the audience. Consider how the audience accesses the documentation, what sort of information the audience needs, and the experience level of the audience. Usually, you need to create documentation that is suitable for different audiences. The following sections introduce some of the audience-related topics you need to consider." msgstr "" #: en_US/style.xml:530(title) msgid "User Motivation" msgstr "" #: en_US/style.xml:531(para) msgid "Do not waste the time of the user who looks for information in your documentation. Users do not read technical documentation for entertainment. Users usually have specific questions. You need to give clear answers to those questions." msgstr "" #: en_US/style.xml:539(title) msgid "New Users" msgstr "" #: en_US/style.xml:540(para) msgid "New users to Fedora are likely to consult online tutorials for guidance about unfamiliar applications or functionality. Each tutorial should contain enough introductory information to tell new users how to start using the relevant functions. Each tutorial should also contain enough usage instructions to tell users the different actions that they can perform with the command or function. Keep these instructions task-oriented. Do not describe GUI screens, dialogs, and dialog elements in a tutorial, unless there is an unusual feature that affects your instructions." msgstr "" #: en_US/style.xml:554(title) msgid "Experienced Users" msgstr "" #: en_US/style.xml:555(para) msgid "Experienced users are more likely to use documentation as a reference. The documentation therefore needs to be complete, well-organized, and in the case of printed manuals, well-indexed." msgstr "" #: en_US/style.xml:563(title) msgid "Do Not Offend Your Audience" msgstr "" #: en_US/style.xml:564(para) msgid "To avoid offending your readers, apply the following guidelines to your documentation:" msgstr "" #: en_US/style.xml:570(term) msgid "Avoid insider language" msgstr "" #: en_US/style.xml:572(para) msgid "Insider language includes both undefined jargon and the tendency of the computer community to shorten words. For example, use the term documentation instead of the term docs. A term may be jargon if it fails all the following conditions:" msgstr "" #: en_US/style.xml:581(para) msgid "The term does not appear in the Fedora Jargon Buster (http://fedora.redhat.com/docs/jargon-buster/)." msgstr "" #: en_US/style.xml:588(para) msgid "The term does not appear in the American Heritage Dictionary (http://www.bartleby.com/61/ )." msgstr "" #: en_US/style.xml:596(para) msgid "The term does not appear in the glossary of the manual that you are writing." msgstr "" #: en_US/style.xml:602(para) msgid "The term is not defined in the body text of the manual that you are writing." msgstr "" #: en_US/style.xml:611(term) msgid "Avoid gender-specific language" msgstr "" #: en_US/style.xml:613(para) msgid "Pronoun constructions such as his/her or s/he do not exist. There is no need to identify gender in your instructions." msgstr "" #: en_US/style.xml:621(term) msgid "Avoid culture-specific language" msgstr "" #: en_US/style.xml:623(para) msgid "There is little point in giving an example that everyone in your town knows about, but is a complete mystery to everyone else in the world." msgstr "" #: en_US/style.xml:631(term) msgid "Avoid talking down to your reader" msgstr "" #: en_US/style.xml:633(para) msgid "There are few experiences more irritating for a user than documentation that says an action is easy or quick, when in fact the user cannot complete the action. Do not qualify or prejudge actions." msgstr "" #: en_US/style.xml:642(para) msgid "Other parts of this guide discuss in more detail tone and language usage that can cause offense." msgstr "" #: en_US/style.xml:653(title) msgid "Grammar and Usage Guidelines" msgstr "" #: en_US/style.xml:656(title) msgid "Bibliographical Information" msgstr "" #: en_US/style.xml:657(para) msgid "This section is drawn partly from the GDSG, and partly from The Elements of Style, updated as necessary for the needs of 21st-century technical documentation writers." msgstr "" #. FIXME: Again, check attribution viz. GNU FDL. This will be more work #. than the previous section. #: en_US/style.xml:668(para) msgid "This section contains an alphabetical list of grammar and usage guidelines for use in Fedora documentation. Many of these guidelines are only applicable to English-language usage, refer to the American Heritage Dictionary (http://www.bartleby.com/61/) and the Chicago Manual of Style (http://www.press.uchicago.edu/Misc/Chicago/cmosfaq/cmosfaq.html.)" msgstr "" #: en_US/style.xml:679(term) msgid "Abbreviations" msgstr "" #: en_US/style.xml:681(para) msgid "A shortened form of a word or phrase that takes the place of the full word or phrase, such as Dr., a.m., p.m., and so on. Apply the following rules when you use abbreviations:" msgstr "" #: en_US/style.xml:689(para) msgid "Avoid creating new abbreviations. Unfamiliar abbreviations can confuse rather than clarify a concept." msgstr "" #: en_US/style.xml:695(para) msgid "Do not explain or expand familiar abbreviations." msgstr "" #: en_US/style.xml:700(para) msgid "Do not include familiar abbreviations in the glossary of your manual." msgstr "" #: en_US/style.xml:706(para) msgid "For abbreviations of phrases, such as i.e. for \"in other words\" and e.g. for \"for example\", do not use the abbreviation. Spell out the entire phrase." msgstr "" #: en_US/style.xml:715(term) msgid "Adjectives" msgstr "" #: en_US/style.xml:717(para) msgid "Use adjectives with caution. If an adjective is necessary to differentiate between items, then use adjectives. In all cases, test whether the phrase can stand alone without the adjective." msgstr "" #: en_US/style.xml:726(term) msgid "Acronyms" msgstr "" #: en_US/style.xml:728(para) msgid "A term that represents a multi-word term. Typically, acronyms are formed in the following ways:" msgstr "" #: en_US/style.xml:734(para) msgid "From the first letters of each word in a compound term, for example Table of Contents (TOC)." msgstr "" #: en_US/style.xml:740(para) msgid "From recognizable parts of a compound term, such as GNU Object Model Environment (GNOME)." msgstr "" #: en_US/style.xml:746(para) msgid "Apply the following rules when you use acronyms:" msgstr "" #: en_US/style.xml:751(para) msgid "On the first occurrence of an acronym, spell out the full term, with the acronym in parentheses." msgstr "" #: en_US/style.xml:757(para) msgid "Do not spell out the full compound for well-known acronyms, unless you think the information is useful for readers." msgstr "" #: en_US/style.xml:764(para) msgid "Avoid creating new acronyms. Unfamiliar acronyms can confuse rather than clarify a concept." msgstr "" #: en_US/style.xml:770(para) msgid "Write the acronym in uppercase letters, unless there is a compelling case for lowercase." msgstr "" #: en_US/style.xml:776(para) msgid "Include the acronym and the full term in the glossary of your manual." msgstr "" #: en_US/style.xml:785(term) msgid "Adverbs" msgstr "" #: en_US/style.xml:787(para) msgid "Use adverbs with caution. If an adverb is necessary to qualify the function of a component, then use an adverb. In all cases, test whether the phrase can stand alone without the adverb. Classic superfluous adverbs simply, easily, quickly." msgstr "" #: en_US/style.xml:798(term) msgid "Anthropomorphism" msgstr "" #: en_US/style.xml:802(para) msgid "Do not apply emotions, desires, or opinions to software applications." msgstr "" #: en_US/style.xml:808(para) msgid "Do not apply a sense of location or dimension to a software application. A user can not be \"in\" a text editor." msgstr "" #: en_US/style.xml:818(term) msgid "Articles" msgstr "" #: en_US/style.xml:820(para) msgid "Do not use the definite article the to begin any of the following items:" msgstr "" #: en_US/style.xml:826(para) msgid "Manual titles" msgstr "" #: en_US/style.xml:831(para) msgid "Chapter titles" msgstr "" #: en_US/style.xml:836(para) en_US/style.xml:1239(term) msgid "Headings" msgstr "" #: en_US/style.xml:841(para) msgid "Figure captions" msgstr "" #: en_US/style.xml:846(para) msgid "Table captions" msgstr "" #: en_US/style.xml:851(para) msgid "Callouts" msgstr "" #: en_US/style.xml:859(term) msgid "Apostrophe" msgstr "" #: en_US/style.xml:861(para) msgid "Do not use apostrophes except where absolutely required" msgstr "" #: en_US/style.xml:866(para) msgid "Do not use apostrophes to denote possession." msgstr "" #: en_US/style.xml:871(para) msgid "Do not use apostrophes to denote contractions." msgstr "" #: en_US/style.xml:876(para) msgid "Do not use apostrophes to denote plurals." msgstr "" #: en_US/style.xml:882(title) msgid "Incorrect: Apostrophes" msgstr "" #: en_US/style.xml:885(para) msgid "the Main Menu'sHelp option" msgstr "" #: en_US/style.xml:891(para) msgid "don't use the default option" msgstr "" #: en_US/style.xml:896(para) msgid "several SCSI disk's" msgstr "" #: en_US/style.xml:903(title) msgid "Correct: No apostrophes" msgstr "" #: en_US/style.xml:906(para) msgid "the Help option on the Main Menu" msgstr "" #: en_US/style.xml:912(para) msgid "do not use the default option" msgstr "" #: en_US/style.xml:917(para) msgid "several SCSI disks" msgstr "" #: en_US/style.xml:926(term) msgid "Brackets" msgstr "" #: en_US/style.xml:930(para) msgid "Do not use brackets [such as these] as a substitute for parentheses (such as these)." msgstr "" #: en_US/style.xml:936(para) msgid "Use brackets for optional command line entries." msgstr "" #: en_US/style.xml:941(para) msgid "Do not use angle brackets to indicate variables in text, instead use the replaceable tag. Refer to for information about using this tag." msgstr "" #: en_US/style.xml:953(term) msgid "Capitalization" msgstr "" #: en_US/style.xml:955(para) msgid "Capitalize in the following situations:" msgstr "" #: en_US/style.xml:960(para) msgid "All letters in acronyms, unless the acronym is a well-known exception" msgstr "" #: en_US/style.xml:966(para) msgid "Initial letter of the first word in a list" msgstr "" #: en_US/style.xml:971(para) msgid "Initial letter of the first word in a callout" msgstr "" #: en_US/style.xml:976(para) msgid "Initial letter of a key name, such as the Shift key" msgstr "" #: en_US/style.xml:982(para) msgid "Initial letter of a sentence" msgstr "" #: en_US/style.xml:986(title) msgid "Command Names" msgstr "" #: en_US/style.xml:987(para) msgid "Avoid starting a sentence with a command name or application name that has a lowercase initial letter." msgstr "" #: en_US/style.xml:994(para) msgid "Initial letter of a complete sentence after a colon" msgstr "" #: en_US/style.xml:999(para) msgid "Do not capitalize in the following situations:" msgstr "" #: en_US/style.xml:1004(para) msgid "A compound term that is followed by an abbreviation or an acronym" msgstr "" #: en_US/style.xml:1010(para) msgid "When you want to emphasize something" msgstr "" #: en_US/style.xml:1015(para) msgid "Variable names" msgstr "" #: en_US/style.xml:1020(para) msgid "The initial letter of an incomplete sentence after a colon" msgstr "" #: en_US/style.xml:1029(term) msgid "Captions" msgstr "" #: en_US/style.xml:1031(para) msgid "Use the same rules as for headings, for all captions accompanying figures and tables. Do not put a period at the end of a caption." msgstr "" #: en_US/style.xml:1039(term) msgid "Colon" msgstr "" #: en_US/style.xml:1041(para) msgid "Use a colon in the following situations:" msgstr "" #: en_US/style.xml:1046(para) msgid "To introduce a list" msgstr "" #: en_US/style.xml:1051(para) msgid "Before an explanation" msgstr "" #: en_US/style.xml:1056(para) msgid "After an introduction" msgstr "" #: en_US/style.xml:1061(para) msgid "Do not use a colon in the following situations:" msgstr "" #: en_US/style.xml:1066(para) msgid "To introduce a figure or a table" msgstr "" #: en_US/style.xml:1071(para) msgid "To introduce headings" msgstr "" #: en_US/style.xml:1076(para) msgid "At the end of an introduction to a procedure" msgstr "" #: en_US/style.xml:1084(term) msgid "Column headings" msgstr "" #: en_US/style.xml:1086(para) msgid "Use the same rules as for headings." msgstr "" #: en_US/style.xml:1092(term) msgid "Comma" msgstr "" #: en_US/style.xml:1094(para) msgid "Use commas in the following situations:" msgstr "" #: en_US/style.xml:1099(para) msgid "To separate items in a series" msgstr "" #: en_US/style.xml:1104(para) msgid "To separate the parts of a sentence" msgstr "" #: en_US/style.xml:1109(para) msgid "To separate nonrestrictive phrases" msgstr "" #: en_US/style.xml:1114(para) msgid "Instead of dashes to set off appositives" msgstr "" #: en_US/style.xml:1119(para) msgid "With for example and similar expressions" msgstr "" #: en_US/style.xml:1125(para) msgid "Do not use commas in the following situations:" msgstr "" #: en_US/style.xml:1130(para) msgid "In a series of adjectives used as one modifier" msgstr "" #: en_US/style.xml:1135(para) msgid "Between two short independent clauses" msgstr "" #: en_US/style.xml:1143(term) en_US/emacs-nxml.xml:86(title) msgid "Commands" msgstr "" #: en_US/style.xml:1145(para) msgid "Do not use commands as verbs." msgstr "" #: en_US/style.xml:1151(term) msgid "Contractions" msgstr "" #: en_US/style.xml:1153(para) msgid "Do not use contractions such as can't, don't, or isn't." msgstr "" #: en_US/style.xml:1160(term) msgid "Dash" msgstr "" #: en_US/style.xml:1162(para) msgid "Do not use the em dash or the en dash. Use a paragraph break or a colon instead, where you want to create an introductory piece of text. If you have several items that you want to introduce, then you can use a variable list." msgstr "" #: en_US/style.xml:1171(term) msgid "Ellipsis" msgstr "" #: en_US/style.xml:1173(para) msgid "Use an ellipsis in the following situations:" msgstr "" #: en_US/style.xml:1178(para) msgid "To show that you have omitted something from a sentence" msgstr "" #: en_US/style.xml:1183(para) msgid "To indicate a pause when you quote displayed text" msgstr "" #: en_US/style.xml:1191(term) msgid "Fractions" msgstr "" #: en_US/style.xml:1193(para) msgid "Follow these rules when using fractions:" msgstr "" #: en_US/style.xml:1198(para) msgid "Use numerals for fractions in tables and in units of measurement, but spell out fractions in prose." msgstr "" #: en_US/style.xml:1204(para) msgid "Use a space between a numeral and a related fraction, if there is a possible ambiguity. For example: 1 1/2 instead of 11/2." msgstr "" #: en_US/style.xml:1211(para) msgid "If a fraction is used in a compound modifier, insert a hyphen between the fraction and the unit of measurement." msgstr "" #: en_US/style.xml:1220(term) msgid "Gender" msgstr "" #: en_US/style.xml:1222(para) msgid "Refer to ." msgstr "" #: en_US/style.xml:1228(term) msgid "Grammar" msgstr "" #: en_US/style.xml:1230(para) msgid "Use standard American English grammar rules, refer to the Chicago Manual of Style ( http://www.press.uchicago.edu/Misc/Chicago/cmosfaq/cmosfaq.html.)" msgstr "" #: en_US/style.xml:1241(para) msgid "Use the following capitalization rules in headings:" msgstr "" #: en_US/style.xml:1246(para) msgid "Initial uppercase letter of the first word" msgstr "" #: en_US/style.xml:1251(para) msgid "Initial uppercase letter for all nouns, adjectives, and verbs." msgstr "" #: en_US/style.xml:1257(para) msgid "All lowercase letters for conjunctions, articles, and prepositions of fewer than four letters" msgstr "" #: en_US/style.xml:1263(para) msgid "Initial uppercase letter for prepositions of four letters or longer" msgstr "" #: en_US/style.xml:1269(para) msgid "Initial uppercase letter for conjunctions of four letters or longer" msgstr "" #: en_US/style.xml:1280(term) msgid "Hyphen" msgstr "" #: en_US/style.xml:1282(para) msgid "Use hyphens in the following situations:" msgstr "" #: en_US/style.xml:1287(para) msgid "With a numeral in a compound modifier" msgstr "" #: en_US/style.xml:1291(para) msgid "To prevent ambiguity" msgstr "" #: en_US/style.xml:1296(para) msgid "With some standard prefixes and suffixes. Use the American Heritage Dictionary (http://www.bartleby.com/61/) for guidance" msgstr "" #: en_US/style.xml:1305(para) msgid "In spelled-out fractions" msgstr "" #: en_US/style.xml:1310(para) msgid "In variable names of two or more words, such as directory-name. Note: filename is an exception." msgstr "" #: en_US/style.xml:1317(para) msgid "Do not use hyphens in the following situations:" msgstr "" #: en_US/style.xml:1322(para) msgid "For industry-accepted terms" msgstr "" #: en_US/style.xml:1327(para) msgid "To construct verbs" msgstr "" #: en_US/style.xml:1332(para) msgid "With an adverb ending in ly" msgstr "" #: en_US/style.xml:1337(para) msgid "With numerals as single modifiers" msgstr "" #: en_US/style.xml:1342(para) msgid "With a word that is listed as unhyphenated in the American Heritage Dictionary (http://www.bartleby.com/61/), and that uses a common prefix" msgstr "" #: en_US/style.xml:1351(para) msgid "With trademarked terms" msgstr "" #: en_US/style.xml:1359(term) msgid "Latin terms" msgstr "" #: en_US/style.xml:1361(para) msgid "Do not use Latin terms. Use an equivalent English term instead." msgstr "" #: en_US/style.xml:1368(term) msgid "Like" msgstr "" #: en_US/style.xml:1370(para) msgid "Do not use the term like to denote equivalence or similarity." msgstr "" #: en_US/style.xml:1377(term) msgid "Lists" msgstr "" #: en_US/style.xml:1379(para) msgid "Introduce a list with a complete sentence that ends with a colon." msgstr "" #: en_US/style.xml:1386(term) msgid "Numbers" msgstr "" #: en_US/style.xml:1388(para) msgid "Spell out numbers in the following situations:" msgstr "" #: en_US/style.xml:1393(para) msgid "Numbers from zero through nine unless the number is part of a measurement" msgstr "" #: en_US/style.xml:1398(para) msgid "Approximations" msgstr "" #: en_US/style.xml:1403(para) msgid "Extreme values such as million, but precede the value with a numeral" msgstr "" #: en_US/style.xml:1409(para) msgid "Any number that begins a sentence" msgstr "" #: en_US/style.xml:1414(para) msgid "A number that is immediately followed by a numeral, for example: two 10 MB files" msgstr "" #: en_US/style.xml:1423(term) msgid "Numerals" msgstr "" #: en_US/style.xml:1425(para) msgid "Use numerals in the following situations:" msgstr "" #: en_US/style.xml:1430(para) msgid "The number 10 or greater" msgstr "" #: en_US/style.xml:1435(para) msgid "Negative numbers" msgstr "" #: en_US/style.xml:1439(para) msgid "Most fractions" msgstr "" #: en_US/style.xml:1444(para) msgid "Percentages" msgstr "" #: en_US/style.xml:1449(para) msgid "Decimals" msgstr "" #: en_US/style.xml:1454(para) msgid "Measurements" msgstr "" #: en_US/style.xml:1459(para) msgid "Units of time smaller than one second" msgstr "" #: en_US/style.xml:1464(para) msgid "References to bits and bytes" msgstr "" #: en_US/style.xml:1472(term) msgid "Parentheses" msgstr "" #: en_US/style.xml:1474(para) msgid "Use parentheses in the following situations:" msgstr "" #: en_US/style.xml:1479(para) msgid "To contain the abbreviation of a term on the first occurrence of the full term" msgstr "" #: en_US/style.xml:1485(para) msgid "In man page references, specifically the section number" msgstr "" #: en_US/style.xml:1493(term) msgid "Period" msgstr "" #: en_US/style.xml:1495(para) msgid "Use a period in the following situations:" msgstr "" #: en_US/style.xml:1500(para) msgid "To end a sentence" msgstr "" #: en_US/style.xml:1505(para) msgid "In file and directory names" msgstr "" #: en_US/style.xml:1510(para) msgid "In abbreviations that can be mistaken for words, such as a.m. and U.S." msgstr "" #: en_US/style.xml:1519(term) msgid "Punctuation" msgstr "" #: en_US/style.xml:1521(para) msgid "Use standard American English punctuation rules. In addition to the specific points of punctuation in this section, refer also to the Chicago Manual of Style (http://www.press.uchicago.edu/Misc/Chicago/cmosfaq/cmosfaq.html.)" msgstr "" #: en_US/style.xml:1531(term) msgid "Punctuation in numbers" msgstr "" #: en_US/style.xml:1533(para) msgid "Do not use a comma in numerals of four digits. Use a comma in numerals of more than four digits." msgstr "" #: en_US/style.xml:1540(term) msgid "Quotation marks" msgstr "" #: en_US/style.xml:1542(para) msgid "Use quotation marks to indicate material that is taken verbatim from another source. Do not use quotation marks to excuse terms from legitimacy. If the term is not legitimate, then use another term. If you must use that term, declare the term in the glossary and make the term legitimate." msgstr "" #: en_US/style.xml:1553(term) msgid "See v. Refer to" msgstr "" #: en_US/style.xml:1555(para) msgid "When referring a user to another resource, use \"refer to\" instead of \"see\", and \"refer also to\" instead of \"see also\". This differentiates from the see and seealso tags that are used in indexing. These tags create special links in the index. To be consistent throughout the document, we reserve the special words \"see\" and \"see also\" for hyperlinked index references, and use \"refer to\" and \"refer also to\" for non-hyperlinked and non-indexed references." msgstr "" #: en_US/style.xml:1570(term) msgid "Semicolon" msgstr "" #: en_US/style.xml:1572(para) msgid "Do not use semicolons." msgstr "" #: en_US/style.xml:1578(term) msgid "Slash" msgstr "" #: en_US/style.xml:1580(para) msgid "Except where required as part of a filename, do not use slashes \"/\" in your writing. The construction and/or, for example, does not exist. Use one or the other term instead." msgstr "" #: en_US/style.xml:1589(term) msgid "Spelling" msgstr "" #: en_US/style.xml:1591(para) msgid "Use standard American English spelling rules, refer to the American Heritage Dictionary (http://www.bartleby.com/61/) for guidelines." msgstr "" #: en_US/style.xml:1600(term) msgid "Titles" msgstr "" #: en_US/style.xml:1602(para) msgid "For manual titles use the same rules as for headings." msgstr "" #: en_US/style.xml:1608(term) msgid "Units" msgstr "" #: en_US/style.xml:1610(para) msgid "Follow these rules when using units:" msgstr "" #: en_US/style.xml:1615(para) msgid "Use standard abbreviations for units of measurements, do not invent your own abbreviations." msgstr "" #: en_US/style.xml:1621(para) msgid "For further guidelines, refer to the IEEE Standard Dictionary of Electrical and Electronics Terms." msgstr "" #: en_US/style.xml:1630(para) msgid "Use periods for abbreviated units that might be mistaken for a word." msgstr "" #: en_US/style.xml:1636(para) msgid "Most standard abbreviations of units account for both singular and plural usage." msgstr "" #: en_US/style.xml:1642(para) msgid "Insert a space between the numeral and the unit of measurement." msgstr "" #: en_US/style.xml:1656(title) msgid "Composition Tips" msgstr "" #. This section will collect miscellanea and advice for specific #. situations that the FDP editors encounter. I hope they will feel #. free to e-mail me sticky situations or particularly interesting #. examples of work they've beautified. Hopefully not too much will be #. drawn from my own work! - PWF. #: en_US/style.xml:1668(para) msgid "This section contains usage tips based on situations the Fedora Documentation Project editors have encountered in the past. You should read and understand these examples to improve your own documentation. The Fedora Documentation Project editors welcome additional examples." msgstr "" #: en_US/style.xml:1676(title) msgid "Active Voice" msgstr "" #: en_US/style.xml:1677(para) msgid "Always use active voice, except when it is awkward to do so. The tutorial tells the user how to accomplish a task, and should give instructions clearly and concisely. Avoid using \"must,\" \"need to,\" and the like. These words are redundant in a tutorial, since the reader assumes you are outlining necessary steps to accomplish a task. Also avoid using \"maybe,\" \"might,\" and other words that indicate you are unsure about the subject matter. Your tutorial should cover a subject authoritatively. The reader should never be concerned about unknown effects of following the tutorial." msgstr "" #: en_US/style.xml:1690(title) msgid "Incorrect: Passive voice" msgstr "" #: en_US/style.xml:1691(para) msgid "The yum update command must be run." msgstr "" #: en_US/style.xml:1694(para) msgid "You might want to run the yum update command." msgstr "" #: en_US/style.xml:1700(title) msgid "Correct: Active voice" msgstr "" #: en_US/style.xml:1701(para) msgid "Run the yum update command." msgstr "" #: en_US/style.xml:1708(title) msgid "Present Tense" msgstr "" #: en_US/style.xml:1709(para) msgid "Write in the present tense. A good rule of thumb is that the words \"will\" and \"shall\" are almost never needed in describing what the user should do or see. They add unnecessary length to sentences and can confuse translators. They are also often indicators of passive voice; refer also to ." msgstr "" #: en_US/style.xml:1718(title) msgid "Incorrect: Future tense" msgstr "" #: en_US/style.xml:1719(para) msgid "The application will display a list of target files." msgstr "" #: en_US/style.xml:1722(para) msgid "A list of target files will be displayed by the application." msgstr "" #: en_US/style.xml:1727(title) msgid "Correct: Present tense" msgstr "" #: en_US/style.xml:1728(para) msgid "The application displays a list of target files." msgstr "" #: en_US/style.xml:1735(title) msgid "Narrative Voice" msgstr "" #: en_US/style.xml:1736(para) msgid "Do not use the first person \"I,\" \"we,\" or \"us\" to refer to yourself the writer (whether including the reader or not), the Fedora Documentation Project, the Fedora community, or any other group. Do not refer to users with a third person pronoun (\"he,\" \"she,\" or \"he or she\") or the word \"one.\" It is acceptable to refer to the reader with the second person pronoun \"you.\"" msgstr "" #: en_US/style.xml:1745(title) msgid "Incorrect: First or third person" msgstr "" #: en_US/style.xml:1746(para) msgid "As described in the last section, I always run up2date before configuring the Samba server." msgstr "" #: en_US/style.xml:1751(para) msgid "If the user needs to back up his or her files, s/he should use the tar or cpio command." msgstr "" #: en_US/style.xml:1757(title) msgid "Correct: Second (or no) person" msgstr "" #: en_US/style.xml:1758(para) msgid "Refer to the section on up2date before configuring the Samba server." msgstr "" #: en_US/style.xml:1762(para) msgid "If necessary, users can back up files with the tar or cpio command." msgstr "" #: en_US/style.xml:1770(title) msgid "Negative Words" msgstr "" #: en_US/style.xml:1771(para) msgid "Avoid negative words when possible, since they give documentation an overly dogmatic tone. The word \"avoid\" is useful for this purpose. Note that contractions are often used for negative words such as don't or can't. Refer to ." msgstr "" #: en_US/style.xml:1782(title) msgid "Uncertainty" msgstr "" #: en_US/style.xml:1783(para) msgid "Avoid overuse of \"typically,\" \"usually,\" \"most of,\" \"many,\" and the like. While occasional use of these constructions is acceptable, overuse reduces the authority of your documentation. The documentation should adequately cover a stock installation of Fedora. It is impossible for a tutorial-length document to cover every possible configuration scenario. Address the most common scenarios and note discrepancies only as required." msgstr "" #: en_US/style.xml:1795(title) msgid "Redundant Coverage" msgstr "" #: en_US/style.xml:1796(para) msgid "Avoid covering redundant material, such as how to update a Fedora system. These overarching topics may be covered in other tutorials. Writers frequently violate this guideline because they feel their tutorial is not long enough. Keep your tutorial from wandering off-topic. Instead, refer the reader to a separate tutorial whenever possible for complete coverage of that topic." msgstr "" #: en_US/style.xml:1808(title) msgid "Self-referential Value Judgments" msgstr "" #: en_US/style.xml:1809(para) msgid "Avoid statements such as \"One of the most important things to do is XYZ.\" If the procedure is important, the reader already expects it to be in your tutorial. The converse is also true: If a procedure appears in your tutorial, the reader expects it is important. This is especially true if you use a whole section for the procedure in question. Merely state, \"Do XYZ.\" Then elaborate as required. If the whole section concerns how to do XYZ, leave this sentence out entirely. Refer also to ." msgstr "" #: en_US/style.xml:1824(title) msgid "Precision of Language" msgstr "" #: en_US/style.xml:1825(para) msgid "Use precise words for actions users should take. Do not instruct users to \"go\" to a selection, or \"find\" a menu." msgstr "" #: en_US/style.xml:1830(title) msgid "Incorrect: Imprecise wording" msgstr "" #: en_US/style.xml:1833(para) msgid "Go to the Main Menu -> Foobar" msgstr "" #: en_US/style.xml:1839(para) msgid "Find the option labeled Search" msgstr "" #: en_US/style.xml:1846(title) msgid "Correct: Precise wording" msgstr "" #: en_US/style.xml:1849(para) msgid "From the Main Menu, select Foobar" msgstr "" #: en_US/style.xml:1855(para) msgid "Select the Search option" msgstr "" #: en_US/style.xml:1862(title) msgid "Do Not Discriminate Against Non-GUI Users" msgstr "" #: en_US/style.xml:1863(para) msgid "If you are writing about a GUI-only application, you may use \"click\" freely. If you are writing about an application that has a text-mode interface, use \"select\" instead as shown above." msgstr "" #: en_US/style.xml:1874(title) msgid "DocBook Tips" msgstr "" #: en_US/style.xml:1875(para) msgid "This section contains tips on how to use DocBook tags more effectively in your documentation." msgstr "" #: en_US/style.xml:1881(title) en_US/writing-guidelines.xml:268(title) msgid "Admonitions" msgstr "" #: en_US/style.xml:1882(para) msgid "Avoid overuse of admonitions. Keep admonitions short and effective by using only the most important material inside the admonition. Move any background material required to explain the admonition statements outside the admonition. Use a short but descriptive title for an admonition. Use title case for the admonition title." msgstr "" #: en_US/style.xml:1891(title) msgid "Incorrect: Lengthy admonition" msgstr "" #: en_US/style.xml:1894(title) msgid "Use sfdisk to check input" msgstr "" #: en_US/style.xml:1895(para) msgid "The sfdisk command accepts a script file as standard input to set up partitions on a hard disk. Sometimes sfdisk will simply reject an erroneous input file. In other cases, it will use the input verbatim, writing an incorrect partition table to your disk. Always use the sfdisk -n command to check your input file before writing to the disk." msgstr "" #: en_US/style.xml:1909(title) msgid "Correct: Brief admonition" msgstr "" #: en_US/style.xml:1917(title) msgid "Check Input" msgstr "" #: en_US/style.xml:1918(para) msgid "Always use the sfdisk -n command to check your input file before writing to the disk." msgstr "" #: en_US/style.xml:1910(para) msgid "The sfdisk command accepts a script file as standard input to set up partitions on a hard disk. Sometimes sfdisk will simply reject an erroneous input file. In other cases, it will use the input verbatim, writing an incorrect partition table to your disk. " msgstr "" #: en_US/style.xml:1925(para) msgid "Avoid punctuation in titles for sections or admonitions, except for commas only where demanded. Use a title that says something about the admonition comment, such as \"Reboot Required,\" instead of simply using the admonition type for a title (\"Note\")." msgstr "" #: en_US/style.xml:1932(para) msgid "Follow the capitalization rules for headings in the title of an admonition." msgstr "" #: en_US/style.xml:1939(title) msgid "The replaceable Tag" msgstr "" #: en_US/style.xml:1941(para) msgid "If your documentation formally states a specific value will be used as a convention, do not use the replaceable tag in your text or examples." msgstr "" #: en_US/style.xml:1950(title) 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 common/ folder in the fedora-docs distribution. (Refer also to .) For instance, do not use abbreviations such as \"FC2.\" Instead, use the predefined entities \"&FC; &FCVER;,\" which produces the text \"Fedora 9.\"" msgstr "" #: en_US/writing-guidelines.xml:11(title) msgid "Fedora Documentation Guidelines" msgstr "" #: en_US/writing-guidelines.xml:14(primary) en_US/writing-guidelines.xml:15(see) msgid "recursion" msgstr "" #: en_US/writing-guidelines.xml:19(primary) en_US/writing-guidelines.xml:26(secondary) msgid "RTFM" msgstr "" #: en_US/writing-guidelines.xml:20(secondary) msgid "read the fine manual" msgstr "" #: en_US/writing-guidelines.xml:21(seealso) en_US/writing-guidelines.xml:25(primary) msgid "humor" msgstr "" #: en_US/writing-guidelines.xml:29(para) msgid "Please read this chapter carefully. This chapter describes the guidelines that must be followed such as naming conventions." msgstr "" #: en_US/writing-guidelines.xml:32(para) msgid "This chapter only discusses tags used for documentation for the Fedora Project, not all available DocBook XML tags. For the complete list, refer to ." msgstr "" #: en_US/writing-guidelines.xml:38(title) msgid "File Header" msgstr "" #: en_US/writing-guidelines.xml:40(title) msgid "XML Header" msgstr "" #: en_US/writing-guidelines.xml:41(para) msgid "In accordance with good XML practices, the first line in any DocBook XML source files should identify the file as XML. Use the following line as the first line of any new XML file:" msgstr "" #: en_US/writing-guidelines.xml:47(title) msgid "CVS Id Header" msgstr "" #: en_US/writing-guidelines.xml:48(para) msgid "All the files must contain the CVS Id header. Use the following line as the second line of any new XML file:" msgstr "" #: en_US/writing-guidelines.xml:51(para) msgid "Any time the file is committed to CVS, the line is updated automatically to include information about the file. For example:" msgstr "" #: en_US/writing-guidelines.xml:58(title) msgid "ID Naming Conventions" msgstr "" #: en_US/writing-guidelines.xml:61(primary) en_US/writing-guidelines.xml:74(primary) en_US/writing-guidelines.xml:275(primary) en_US/writing-guidelines.xml:280(primary) en_US/writing-guidelines.xml:285(primary) en_US/writing-guidelines.xml:290(primary) en_US/writing-guidelines.xml:295(primary) en_US/writing-guidelines.xml:300(primary) en_US/writing-guidelines.xml:306(primary) en_US/writing-guidelines.xml:312(primary) en_US/writing-guidelines.xml:318(primary) en_US/writing-guidelines.xml:324(primary) en_US/writing-guidelines.xml:350(primary) en_US/writing-guidelines.xml:355(primary) en_US/writing-guidelines.xml:360(primary) en_US/writing-guidelines.xml:365(primary) en_US/writing-guidelines.xml:370(primary) msgid "XML tags" msgstr "" #: en_US/writing-guidelines.xml:62(secondary) en_US/writing-guidelines.xml:66(primary) en_US/writing-guidelines.xml:79(primary) msgid "naming conventions" msgstr "" #: en_US/writing-guidelines.xml:69(para) msgid "This section explains the ID naming convention. IDs are unique identifiers that allow DocBook XML to cross-reference a section, chapter, or other element." msgstr "" #: en_US/writing-guidelines.xml:75(secondary) en_US/writing-guidelines.xml:80(secondary) msgid "rules for defining an ID" msgstr "" #: en_US/writing-guidelines.xml:83(para) msgid "The following general rules apply to IDs:" msgstr "" #: en_US/writing-guidelines.xml:87(para) msgid "Keep an ID as short and simple as possible." msgstr "" #: en_US/writing-guidelines.xml:90(para) msgid "Start the ID with the special short two-character label. This makes URLs and other references to this ID human readable, by self-identifying the XML container type." msgstr "" #: en_US/writing-guidelines.xml:96(para) msgid " demonstrates some example ID attributes used properly." msgstr "" #: en_US/writing-guidelines.xml:102(title) msgid "Proper ID Usage" msgstr "" #: en_US/writing-guidelines.xml:111(title) msgid "Two-Character Naming Conventions" msgstr "" #: en_US/writing-guidelines.xml:112(segtitle) msgid "Tag" msgstr "" #: en_US/writing-guidelines.xml:113(segtitle) msgid "Prefix" msgstr "" #: en_US/writing-guidelines.xml:115(sgmltag) msgid "preface" msgstr "" #: en_US/writing-guidelines.xml:116(literal) msgid "pr-" msgstr "" #: en_US/writing-guidelines.xml:119(sgmltag) msgid "chapter" msgstr "" #: en_US/writing-guidelines.xml:120(literal) msgid "ch-" msgstr "" #: en_US/writing-guidelines.xml:123(sgmltag) msgid "section" msgstr "" #: en_US/writing-guidelines.xml:124(literal) msgid "sn-" msgstr "" #: en_US/writing-guidelines.xml:127(sgmltag) msgid "figure" msgstr "" #: en_US/writing-guidelines.xml:128(literal) msgid "fig-" msgstr "" #: en_US/writing-guidelines.xml:131(sgmltag) en_US/writing-guidelines.xml:235(sgmltag) msgid "table" msgstr "" #: en_US/writing-guidelines.xml:132(literal) msgid "tb-" msgstr "" #: en_US/writing-guidelines.xml:135(sgmltag) msgid "appendix" msgstr "" #: en_US/writing-guidelines.xml:136(literal) msgid "ap-" msgstr "" #: en_US/writing-guidelines.xml:139(sgmltag) msgid "part" msgstr "" #: en_US/writing-guidelines.xml:140(literal) msgid "pt-" msgstr "" #: en_US/writing-guidelines.xml:143(sgmltag) msgid "example" msgstr "" #: en_US/writing-guidelines.xml:144(literal) msgid "ex-" msgstr "" #: en_US/writing-guidelines.xml:148(para) msgid "Use the title of the item as the ID. Make your titles unique within a document to prevent conflicts. For example:" msgstr "" #: en_US/writing-guidelines.xml:157(title) msgid "XML Tags" msgstr "" #: en_US/writing-guidelines.xml:159(primary) msgid "xml tags" msgstr "" #: en_US/writing-guidelines.xml:160(secondary) msgid "caveats" msgstr "" #: en_US/writing-guidelines.xml:163(para) msgid "It is very important that you remember the caveats in this section. These are learned suggestions or rules that make your XML experience better." msgstr "" #: en_US/writing-guidelines.xml:171(term) msgid "Do Not Use Trademark Entities" msgstr "" #: en_US/writing-guidelines.xml:173(para) msgid "Do not use the trademark entities trade, copy, or reg because the do not produce HTML output that works for all charsets. The HTML output produces by these entities are declared in the DTD and cannot be changed via the stylesheet." msgstr "" #: en_US/writing-guidelines.xml:181(para) msgid "Instead, use the trademark tag and its associates classes as follows:" msgstr "" #: en_US/writing-guidelines.xml:184(segtitle) msgid "DocBook XML source" msgstr "" #: en_US/writing-guidelines.xml:185(segtitle) msgid "Rendered content" msgstr "" #: en_US/writing-guidelines.xml:189(trademark) msgid "trademark symbol after me" msgstr "" #: en_US/writing-guidelines.xml:196(trademark) msgid "registered trademark symbol after me" msgstr "" #: en_US/writing-guidelines.xml:202(trademark) msgid "copyright symbol after me" msgstr "" #: en_US/writing-guidelines.xml:209(term) msgid "Content inside para tags" msgstr "" #: en_US/writing-guidelines.xml:211(para) msgid "In general, use para tags around anything other than a simple paragraph. Doing so will create additional white space within the text itself in the PDF version." msgstr "" #: en_US/writing-guidelines.xml:216(para) msgid "Specifically, do not use para tags around the following (or, to put this another way, do not embed the following within para elements):" msgstr "" #: en_US/writing-guidelines.xml:223(sgmltag) msgid "screen" msgstr "" #: en_US/writing-guidelines.xml:226(sgmltag) msgid "itemizedlist" msgstr "" #: en_US/writing-guidelines.xml:229(sgmltag) msgid "orderedlist" msgstr "" #: en_US/writing-guidelines.xml:232(sgmltag) msgid "variablelist" msgstr "" #: en_US/writing-guidelines.xml:241(term) msgid "Content inside para elements within listitem tags" msgstr "" #: en_US/writing-guidelines.xml:244(para) msgid "Content inside para elements within listitem elements must start immediately after the beginning para tag to avoid extra white space in the PDF version." msgstr "" #: en_US/writing-guidelines.xml:252(term) msgid "Content inside screen tags" msgstr "" #: en_US/writing-guidelines.xml:254(para) msgid "The content inside screen tags (screen and screen) must be flush left in the XML file; otherwise, the extraneous whitespace will appear in the HTML version." msgstr "" #: en_US/writing-guidelines.xml:271(primary) en_US/writing-guidelines.xml:301(secondary) en_US/writing-guidelines.xml:307(secondary) en_US/writing-guidelines.xml:313(secondary) en_US/writing-guidelines.xml:319(secondary) en_US/writing-guidelines.xml:325(secondary) msgid "admonitions" msgstr "" #: en_US/writing-guidelines.xml:276(secondary) en_US/writing-guidelines.xml:302(tertiary) en_US/writing-guidelines.xml:371(secondary) msgid "warning" msgstr "" #: en_US/writing-guidelines.xml:281(secondary) en_US/writing-guidelines.xml:308(tertiary) en_US/writing-guidelines.xml:356(secondary) msgid "tip" msgstr "" #: en_US/writing-guidelines.xml:286(secondary) en_US/writing-guidelines.xml:314(tertiary) en_US/writing-guidelines.xml:351(secondary) msgid "note" msgstr "" #: en_US/writing-guidelines.xml:291(secondary) en_US/writing-guidelines.xml:320(tertiary) en_US/writing-guidelines.xml:361(secondary) msgid "caution" msgstr "" #: en_US/writing-guidelines.xml:296(secondary) en_US/writing-guidelines.xml:326(tertiary) en_US/writing-guidelines.xml:366(secondary) msgid "important" msgstr "" #: en_US/writing-guidelines.xml:329(para) msgid "There are five types of admonitions in DocBook: caution, important, note, tip, and warning. All of the admonitions have the same structure: an optional title followed by paragraph-level elements. The DocBook DTD does not impose any specific semantics on the individual admonitions. For example, DocBook does not mandate that a warning is reserved for cases where bodily harm can result." msgstr "" #: en_US/writing-guidelines.xml:343(title) msgid "Creating a note, tip, caution, important, or warning" msgstr "" #: en_US/writing-guidelines.xml:374(para) msgid "There are several ways to bring attention to text within a document. A note is used to bring additional information to the users' attention. A tip is used to show the user helpful information or another way to do something. A caution is used to show the user they must be careful when attempting a certain step. An important tag set can be used to show the user a piece of information that should not be overlooked. While this information may not change anything the user is doing, it should show the user that this piece of information could be vital. A warning is used to show the reader that their current setup will change or be altered, such as files being removed, and they should not choose this operation unless they are alright with the consequences." msgstr "" #: en_US/writing-guidelines.xml:394(para) msgid "The following lines of code show the basic setup for each case mentioned above, along with its appearance in HTML." msgstr "" #: en_US/writing-guidelines.xml:403(title) en_US/emacs.xml:257(title) en_US/emacs.xml:562(title) en_US/emacs-nxml.xml:160(title) msgid "Note" msgstr "" #: en_US/writing-guidelines.xml:404(para) en_US/writing-guidelines.xml:424(para) en_US/writing-guidelines.xml:434(para) en_US/writing-guidelines.xml:444(para) msgid "Body of text goes here." msgstr "" #: en_US/writing-guidelines.xml:413(title) en_US/emacs-nxml.xml:114(title) msgid "Tip" msgstr "" #: en_US/writing-guidelines.xml:414(para) msgid "Body of text goes here" msgstr "" #: en_US/writing-guidelines.xml:423(title) msgid "Caution" msgstr "" #: en_US/writing-guidelines.xml:433(title) en_US/emacs-nxml.xml:96(title) msgid "Important" msgstr "" #: en_US/writing-guidelines.xml:443(title) msgid "Warning" msgstr "" #: en_US/writing-guidelines.xml:451(title) msgid "Screenshots" msgstr "" #: en_US/writing-guidelines.xml:454(primary) en_US/writing-guidelines.xml:459(see) en_US/writing-guidelines.xml:463(see) msgid "screenshots" msgstr "" #: en_US/writing-guidelines.xml:455(secondary) msgid "how to take" msgstr "" #: en_US/writing-guidelines.xml:458(primary) msgid "screen captures" msgstr "" #: en_US/writing-guidelines.xml:462(primary) msgid "screen grabs" msgstr "" #: en_US/writing-guidelines.xml:466(para) msgid "Screenshots are illustrations that show the state of a display the user may encounter. Screenshots can be either graphical or textual. However, screenshots use a great deal of space in a text document to convey relatively small amounts of information. The same space in the document can hold a greater amount of more descriptive and helpful information. Therefore, authors should avoid screenshots whenever possible in favor of descriptive text." msgstr "" #: en_US/writing-guidelines.xml:474(para) msgid "One of the isolated instances in which screenshots are useful is to demonstrate a physical screen layout that is unfamiliar to a reader. This does not mean that illustrations of dialog boxes are good uses of screenshots. On the contrary, dialogs are simply instances of a user interface element with which a reader is already familiar. An annotated diagram in certain cases, however, explains to the reader where to find functional landmarks on the screen such as menu bars." msgstr "" #: en_US/writing-guidelines.xml:482(para) msgid "The steps for taking a graphical screenshot illustrate how using text to describe a procedure is more concise than a series of screenshots." msgstr "" #: en_US/writing-guidelines.xml:487(term) msgid "Graphical Screenshot" msgstr "" #: en_US/writing-guidelines.xml:491(para) msgid "Create a new user account to make screenshots. The new account uses the distribution default theme, fonts, and element sizes. The resulting screenshot has an appearance familiar to the largest number of readers, and makes Fedora Documentation Project documents consistent." msgstr "" #: en_US/writing-guidelines.xml:498(para) msgid "Before taking the screenshot, if possible, resize the targeted GUI element(s) to the smallest possible size. The target image should be 500 pixels wide or less. If the screenshot includes more than one GUI element, you may need to resize the screenshot in a following step." msgstr "" #: en_US/writing-guidelines.xml:506(para) msgid "To take the screenshot, select the GUI element with the mouse to bring it to the forefront, or otherwise arrange the elements. Press AltPrint Screen to capture a single GUI window. For capturing the entire desktop use Print Screen. If the shot includes multiple elements grouped closely together, crop the resulting PNG format image in The GIMP." msgstr "" #: en_US/writing-guidelines.xml:518(para) msgid "If necessary, resize the image using The GIMP. Open the image, then right-click on it and choose ImageScale Image.... With the chain symbol intact, set the New Width to 500 px, and click OK. Choose FileSave to save changes to the image before converting it." msgstr "" #: en_US/writing-guidelines.xml:534(para) msgid "With the image open in The GIMP, right-click the image, and select FileSave As.... Under Determine File Type:, select PostScript, then click OK. Allow flattening of the image by clicking Export." msgstr "" #: en_US/writing-guidelines.xml:545(para) msgid "A Save as PostScript window appears. Select Encapsulated PostScript, and click OK." msgstr "" #: en_US/writing-guidelines.xml:559(term) msgid "Text Screenshot" msgstr "" #: en_US/writing-guidelines.xml:561(para) msgid "Textual screen information is also useful for readers. Follow these guidelines for textual screenshots:" msgstr "" #: en_US/writing-guidelines.xml:565(para) msgid "If a graphical screenshot illustrates a function, and the textual mode has identical functions, do not include both, unless omitting either would make your description unclear." msgstr "" #: en_US/writing-guidelines.xml:571(para) msgid "Make the information generic over specific, and omit any username and machine information if possible. Do not include the shell prompt unless it is vital to the demonstration." msgstr "" #: en_US/writing-guidelines.xml:577(para) msgid "Separate what the user types from sample command output." msgstr "" #: en_US/writing-guidelines.xml:581(para) msgid "When using screen to demonstrate a procedure, use userinput tags to show what the user types, and use computeroutput tags to show the resulting output." msgstr "" #: en_US/writing-guidelines.xml:589(para) msgid " is an example of textual screenshot usage." msgstr "" #: en_US/writing-guidelines.xml:594(title) msgid "Correct Textual Screenshot (XML Source and HTML)" msgstr "" #: en_US/writing-guidelines.xml:607(para) msgid "To find all the currently active ssh sessions, execute the following command:" msgstr "" #: en_US/writing-guidelines.xml:609(userinput) #, no-wrap msgid "ps ax | grep ssh" msgstr "" #: en_US/writing-guidelines.xml:611(para) msgid "Output appears similar to the following:" msgstr "" #: en_US/writing-guidelines.xml:613(computeroutput) #, no-wrap 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 Help browser, also known as yelp, and the KDE Khelp 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 F1 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 "" #: en_US/module-struct.xml:13(para) msgid "Documentation modules have a specific structure that enables the preconfigured tools to work correctly. Follow this structure exactly or you may have problems building your module. The Fedora Documentation Project build tools locate resources in the module and use them to build new output such as HTML or RPM packages." msgstr "" #: en_US/module-struct.xml:19(title) msgid "Structure of a Module" msgstr "" #: en_US/module-struct.xml:20(para) msgid " shows a directory tree of an example module, excluding any CVS folders. Note that this example document does not have branches." msgstr "" #: en_US/module-struct.xml:25(title) msgid "Example Module Structure" msgstr "" #: en_US/module-struct.xml:47(title) msgid "CVS Module Contents" msgstr "" #: en_US/module-struct.xml:48(segtitle) msgid "Component" msgstr "" #: en_US/module-struct.xml:49(segtitle) msgid "Type" msgstr "" #: en_US/module-struct.xml:50(segtitle) msgid "Usage Notes" msgstr "" #: en_US/module-struct.xml:52(seg) msgid "Primary language directory" msgstr "" #: en_US/module-struct.xml:53(seg) en_US/module-struct.xml:94(seg) en_US/module-struct.xml:101(seg) msgid "required" msgstr "" #: en_US/module-struct.xml:56(filename) en_US/module-struct.xml:181(systemitem) msgid "en_US" msgstr "" #: en_US/module-struct.xml:60(firstterm) msgid "entities" msgstr "" #: en_US/module-struct.xml:61(para) msgid "Think of an XML entity as a predefined snippet of information. It can represent a chunk of XML source, or simply a word or character. If the information changes, it need be replaced only once, in the definition, to fix all usage." msgstr "" #: en_US/module-struct.xml:54(seg) msgid "This is the only directory absolutely required. It is named for the original language of the document, such as (US English). The primary language does not have to be US English; all languages are supported. This directory contains all the XML source for the actual document, as well as XML source for document-specific ." msgstr "" #: en_US/module-struct.xml:69(seg) msgid "Graphics directory" msgstr "" #: en_US/module-struct.xml:70(seg) en_US/module-struct.xml:80(seg) msgid "optional" msgstr "" #: en_US/module-struct.xml:71(filename) en_US/module-struct.xml:75(filename) msgid "figs/" msgstr "" #: en_US/module-struct.xml:71(seg) msgid "The directory is an optional directory where graphics for the document should be stored. If graphics are screenshots that are particular to a language, the directory can and should be stored in a language directory." msgstr "" #: en_US/module-struct.xml:79(seg) msgid "Translation (PO) directory" msgstr "" #: en_US/module-struct.xml:81(filename) en_US/module-struct.xml:87(filename) msgid "po/" msgstr "" #: en_US/module-struct.xml:83(acronym) msgid "PO" msgstr "" #: en_US/module-struct.xml:88(filename) msgid "LINGUAS" msgstr "" #: en_US/module-struct.xml:89(firstterm) msgid "locales" msgstr "" #: en_US/module-struct.xml:81(seg) msgid "The directory contains specially formatted Portable Object, or , files created and used by translators. The Fedora Documentation Project build tools use these files to create translated versions of documents. The translated documents are not stored in CVS; they are created as needed from these PO files. The directory also contains the file, which lists the active translation , or languages." msgstr "" #: en_US/module-struct.xml:93(seg) en_US/module-struct.xml:95(filename) msgid "Makefile" msgstr "" #: en_US/module-struct.xml:95(seg) msgid "The controls the build process. Its content is discussed in ." msgstr "" #: en_US/module-struct.xml:100(filename) en_US/module-struct.xml:102(filename) msgid "rpm-info.xml" msgstr "" #: en_US/module-struct.xml:102(seg) msgid "The file contains document specific metadata" msgstr "" #: en_US/module-struct.xml:107(title) msgid "Common Build Tools" msgstr "" #: en_US/module-struct.xml:108(para) msgid "Never add the docs-common build tools directory to an individual module. Special formatting in the module list downloads these tools when a user checks out a document module. For more information, refer to ." msgstr "" #: en_US/module-struct.xml:116(title) msgid "The Document Build System" msgstr "" #: en_US/module-struct.xml:121(para) msgid "In Linux and Fedora documentation, references to commands often include a number inside parentheses. This number represents the section of manpages that includes documentation for that command. To read the manpage for make(1), use the command man 1 make." msgstr "" #: en_US/module-struct.xml:117(para) msgid "The build system can render the document into another format such as HTML or PDF, using make(1) and shell scripts. Authors need no prior experience with either shell scripts or a make(1)." msgstr "" #: en_US/module-struct.xml:133(title) msgid "The Document Makefile" msgstr "" #: en_US/module-struct.xml:134(para) msgid "Each individual document has its own Makefile, which only needs to be a few lines long. The document Makefile content is designed for cut and paste operations." msgstr "" #: en_US/module-struct.xml:140(para) msgid " below shows the whole Makefile for a simple document with two files and two translations." msgstr "" #: en_US/module-struct.xml:146(title) msgid "Sample Document Makefile" msgstr "" #: en_US/module-struct.xml:162(para) msgid "Do not be concerned with some of the more complicated syntax such as the XMLFILES_template stanza. An explanation for this template appears a few paragraphs below." msgstr "" #: en_US/module-struct.xml:168(title) msgid "Makefile Variables" msgstr "" #: en_US/module-struct.xml:169(segtitle) msgid "Variable" msgstr "" #: en_US/module-struct.xml:170(segtitle) en_US/module-struct.xml:240(segtitle) msgid "Explanation" msgstr "" #: en_US/module-struct.xml:172(systemitem) msgid "DOCBASE" msgstr "" #: en_US/module-struct.xml:173(seg) msgid "This variable contains the name for the main (parent) XML document. Follow convention by naming your document after the module name." msgstr "" #: en_US/module-struct.xml:178(systemitem) msgid "PRI_LANG" msgstr "" #: en_US/module-struct.xml:179(seg) msgid "This variable contains the ISO code for the original version of the document, such as ." msgstr "" #: en_US/module-struct.xml:184(systemitem) msgid "DOC_ENTITIES" msgstr "" #: en_US/module-struct.xml:185(seg) msgid "This variable contains a listing of any files containing entity definitions. The Fedora Documentation Project uses a special XML format to record document-specific entities, so they can be translated and built on the fly like any other XML document. An example is shown later in this guide." msgstr "" #: en_US/module-struct.xml:194(systemitem) msgid "XMLFILES_template" msgstr "" #: en_US/module-struct.xml:197(systemitem) msgid "${1}" msgstr "" #: en_US/module-struct.xml:202(systemitem) msgid "${1}/" msgstr "" #: en_US/module-struct.xml:195(seg) msgid "This template allows the build tools to work with the document in multiple languages once it is translated. The marking is a variable used to substitute the appropriate language. This template is not terribly complicated. For a new module, duplicate this section exactly except for the actual filenames. Prepend the text , in place of the language code directory name, to each filename in your document." msgstr "" #: en_US/module-struct.xml:208(title) msgid "Files Exempt From Listing" msgstr "" #: en_US/module-struct.xml:209(para) msgid "Do not include the document-specific entities XML file or the rpm-info.xml file, which will be discussed later in this guide." msgstr "" #: en_US/module-struct.xml:213(para) msgid "The final section, beginning with define, locates the main Makefile.common for the build system. This Makefile.common file contains all the make(1) targets and rules to actually build the document and the various archives." msgstr "" #: en_US/module-struct.xml:222(title) msgid "The Document rpm-info.xml" msgstr "" #: en_US/module-struct.xml:223(para) msgid "Each document module's primary language directory contains a file called rpm-info.xml. This file contains document-specific metadata used to generate revision history, copyright, and contributor information. It follows a DTD specification included with the rest of the build system tools." msgstr "" #: en_US/module-struct.xml:232(title) msgid "Build System Actions" msgstr "" #: en_US/module-struct.xml:233(para) msgid "To render the XML document into another format, use one of the following make targets:" msgstr "" #: en_US/module-struct.xml:238(title) msgid "Build Targets" msgstr "" #: en_US/module-struct.xml:239(segtitle) msgid "Target" msgstr "" #: en_US/module-struct.xml:242(systemitem) msgid "help" msgstr "" #: en_US/module-struct.xml:243(seg) msgid "This target prints a list of available targets and their descriptions." msgstr "" #: en_US/module-struct.xml:247(systemitem) msgid "validate-xml" msgstr "" #: en_US/module-struct.xml:248(firstterm) msgid "validates" msgstr "" #: en_US/module-struct.xml:248(seg) msgid "This target the XML files to make sure they are not only well-formed, but follow the DTD. Some viewers of XML documents may not work correctly until you run this target. This target includes copying required entity files so that validating XML viewers work properly" msgstr "" #: en_US/module-struct.xml:256(systemitem) msgid "html" msgstr "" #: en_US/module-struct.xml:257(abbrev) en_US/module-struct.xml:268(abbrev) en_US/module-struct.xml:293(abbrev) en_US/module-struct.xml:298(abbrev) msgid "HTML" msgstr "" #: en_US/module-struct.xml:261(systemitem) en_US/module-struct.xml:271(systemitem) msgid "${DOCBASE}" msgstr "" #: en_US/module-struct.xml:262(systemitem) en_US/module-struct.xml:272(systemitem) msgid "${LANG}" msgstr "" #: en_US/module-struct.xml:260(filename) msgid "-/" msgstr "" #: en_US/module-struct.xml:257(seg) msgid "This target builds the \"chunked\" document for each defined translation. Output is placed in a separate directory named . Each document section is a separate file within that directory." msgstr "" #: en_US/module-struct.xml:267(systemitem) msgid "html-nochunks" msgstr "" #: en_US/module-struct.xml:270(filename) msgid "-.html" msgstr "" #: en_US/module-struct.xml:268(seg) msgid "This target builds the \"non-chunked\" document for each defined translation. Output is placed in a single file: ; no other files are created." msgstr "" #: en_US/module-struct.xml:276(systemitem) msgid "pdf" msgstr "" #: en_US/module-struct.xml:277(abbrev) en_US/module-struct.xml:278(abbrev) en_US/module-struct.xml:294(abbrev) en_US/module-struct.xml:299(abbrev) msgid "PDF" msgstr "" #: en_US/module-struct.xml:277(seg) msgid "This target builds only the document for all document languages. production is currently erratic and may not work for your document." msgstr "" #: en_US/module-struct.xml:282(systemitem) msgid "tarball" msgstr "" #: en_US/module-struct.xml:283(command) msgid "tar(1)" msgstr "" #: en_US/module-struct.xml:283(seg) msgid "This target builds only the archive for all document languages." msgstr "" #: en_US/module-struct.xml:287(systemitem) msgid "all" msgstr "" #: en_US/module-struct.xml:288(seg) msgid "This target builds all targets listed above." msgstr "" #: en_US/module-struct.xml:291(systemitem) en_US/module-struct.xml:300(filename) msgid "clean" msgstr "" #: en_US/module-struct.xml:293(emphasis) msgid "not" msgstr "" #: en_US/module-struct.xml:292(seg) msgid "This target deletes any temporary, or generated files, but does erase any , , or archive files." msgstr "" #: en_US/module-struct.xml:297(systemitem) msgid "distclean" msgstr "" #: en_US/module-struct.xml:298(seg) msgid "This target erases all , , and archive files. This target automatically invokes the target as well." msgstr "" #: en_US/module-struct.xml:305(title) msgid "PDF Generation is Erratic" msgstr "" #: en_US/module-struct.xml:306(para) msgid "PDF production is currently erratic and may not work for your document." msgstr "" #: en_US/module-struct.xml:311(title) msgid "Adding or Changing Targets" msgstr "" #: en_US/module-struct.xml:312(para) msgid "To add a new target and rules, place them at the bottom of the document Makefile, below the include line. Follow your target definitions with a double colon, not a single colon. The double colon allows you to specify additional rules for existing targets, or to write rules for a new target." msgstr "" #: en_US/module-struct.xml:320(para) msgid "For more information on using make(1), consult the online documentation with the command info make in a terminal." msgstr "" #: en_US/module-struct.xml:327(title) msgid "Using Document Image Files" msgstr "" #: en_US/module-struct.xml:328(para) msgid "Tutorial documents often make use of images such as .PNG files. Store image files in a figs/ folder in the main module directory, as shown in ." msgstr "" #: en_US/module-struct.xml:335(para) msgid "Depending on the output media, sometimes images may be scaled, streteched, or squashed. To minimize any distortions, we recommend that you use only .PNG images. Avoid .JPG files. The convert(1) program, from the ImageMagickRPM package, provides a convenient way to reformat .JPG images into .PNG format. For more information on formatting images such as screenshots, refer to ." msgstr "" #: en_US/module-struct.xml:349(para) msgid "Image files may be organized into subdirectories under figs/ if necessary. The document building system recreates the image subdirectory structure in the output documents." msgstr "" #: en_US/module-struct.xml:355(para) msgid "Images often contain labels or other text which may need to be localized. A screenshot of a program, for example, may require a version for each translated language. Name language-dependent image files such as program screenshots by adding the language code to the filename, such as menu-en_US.png. Language-independent images, such as icon.png, do not need language codes." msgstr "" #: en_US/module-struct.xml:365(para) msgid "Sometimes, a document may require images that do not follow the naming convention. To use these images with the document building system, create an ordinary text file containing the image filenames. This file must be named figs/Manifest-${LANG} so the build system finds it when searching for image filenames." msgstr "" #: en_US/module-struct.xml:374(para) msgid " demonstrates one way to create this Manifest file." msgstr "" #: en_US/module-struct.xml:380(title) msgid "Building A Manifest" msgstr "" #: en_US/module-struct.xml:387(title) msgid "Adding a New DocBook XML File" msgstr "" #: en_US/module-struct.xml:388(para) msgid "To add a new DocBook XML file to an existing document, follow these steps:" msgstr "" #: en_US/module-struct.xml:392(para) msgid "Place the new DocBook XML file in the primary language directory." msgstr "" #: en_US/module-struct.xml:396(para) msgid "Edit the Makefile and add the filename to the XMLFILES-${1} listing. Append a \\ to the last existing line, and on the next line add an entry for the new file. Remember to add the ${1}/ prefix as a substitute for the language directory name." msgstr "" #: en_US/module-struct.xml:406(title) msgid "Adding a Translation" msgstr "" #: en_US/module-struct.xml:407(para) msgid "Translations are stored as PO (portable object) files, which the toolchain transforms into translated documents. Each PO file is based on the POT (PO template) for the document and translated by the Fedora Translation Project. To add a translation, follow these steps:" msgstr "" #: en_US/module-struct.xml:414(para) msgid "If the po/ directory does not exist, create it and add it to CVS:" msgstr "" #: en_US/module-struct.xml:420(para) msgid "If it does not exist, create the POT file:" msgstr "" #: en_US/module-struct.xml:424(para) msgid "Add the new translation language to the OTHERS listing in the Makefile." msgstr "" #: en_US/module-struct.xml:429(para) msgid "Although translators often copy the POT manually to create the new PO file, the following command also works:" msgstr "" #: en_US/module-struct.xml:432(replaceable) msgid "lang" msgstr "" #: en_US/module-struct.xml:432(screen) #, no-wrap msgid "make po/.po" msgstr "" #: en_US/intro.xml:13(title) msgid "Introduction" msgstr "" #: en_US/intro.xml:15(para) msgid "The goal of the Fedora Documentation Project is to create easy-to-follow, task-based documentation for Fedora users and developers. The Fedora Documentation Project uses the following tools:" msgstr "" #: en_US/intro.xml:23(para) msgid "DocBook XML v4.4" msgstr "" #: en_US/intro.xml:26(para) msgid "Custom XSLT stylesheets for both print and HTML versions" msgstr "" #: en_US/intro.xml:30(para) msgid "Custom scripts to generate HTML output (use xmlto)" msgstr "" #: en_US/intro.xml:34(para) msgid "Emacs with PSGML mode (optional, but recommended)" msgstr "" #: en_US/intro.xml:43(para) msgid "This document explains the tools used by the Fedora Documentation Project. It provides writing and tagging guidelines to ensure Fedora documentation is consistent and easy-to-follow." msgstr "" #: en_US/getting-files.xml:12(title) msgid "Prerequisites" msgstr "" #: en_US/getting-files.xml:14(para) msgid "To work on official Fedora documentation you need to install the required tools. Follow the directions below to configure your system." msgstr "" #: en_US/getting-files.xml:20(title) msgid "System Packages" msgstr "" #: en_US/getting-files.xml:22(para) msgid "Install the \"Authoring and Publishing\" package group, which contains required DocBook XML files, stylesheets and scripts:" msgstr "" #: en_US/getting-files.xml:28(userinput) #, no-wrap msgid "su -c 'yum groupinstall \"Authoring and Publishing\"'" msgstr "" #: en_US/getting-files.xml:31(para) msgid "Next, install the cvs package, which is used to handle revision control on files in the official repository:" msgstr "" #: en_US/getting-files.xml:37(userinput) #, no-wrap msgid "su -c 'yum install cvs'" msgstr "" #: en_US/getting-files.xml:40(para) msgid "If you plan to use Emacs to edit DocBook XML documentation, install psgml, which adds helpful and time-saving functionality to maximize editing efficiency:" msgstr "" #: en_US/getting-files.xml:44(userinput) #, no-wrap msgid "su -c 'yum install psgml'" msgstr "" #: en_US/getting-files.xml:48(title) msgid "Fedora Documentation Tools" msgstr "" #: en_US/getting-files.xml:50(para) msgid "The Fedora Documentation Project's custom scripts and stylesheets are stored in CVS on the cvs.fedoraproject.org CVS server. When you check out a document module from CVS, the tools are included in the module inside the docs-common/ directory. To work on existing documents in CVS, refer to ." msgstr "" #: en_US/getting-files.xml:59(para) msgid "The most powerful component in the Fedora Documentation Project toolbox is DocBook XML. DocBook XML is a specific scheme for authoring technical documentation using Extensible Markup Language, or XML. XML allows authors to mark pieces of content with descriptive tags. The following output is an example of DocBook XML:" msgstr "" #: en_US/getting-files.xml:76(para) msgid "This example article, entitled A Very Short Article, consists of only a single paragraph. The tags, or markup, surround elements of content to define the sense in which they are used. A paragraph, for example, is marked with para tags. Text that requires emphasis is marked with emphasis tags. The author does not worry about the visual formatting such as italics or font size. Fedora Documentation Project build tools automatically perform all formatting tasks." msgstr "" #: en_US/getting-files.xml:85(para) msgid "The custom tools built by the Fedora Documentation Project render DocBook source into a variety of formats for publication and distribution. They also allow translators to create localized versions of the XML documents for Fedora users around the world. The flexibility of XML allows for a single document to be used many times for many purposes, like reusable code for a programmer." msgstr "" #: en_US/getting-files.xml:91(para) msgid "DocBook is itself very well documented. For more information about DocBook, visit . The DocBook site also features complete copies of DocBook: The Definitive Guide to browse and download, the canonical source for DocBook information." msgstr "" #: en_US/getting-files.xml:97(title) msgid "DocBook XML Versions" msgstr "" #: en_US/getting-files.xml:98(para) 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:103(para) msgid "Contributors who use the Microsoft Windows operating system can still make use of DocBook tools. For more information, refer to ." msgstr "" #: en_US/getting-files.xml:110(title) msgid "Naming Conventions" msgstr "" #: en_US/getting-files.xml:111(para) msgid "The Fedora Documentation Project provides the tools, scripts, and stylesheets to transform your XML documents into other output formats such as HTML. In addition, these tools can build your document into a RPM package. To take advantage of these services, follow the conventions in this section to name your files." msgstr "" #: en_US/getting-files.xml:119(para) msgid "On the CVS server, directories that contain document files are called modules. Each module represents a single document. Each document may consist of several branches 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:126(para) msgid "Use the cvs co -c command to view existing module names." msgstr "" #: en_US/getting-files.xml:129(title) msgid "Partial List of CVS Modules" msgstr "" #: en_US/getting-files.xml:130(userinput) #, no-wrap msgid "cd ~/localrepo/fedora-docs/" msgstr "" #: 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 ." msgstr "" #: en_US/getting-files.xml:154(para) msgid "Note in the listing above that the about-fedora 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 documentation-guide module is not branched." msgstr "" #: en_US/getting-files.xml:161(title) msgid "Modules Labeled -dir" msgstr "" #: en_US/getting-files.xml:162(para) msgid "Modules ending with the suffix -dir 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:168(title) msgid "Module Names" msgstr "" #: 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 fedora is a reasonable choice in most cases. Use the length descriptors tutorial or guide in the module name where appropriate." msgstr "" #: en_US/getting-files.xml:178(title) msgid "Avoid Redundancy" msgstr "" #: en_US/getting-files.xml:179(para) msgid "Do not use the word fedora to name modules in the Fedora Documentation Project CVS repository." msgstr "" #: en_US/getting-files.xml:185(title) msgid "Correct Module Naming" msgstr "" #: en_US/getting-files.xml:186(segtitle) msgid "Document Name" msgstr "" #: en_US/getting-files.xml:187(segtitle) msgid "CVS Module Name" msgstr "" #: en_US/getting-files.xml:189(seg) msgid "Desktop User Guide" msgstr "" #: en_US/getting-files.xml:190(seg) msgid "desktop-user-guide" msgstr "" #: en_US/getting-files.xml:194(application) msgid "Yum" msgstr "" #: en_US/getting-files.xml:193(seg) msgid "Software Management with " msgstr "" #: en_US/getting-files.xml:195(seg) msgid "yum-guide" msgstr "" #: en_US/getting-files.xml:198(application) msgid "Pup" msgstr "" #: en_US/getting-files.xml:198(seg) msgid "Using " msgstr "" #: en_US/getting-files.xml:199(seg) msgid "pup-tutorial" msgstr "" #: en_US/getting-files.xml:204(title) msgid "File Names" msgstr "" #: 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:209(para) msgid "As with module names, avoid using the word fedora in file names since it is redundant." msgstr "" #: 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:219(para) msgid "Avoid numbering files to show order, since editors and authors often rearrange documents or reuse their files in other documents." msgstr "" #: en_US/emacs.xml:13(title) msgid "Emacs and PSGML Mode" msgstr "" #: en_US/emacs.xml:16(primary) msgid "PSGML" msgstr "" #: en_US/emacs.xml:20(primary) en_US/emacs.xml:24(primary) en_US/emacs.xml:43(primary) en_US/emacs.xml:224(primary) en_US/emacs.xml:233(primary) en_US/emacs.xml:238(primary) en_US/emacs.xml:243(primary) en_US/emacs.xml:523(application) en_US/emacs-nxml.xml:18(primary) en_US/emacs-nxml.xml:22(primary) msgid "Emacs" msgstr "" #: en_US/emacs.xml:25(secondary) msgid "PSGML mode" msgstr "" #: en_US/emacs.xml:28(para) msgid "You can use the PSGML mode available for Emacs to make it easier to write in XML format. PSGML mode provides syntax-highlighting, tag completion, and more." msgstr "" #: en_US/emacs.xml:35(title) msgid "Installing PSGML" msgstr "" #: en_US/emacs.xml:36(para) msgid "To install PSGML, use the yum command:" msgstr "" #: en_US/emacs.xml:37(userinput) #, no-wrap msgid "yum install psgml" msgstr "" #: en_US/emacs.xml:40(title) msgid "Setting Up Your .emacs File" msgstr "" #: en_US/emacs.xml:48(filename) msgid ".emacs" msgstr "" #: en_US/emacs.xml:51(para) msgid "For Emacs to parse your DocBook documents correctly, you must have a .emacs file. Cut and paste the following into your existing .emacs file or create a new one that contains the following lines:" msgstr "" #: en_US/emacs.xml:181(para) msgid "If you have a wheel mouse and are using Emacs version 21, you can add the following to your .emacs file so your wheel will work in Emacs:" msgstr "" #: en_US/emacs.xml:192(para) msgid "If you are using the older version 20 of Emacs, add the following instead:" msgstr "" #: en_US/emacs.xml:221(title) msgid "Customizing Emacs" msgstr "" #: en_US/emacs.xml:225(secondary) msgid "customizing" msgstr "" #: en_US/emacs.xml:229(filename) msgid ".Xresources" msgstr "" #: en_US/emacs.xml:234(secondary) msgid "colors" msgstr "" #: en_US/emacs.xml:239(secondary) msgid "font" msgstr "" #: en_US/emacs.xml:244(secondary) msgid "geometry" msgstr "" #: en_US/emacs.xml:247(para) msgid "The colors, font, and geometry (default size of window) for Emacs in your ~/.Xresources file. The format for the settings is emacs.keyword:value." msgstr "" #: en_US/emacs.xml:253(para) msgid "The following is a sample ~/.Xresources file." msgstr "" #: en_US/emacs.xml:258(para) msgid "If you have other settings in your ~/.Xresources, add the following to the end of the file." msgstr "" #: en_US/emacs.xml:270(para) msgid "After modifying this file, execute the following command:" msgstr "" #: en_US/emacs.xml:273(command) msgid "xrdb -merge ~/.Xresources" msgstr "" #: en_US/emacs.xml:274(para) msgid "Then restart Emacs to apply the changes." msgstr "" #: en_US/emacs.xml:395(title) msgid "Basic Emacs Commands" msgstr "" #: en_US/emacs.xml:397(para) msgid "The Meta key is usually the Alt key." msgstr "" #: en_US/emacs.xml:403(title) msgid "Emacs Commands" msgstr "" #: en_US/emacs.xml:404(segtitle) msgid "Shortcut" msgstr "" #: en_US/emacs.xml:405(segtitle) msgid "Description" msgstr "" #: en_US/emacs.xml:408(keycap) en_US/emacs.xml:412(keycap) en_US/emacs.xml:430(keycap) en_US/emacs.xml:436(keycap) en_US/emacs.xml:443(keycap) en_US/emacs.xml:448(keycap) en_US/emacs.xml:453(keycap) en_US/emacs.xml:458(keycap) en_US/emacs.xml:463(keycap) en_US/emacs.xml:468(keycap) en_US/emacs.xml:473(keycap) en_US/emacs.xml:478(keycap) en_US/emacs.xml:483(keycap) en_US/emacs.xml:488(keycap) en_US/emacs.xml:508(keycap) en_US/emacs.xml:509(keycap) en_US/emacs.xml:514(keycap) en_US/emacs.xml:515(keycap) en_US/emacs.xml:520(keycap) en_US/emacs.xml:521(keycap) en_US/emacs.xml:532(keycap) en_US/emacs.xml:533(keycap) en_US/emacs.xml:540(keycap) en_US/emacs.xml:542(keycap) msgid "Ctrl" msgstr "" #: en_US/emacs.xml:409(keycap) en_US/emacs.xml:430(keycap) en_US/emacs.xml:436(keycap) en_US/emacs.xml:448(keycap) en_US/emacs.xml:521(keycap) en_US/emacs.xml:532(keycap) en_US/emacs.xml:540(keycap) en_US/emacs.xml:542(keycap) msgid "c" msgstr "" #: en_US/emacs.xml:413(keycap) msgid "p" msgstr "" #: en_US/emacs.xml:407(seg) en_US/emacs.xml:508(seg) en_US/emacs.xml:514(seg) en_US/emacs.xml:520(seg) en_US/emacs.xml:532(seg) en_US/emacs.xml:540(seg) msgid ", " msgstr "" #: en_US/emacs.xml:415(seg) msgid "Parse DTD" msgstr "" #: en_US/emacs.xml:431(keycap) en_US/emacs.xml:437(keycap) msgid "Shift" msgstr "" #: en_US/emacs.xml:432(keycap) en_US/emacs.xml:438(keycap) msgid "," msgstr "" #: en_US/emacs.xml:432(keycap) en_US/emacs.xml:439(keycap) msgid "Tab" msgstr "" #: en_US/emacs.xml:430(seg) msgid ", , " msgstr "" #: en_US/emacs.xml:433(seg) msgid "Display list of valid tags" msgstr "" #: en_US/emacs.xml:436(seg) msgid ", , type beginning of tag, " msgstr "" #: en_US/emacs.xml:440(seg) msgid "Complete the tag" msgstr "" #: en_US/emacs.xml:443(keycap) msgid "g" msgstr "" #: en_US/emacs.xml:445(seg) msgid "Cancel a command in the minibuffer" msgstr "" #: en_US/emacs.xml:449(keycap) msgid "/" msgstr "" #: en_US/emacs.xml:448(seg) msgid ", " msgstr "" #: en_US/emacs.xml:450(seg) msgid "Close tag" msgstr "" #: en_US/emacs.xml:453(keycap) en_US/emacs.xml:533(keycap) msgid "a" msgstr "" #: en_US/emacs.xml:455(seg) msgid "Move cursor to beginning of line" msgstr "" #: en_US/emacs.xml:458(keycap) msgid "e" msgstr "" #: en_US/emacs.xml:460(seg) msgid "Move cursor to the end of the line" msgstr "" #: en_US/emacs.xml:463(keycap) msgid "Home" msgstr "" #: en_US/emacs.xml:465(seg) msgid "Move cursor to the beginning of the file" msgstr "" #: en_US/emacs.xml:468(keycap) msgid "End" msgstr "" #: en_US/emacs.xml:470(seg) msgid "Move cursor to the end of the file" msgstr "" #: en_US/emacs.xml:473(keycap) msgid "k" msgstr "" #: en_US/emacs.xml:475(seg) msgid "Cut line" msgstr "" #: en_US/emacs.xml:478(keycap) msgid "y" msgstr "" #: en_US/emacs.xml:480(seg) msgid "Paste line" msgstr "" #: en_US/emacs.xml:483(keycap) en_US/emacs.xml:515(keycap) msgid "s" msgstr "" #: en_US/emacs.xml:485(seg) msgid "Search forward in the file" msgstr "" #: en_US/emacs.xml:488(keycap) msgid "r" msgstr "" #: en_US/emacs.xml:490(seg) msgid "Search backwards in the file" msgstr "" #: en_US/emacs.xml:493(keycap) en_US/emacs.xml:498(keycap) en_US/emacs.xml:503(keycap) en_US/emacs.xml:527(keycap) msgid "Meta" msgstr "" #: en_US/emacs.xml:493(keycap) msgid "$" msgstr "" #: en_US/emacs.xml:495(seg) en_US/emacs.xml:500(seg) msgid "Check spelling of current word" msgstr "" #: en_US/emacs.xml:498(keycap) en_US/emacs.xml:503(keycap) en_US/emacs.xml:508(keycap) en_US/emacs.xml:514(keycap) en_US/emacs.xml:520(keycap) msgid "x" msgstr "" #: en_US/emacs.xml:499(keycap) en_US/emacs.xml:504(keycap) msgid "Enter" msgstr "" #: en_US/emacs.xml:498(seg) msgid " ispell-word, " msgstr "" #: en_US/emacs.xml:503(seg) msgid " ispell-buffer, " msgstr "" #: en_US/emacs.xml:505(seg) msgid "Check spelling of current buffer" msgstr "" #: en_US/emacs.xml:509(keycap) msgid "f" msgstr "" #: en_US/emacs.xml:511(seg) msgid "Open file" msgstr "" #: en_US/emacs.xml:517(seg) msgid "Save file" msgstr "" #: en_US/emacs.xml:523(seg) msgid "Exit and prompt to save files if necessary" msgstr "" #: en_US/emacs.xml:527(keycap) msgid "q" msgstr "" #: en_US/emacs.xml:529(seg) msgid "Fill paragraph" msgstr "" #: en_US/emacs.xml:536(computeroutput) #, no-wrap msgid "url" msgstr "" #: en_US/emacs.xml:537(computeroutput) #, no-wrap msgid "ulink" msgstr "" #: en_US/emacs.xml:535(seg) msgid "Edit attributes for a tag (for example, you can edit the attribute of the tag)" msgstr "" #: en_US/emacs.xml:544(seg) msgid "Exit edit attributes" msgstr "" #: en_US/emacs.xml:550(title) en_US/emacs-nxml.xml:77(title) msgid "Examples" msgstr "" #: en_US/emacs.xml:552(para) msgid "The table or reference card of Emacs and PSGML commands can be confusing for beginners. This section provides some examples of how to use them." msgstr "" #: en_US/emacs.xml:559(title) msgid "Tag Completion" msgstr "" #: en_US/emacs.xml:563(para) msgid "This section assumes that you have already parsed the DTD file." msgstr "" #: en_US/emacs.xml:567(para) msgid "To avoid having to type a tag repeatedly, use the key combination Ctrl-c, followed by <. At the bottom of the Emacs window, the following prompt appears:" msgstr "" #: en_US/emacs.xml:574(prompt) msgid "Tag: <" msgstr "" #: en_US/emacs.xml:576(para) msgid "To view a list of available tags, use either the Tab or ?. If you know the first few letters of a tag, enter them, followed by Tab. If the letters uniquely identify a tag, that tag appears. If more than one completion exists, a complete list of possible tags appears." msgstr "" #: en_US/emacs.xml:585(para) msgid "If you hit Ctrlc, <, k, a prompt appears similar to the example below:" msgstr "" #: en_US/emacs.xml:602(title) msgid "Tag Closure" msgstr "" #: en_US/emacs.xml:604(para) msgid "After you open a tag, you must close it. The easiest way to close an open tag is to use the key sequence Ctrlc, /. This sequence closes the most recently opened tag." msgstr "" #: en_US/emacs.xml:616(title) msgid "Other Emacs Tasks" msgstr "" #: en_US/emacs.xml:619(title) msgid "Working with One Window" msgstr "" #: en_US/emacs.xml:620(para) msgid "Sometimes in Emacs, the window becomes split, with tags completions or other text in an alternate window. To return to a single window, use the key sequence Ctrlx, 1." msgstr "" #: en_US/emacs.xml:630(title) msgid "Saving Work" msgstr "" #: en_US/emacs.xml:631(para) msgid "To save your work, use the key sequence Ctrlx, Ctrls." msgstr "" #: en_US/emacs.xml:642(title) msgid "The \"Clear/Quit\" Command" msgstr "" #: en_US/emacs.xml:643(para) msgid "If the tag completion process becomes unwieldy or confusing, use the keysequence Ctrlg to exit back to the text. Emacs clears any prompts and returns to the buffer text." msgstr "" #: en_US/emacs.xml:653(title) msgid "Opening a new file" msgstr "" #: en_US/emacs.xml:654(para) msgid "To open a new file, use the key sequence Ctrlx, Ctrlf. A prompt appears at the bottom of the Emacs window. Enter the file name, using Tab completion if desired, of the file you wish to open." msgstr "" #: en_US/emacs.xml:668(title) msgid "Closing Emacs" msgstr "" #: en_US/emacs.xml:669(para) msgid "To close Emacs use the key sequence Ctrlx, Ctrlc. If you have not saved your work, Emacs prompts you to save any changed files." msgstr "" #: en_US/emacs.xml:687(title) en_US/emacs-nxml.xml:127(title) msgid "Additional Resources" msgstr "" #: en_US/emacs.xml:689(para) msgid "Additional Emacs and PSGML references are available at the following locations:" msgstr "" #: en_US/emacs.xml:697(citetitle) en_US/emacs-nxml.xml:143(citetitle) msgid "Emacs Quick Reference Guide" msgstr "" #: en_US/emacs.xml:701(para) msgid "Emacs reference card that comes with the emacs package. You can print it out as a reference. —/usr/share/emacs/version/etc/refcard.ps" msgstr "" #: en_US/emacs.xml:708(para) msgid "Read Editing XML with Emacs and PSGML in /usr/share/doc/psgml-version/psgml.ps." msgstr "" #: en_US/emacs.xml:714(para) msgid "Emacs/PSGML Quick Reference is a reference table of Emacs commands for PSGML mode." msgstr "" #: en_US/emacs.xml:723(citetitle) msgid "PSGML Tricks" msgstr "" #: en_US/emacs-nxml.xml:11(title) msgid "Emacs and nXML Mode" msgstr "" #: en_US/emacs-nxml.xml:14(primary) en_US/emacs-nxml.xml:51(primary) msgid "nXML" msgstr "" #: en_US/emacs-nxml.xml:23(secondary) msgid "nXML mode" msgstr "" #: en_US/emacs-nxml.xml:26(para) msgid "You can also use the nXML mode available for Emacs to make it even easier to write in DocBook XML format. nXML mode provides context-sensitive editing using completion, real time validity error checking, syntax highlighting and indentation. All you need to do is install an RPM!!" msgstr "" #: en_US/emacs-nxml.xml:35(title) msgid "Early stages" msgstr "" #: en_US/emacs-nxml.xml:36(para) msgid "Please be aware the nxml-mode for Emacs is quite new, so there are a few things that the advanced user might notice when using it with other documents types. If you keep an eye on the mailing-list, you can keep up to date with these, as well as ask questions. For more details, check out ." msgstr "" #: en_US/emacs-nxml.xml:48(title) msgid "Getting the nXML RPM" msgstr "" #: en_US/emacs-nxml.xml:52(secondary) msgid "RPM" msgstr "" #: en_US/emacs-nxml.xml:56(primary) msgid "nXML RPM" msgstr "" #: en_US/emacs-nxml.xml:59(para) msgid "To use nXML mode with emacs, you will need to install the nXML RPM available from Tim Waugh's website or the source from http://www.thaiopensource.com/download/. The source requires a lot more work to setup, therefore we will only be concentrating on the RPM version." msgstr "" #: en_US/emacs-nxml.xml:69(para) msgid "Information on where to get the source is available in ." msgstr "" #: en_US/emacs-nxml.xml:79(para) msgid "Compared to PSGML mode there are only couple of commands that you need. This speeds up writing with Emacs considerably, which means you can concentrate more on the content of your article." msgstr "" #: en_US/emacs-nxml.xml:88(para) msgid "To create a tag, type < and then type the keyword. To complete the keyword, press Ctrl-Ret, then add the last >. To close a tag, type </." msgstr "" #: en_US/emacs-nxml.xml:97(para) msgid "When you open a document that doesn't have a DOCTYPE declaration at the top of the file, you will get this message and tag completion won't work because nXML will not know what format you are writing." msgstr "" #: en_US/emacs-nxml.xml:104(para) msgid "To load the schema, type Ctrl-c, then Ctrl-s and navigate to /usr/share/emacs/site-lisp/nxml-mode/schema/ and load docbook.rnc. Emacs will then prompt you to save it in the current working directory." msgstr "" #: en_US/emacs-nxml.xml:115(para) msgid "The commands already discussed are the only differences between using Emacs with PSGML mode and Emacs with nXML mode. You will still need to use all the same commands as discussed in ." msgstr "" #: en_US/emacs-nxml.xml:129(para) msgid "Additional Emacs and nXML references are available at the following locations:" msgstr "" #: en_US/emacs-nxml.xml:136(ulink) msgid "http://www.thaiopensource.com/download/" msgstr "" #: en_US/emacs-nxml.xml:137(citetitle) msgid "Author's download area" msgstr "" #: en_US/emacs-nxml.xml:142(ulink) msgid "http://wks.uts.ohio-state.edu/unix_course/intro-135.html" msgstr "" #: en_US/emacs-nxml.xml:147(para) msgid "Emacs reference card that comes with the emacs package. You can print it out as a reference. —/usr/share/emacs/<version>/etc/refcard.ps" msgstr "" #: en_US/emacs-nxml.xml:157(title) msgid "nXML README File" msgstr "" #: en_US/emacs-nxml.xml:161(para) msgid "This file can be found in the directory you extracted the source into, or in /usr/share/doc/nxml-mode-<version>/ if you installed the RPM." msgstr "" #: en_US/emacs-nxml.xml:169(para) msgid "README file:" msgstr "" #: en_US/emacs-nxml.xml:171(para) msgid "This is a new major mode for GNU Emacs for editing XML documents. It supports editing well-formed XML documents and also provides schema-sensitive editing of XML documents using RELAX NG Compact Syntax." msgstr "" #: en_US/emacs-nxml.xml:177(para) msgid "To use this, you need GNU Emacs version 21.x, preferably 21.3. GNU Emacs version 20 will not work properly, nor will XEmacs. To get started, do the following:" msgstr "" #: en_US/emacs-nxml.xml:184(command) msgid "M-x load-file RET rng-auto.el RET" msgstr "" #: en_US/emacs-nxml.xml:187(para) msgid "This defines the necessary autoloads. Now, visit a file containing an XML document, and do the following:" msgstr "" #: en_US/emacs-nxml.xml:192(command) msgid "M-x nxml-mode" msgstr "" #: en_US/emacs-nxml.xml:195(para) msgid "Now do" msgstr "" #: en_US/emacs-nxml.xml:200(command) msgid "C-h m" msgstr "" #: en_US/emacs-nxml.xml:203(para) msgid "For information on how to use nxml-mode. The beginnings of a manual are in nxml-mode.info. You can read this using:" msgstr "" #: en_US/emacs-nxml.xml:209(command) msgid "C-u M-x info RET nxml-mode.info RET" msgstr "" #: en_US/emacs-nxml.xml:212(para) msgid "It's also installed as an entry at the end of the top-level info directory. So you can read it with C-h i as usual." msgstr "" #: en_US/emacs-nxml.xml:217(para) msgid "You can use test.valid.xml and test.invalid.xml as examples of valid and invalid XML documents." msgstr "" #: en_US/emacs-nxml.xml:223(para) msgid "To get things automatically loaded each time you start Emacs, add:" msgstr "" #: en_US/emacs-nxml.xml:228(computeroutput) #, no-wrap msgid " (load \"~/nxml-mode-200YMMDD/rng-auto.el\")\n " msgstr "" #: en_US/emacs-nxml.xml:232(para) msgid "to your .emacs, where ~/nxml-mode-200YMMDD is the directory containing the .elc files. Note that rng-auto.el does not load all of the nxml-mode code; it merely sets things up so that all the features of nxml-mode will be autoloaded properly. You should not try to autoload rng-auto.el itself." msgstr "" #: en_US/emacs-nxml.xml:242(para) msgid "To use nxml-mode automatically for files with an extension of xml, xsl, rng or xhtml, add the following to your .emacs file:" msgstr "" #: en_US/emacs-nxml.xml:250(computeroutput) #, no-wrap msgid " (setq auto-mode-alist (cons\n\t'(\"\\\\.\\\\(xml\\\\|xsl\\\\|rng\\\\|xhtml\\\\)\\\\'\" . nxml-mode) auto-mode-alist))\n " msgstr "" #: en_US/emacs-nxml.xml:255(para) msgid "If you edit XML using iso-8859-N encodings other than iso-8859-1 and you are running Emacs 21.3 or later, then I recommend enabling unify-8859-on-decoding-mode, by adding the following to your .emacs file:" msgstr "" #: en_US/emacs-nxml.xml:263(computeroutput) #, no-wrap msgid "(unify-8859-on-decoding-mode)" msgstr "" #: en_US/emacs-nxml.xml:266(para) msgid "To get validation and schema-sensitive editing, you need a RELAX NG Compact Syntax (RNC) schema for you document. The schema directory includes some schemas for popular document types." msgstr "" #: en_US/emacs-nxml.xml:272(para) msgid "For more on RELAX NG, refer to http://relaxng.org/." msgstr "" #: en_US/emacs-nxml.xml:277(para) msgid "For a tutorial on RELAX NG Compact Syntax, refer to http://relaxng.org/compact-tutorial.html" msgstr "" #: en_US/emacs-nxml.xml:282(para) msgid "For automatically creating RNC schemas, I recommend my Trang program: http://eee.thaiopensource.com/relaxng/trang.html\"" msgstr "" #: en_US/emacs-nxml.xml:293(para) msgid "Infer an RNC schema from an instance document" msgstr "" #: en_US/emacs-nxml.xml:298(para) msgid "Convert a DTD to an RNC schema" msgstr "" #: en_US/emacs-nxml.xml:303(para) msgid "Convert a RELAX NG XML syntax schema to an RNC schema" msgstr "" #: en_US/emacs-nxml.xml:288(para) msgid "You can use this to " msgstr "" #: en_US/emacs-nxml.xml:310(para) msgid "To convert a RELAX NG XML syntax (.rng) schema to a RNC schema, you can also use the XSLT stylesheet from http://www.pantor.com/download.html\"." msgstr "" #: en_US/emacs-nxml.xml:316(para) msgid "To convert a W3C XML Schema to an RNC schema, you need first to convert it to RELAX NG XML syntax using Sun's RELAX NG converter tool rngconv (built on top of MSV). Refer to https://www.dev.java.net/." msgstr "" #: en_US/emacs-nxml.xml:323(para) msgid "The file NEWS describes recent changes." msgstr "" #: en_US/emacs-nxml.xml:327(para) msgid "Please use the list http://groups.yahoo.com/group/emacs-nxml-mode for bug reports, discussion. I will announce all new versions there." msgstr "" #: en_US/emacs-nxml.xml:333(para) msgid "James Clark" msgstr "" #: en_US/emacs-nxml.xml:336(para) msgid "jjc@thaiopensource.com" msgstr "" #: en_US/acknowledgments.xml:11(title) msgid "Acknowledgments" msgstr "" #: en_US/acknowledgments.xml:13(para) msgid "This document is based on a document started by Tammy Fox (tfox at redhat.com) and contributed to by Sandra Moore (smoore at redhat.com) and Johnray Fuller (jrfuller at redhat.com)." msgstr "" #: en_US/acknowledgments.xml:19(para) msgid "A patch from Roozbeh Pournader (roozbeh at sharif.edu) has been applied to fix a few typos and explain that anonymous CVS access does not allow commits." msgstr "" #: en_US/acknowledgments.xml:25(para) msgid "Patches from Gavin Henry (ghenry at suretecsystems.com) have been applied to add the trailing slashes to the figure tag example in docs-xml-tags.xml." msgstr "" #: en_US/acknowledgments.xml:32(para) msgid "A patch from Joshua Daniel Franklin (joshuadfranklin at yahoo.com) has been applied to add ." msgstr "" #: en_US/acknowledgments.xml:37(para) msgid "A patch from Karsten Wade (kwade at redhat.com) has been applied to add . It was edited by Paul W. Frields (stickster at gmail.com)." msgstr "" #. This section has been removed. #. #. A patch from Paul W. Frields (stickster at gmail.com) has been applied #. to add more explanation of the screen tag set to . #. #: en_US/acknowledgments.xml:50(para) msgid "A patch from Tommy Reynolds (Tommy.Reynolds at MegaCoder.com) has been applied to more fully explaing the document building system." msgstr "" #. Put one translator per line, in the form of NAME , YEAR1, YEAR2. #: en_US/acknowledgments.xml:0(None) msgid "translator-credits" msgstr ""