#, fuzzy msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "POT-Creation-Date: 2019-03-17 16:33-0300\n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" #. Put one translator per line, in the form NAME , YEAR1, YEAR2 msgctxt "_" msgid "translator-credits" msgstr "" #. (itstool) path: info/title #: book.translate.xml:63 msgid "FreeBSD Documentation Project Primer for New Contributors" msgstr "" #. (itstool) path: info/author #: book.translate.xml:66 msgid "The FreeBSD Documentation Project" msgstr "" #. (itstool) path: info/copyright #: book.translate.xml:70 msgid "" "1998 1999 2000 2001 " "2002 2003 2004 2005 " "2006 2007 2008 2009 " "2010 2011 2012 2013 " "2014 2015 2016 2017 " "DocEng" msgstr "" #. (itstool) path: legalnotice/title #: book.translate.xml:100 msgid "Copyright" msgstr "" #. (itstool) path: legalnotice/para #: book.translate.xml:102 msgid "" "Redistribution and use in source (XML DocBook) and 'compiled' forms (XML, " "HTML, PDF, PostScript, RTF and so forth) with or without modification, are " "permitted provided that the following conditions are met:" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:109 msgid "" "Redistributions of source code (XML DocBook) must retain the above copyright " "notice, this list of conditions and the following disclaimer as the first " "lines of this file unmodified." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:115 msgid "" "Redistributions in compiled form (transformed to other DTDs, converted to " "PDF, PostScript, RTF and other formats) must reproduce the above copyright " "notice, this list of conditions and the following disclaimer in the " "documentation and/or other materials provided with the distribution." msgstr "" #. (itstool) path: important/para #: book.translate.xml:124 msgid "" "THIS DOCUMENTATION IS PROVIDED BY THE FREEBSD DOCUMENTATION PROJECT \"AS " "IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, " "THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR " "PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FREEBSD DOCUMENTATION PROJECT " "BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR " "CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF " "SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS " "INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN " "CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) " "ARISING IN ANY WAY OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF " "THE POSSIBILITY OF SUCH DAMAGE." msgstr "" #. (itstool) path: abstract/para #: book.translate.xml:141 msgid "" "Thank you for becoming a part of the FreeBSD Documentation Project. Your " "contribution is extremely valuable, and we appreciate it." msgstr "" #. (itstool) path: abstract/para #: book.translate.xml:145 msgid "" "This primer covers details needed to start contributing to the FreeBSD " "Documentation Project, or FDP, including tools, software, " "and the philosophy behind the Documentation Project." msgstr "" #. (itstool) path: abstract/para #: book.translate.xml:151 msgid "" "This is a work in progress. Corrections and additions are always welcome." msgstr "" #. (itstool) path: preface/title #: book.translate.xml:157 msgid "Preface" msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:160 msgid "Shell Prompts" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:162 msgid "" "This table shows the default system prompt and superuser prompt. The " "examples use these prompts to indicate which type of user is running the " "example." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:170 msgid "User" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:171 msgid "Prompt" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:177 msgid "Normal user" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:178 book.translate.xml:4362 msgid "%" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:182 msgid "root" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:183 book.translate.xml:4355 msgid "#" msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:191 msgid "Typographic Conventions" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:193 msgid "This table describes the typographic conventions used in this book." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:200 msgid "Meaning" msgstr "" #. (itstool) path: row/entry #. (itstool) path: sect2/title #. (itstool) path: appendix/title #: book.translate.xml:201 book.translate.xml:4862 book.translate.xml:9943 msgid "Examples" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:207 msgid "The names of commands." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:208 msgid "Use ls -l to list all files." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:213 msgid "The names of files." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:214 msgid "Edit .login." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:218 msgid "On-screen computer output." msgstr "" #. (itstool) path: entry/screen #: book.translate.xml:219 #, no-wrap msgid "You have mail." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:223 msgid "What the user types, contrasted with on-screen computer output." msgstr "" #. (itstool) path: entry/screen #: book.translate.xml:226 #, no-wrap msgid "" "% date +\"The time is %H:%M\"\n" "The time is 09:18" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:231 msgid "Manual page references." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:232 msgid "" "Use su1 to change user identity." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:236 msgid "User and group names." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:237 msgid "Only root can do this." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:242 msgid "Emphasis." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:243 msgid "The user must do this." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:248 msgid "Text that the user is expected to replace with the actual text." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:251 msgid "" "To search for a keyword in the manual pages, type man -k " "keyword" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:257 msgid "Environment variables." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:258 msgid "$HOME is set to the user's home directory." msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:267 msgid "Notes, Tips, Important Information, Warnings, and Examples" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:270 msgid "Notes, warnings, and examples appear within the text." msgstr "" #. (itstool) path: note/para #: book.translate.xml:274 msgid "" "Notes are represented like this, and contain information to take note of, as " "it may affect what the user does." msgstr "" #. (itstool) path: tip/para #: book.translate.xml:280 msgid "" "Tips are represented like this, and contain information helpful to the user, " "like showing an easier way to do something." msgstr "" #. (itstool) path: important/para #: book.translate.xml:286 msgid "" "Important information is represented like this. Typically, these show extra " "steps the user may need to take." msgstr "" #. (itstool) path: warning/para #: book.translate.xml:292 msgid "" "Warnings are represented like this, and contain information warning about " "possible damage if the instructions are not followed. This damage may be " "physical, to the hardware or the user, or it may be non-physical, such as " "the inadvertent deletion of important files." msgstr "" #. (itstool) path: example/title #: book.translate.xml:300 msgid "A Sample Example" msgstr "" #. (itstool) path: example/para #: book.translate.xml:302 msgid "" "Examples are represented like this, and typically contain examples showing a " "walkthrough, or the results of a particular action." msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:309 msgid "Acknowledgments" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:311 msgid "" "My thanks to Sue Blake, Patrick Durusau, Jon Hamilton, Peter Flynn, and " "Christopher Maden, who took the time to read early drafts of this document " "and offer many valuable comments and criticisms." msgstr "" #. (itstool) path: chapter/title #. (itstool) path: sect1/title #: book.translate.xml:350 book.translate.xml:2060 msgid "Overview" msgstr "" #. (itstool) path: chapter/para #: book.translate.xml:352 msgid "" "Welcome to the FreeBSD Documentation Project (FDP). " "Quality documentation is crucial to the success of FreeBSD, and we value " "your contributions very highly." msgstr "" #. (itstool) path: chapter/para #: book.translate.xml:357 msgid "" "This document describes how the FDP is organized, how to " "write and submit documentation, and how to effectively use the available " "tools." msgstr "" #. (itstool) path: chapter/para #: book.translate.xml:361 msgid "" "Everyone is welcome to contribute to the FDP. Willingness " "to contribute is the only membership requirement." msgstr "" #. (itstool) path: chapter/para #: book.translate.xml:365 msgid "This primer shows how to:" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:369 msgid "" "Identify which parts of FreeBSD are maintained by the FDP." "" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:374 msgid "Install the required documentation tools and files." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:378 msgid "Make changes to the documentation." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:382 msgid "" "Submit changes back for review and inclusion in the FreeBSD documentation." msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:388 book.translate.xml:7349 msgid "Quick Start" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:390 msgid "" "Some preparatory steps must be taken before editing the FreeBSD " "documentation. First, subscribe to the FreeBSD documentation project " "mailing list. Some team members also interact on the " "#bsddocs IRC channel on EFnet. These people can help with " "questions or problems involving the documentation." msgstr "" #. (itstool) path: step/para #: book.translate.xml:400 msgid "" "Install the textproc/docproj meta-package and " "Subversion. This meta-package installs all of the " "software needed to edit and build FreeBSD documentation. The " "Subversion package is needed to obtain a working " "copy of the documentation and generate patches with." msgstr "" #. (itstool) path: step/screen #: book.translate.xml:409 #, no-wrap msgid "" "# pkg install docproj subversion" msgstr "" #. (itstool) path: step/para #: book.translate.xml:413 msgid "" "Install a local working copy of the documentation from the FreeBSD " "repository in ~/doc (see )." msgstr "" #. (itstool) path: step/screen #. (itstool) path: sect1/screen #: book.translate.xml:418 book.translate.xml:810 #, no-wrap msgid "" "% svn checkout https://svn.FreeBSD.org/doc/head " "~/doc" msgstr "" #. (itstool) path: step/para #: book.translate.xml:422 msgid "Configure the text editor:" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:426 msgid "Word wrap set to 70 characters." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:430 msgid "Tab stops set to 2." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:434 msgid "Replace each group of 8 leading spaces with a single tab." msgstr "" #. (itstool) path: step/para #: book.translate.xml:439 msgid "" "Specific editor configurations are listed in ." msgstr "" #. (itstool) path: step/para #: book.translate.xml:444 msgid "Update the local working copy:" msgstr "" #. (itstool) path: step/screen #: book.translate.xml:446 #, no-wrap msgid "" "% svn up ~/doc" msgstr "" #. (itstool) path: step/para #: book.translate.xml:450 msgid "" "Edit the documentation files that require changes. If a file needs major " "changes, consult the mailing list for input." msgstr "" #. (itstool) path: step/para #: book.translate.xml:454 msgid "" "References to tag and entity usage can be found in and ." msgstr "" #. (itstool) path: step/para #: book.translate.xml:460 msgid "After editing, check for problems by running:" msgstr "" #. (itstool) path: step/screen #: book.translate.xml:462 #, no-wrap msgid "" "% igor -R filename.xml | less -RS" msgstr "" #. (itstool) path: step/para #: book.translate.xml:464 msgid "" "Review the output and edit the file to fix any problems shown, then rerun " "the command to find any remaining problems. Repeat until all of the errors " "are resolved." msgstr "" #. (itstool) path: step/para #: book.translate.xml:471 msgid "" "Always build-test changes before submitting them. " "Running make in the top-level directory of the " "documentation being edited will generate that documentation in split HTML " "format. For example, to build the English version of the Handbook in " "HTML, run make in the en_US." "ISO8859-1/books/handbook/ directory." msgstr "" #. (itstool) path: step/para #: book.translate.xml:482 msgid "" "When changes are complete and tested, generate a diff file:" msgstr "" #. (itstool) path: step/screen #: book.translate.xml:485 #, no-wrap msgid "" "% cd ~/doc\n" "% svn diff > bsdinstall.diff.txt" msgstr "" #. (itstool) path: step/para #: book.translate.xml:488 msgid "" "Give the diff file a descriptive name. In the example above, changes have " "been made to the bsdinstall portion of the Handbook." msgstr "" #. (itstool) path: step/para #: book.translate.xml:495 msgid "" "Submit the diff file using the web-based Problem Report system. If using the web form, enter a Summary of [patch] " "short description of problem. Select " "the Component Documentation. In the Description field, " "enter a short description of the changes and any important details about " "them. Use the [ Add an attachment ] button to attach " "the diff file. Finally, use the [ Submit Bug ] button " "to submit your diff to the problem report system." msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:511 msgid "The FreeBSD Documentation Set" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:513 msgid "" "The FDP is responsible for four categories of FreeBSD " "documentation." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:518 msgid "" "Handbook: The Handbook is the comprehensive online " "resource and reference for FreeBSD users." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:524 msgid "" "FAQ: The FAQ uses a short question " "and answer format to address questions that are frequently asked on the " "various mailing lists and forums devoted to FreeBSD. This format does not " "permit long and comprehensive answers." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:532 msgid "" "Manual pages: The English language system manual pages " "are usually not written by the FDP, as they are part of " "the base system. However, the FDP can reword parts of " "existing manual pages to make them clearer or to correct inaccuracies." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:541 msgid "" "Web site: This is the main FreeBSD presence on the web, " "visible at https://" "www.FreeBSD.org/ and many mirrors around the world. The web site is " "typically a new user's first exposure to FreeBSD." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:549 msgid "" "Translation teams are responsible for translating the Handbook and web site " "into different languages. Manual pages are not translated at present." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:553 msgid "" "Documentation source for the FreeBSD web site, Handbook, and FAQ is available in the documentation repository at https://" "svn.FreeBSD.org/doc/." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:558 msgid "" "Source for manual pages is available in a separate source repository located " "at https://svn.FreeBSD.org/base/." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:562 msgid "" "Documentation commit messages are visible with svn log. " "Commit messages are also archived at http://lists.FreeBSD.org/mailman/" "listinfo/svn-doc-all." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:567 msgid "" "Web frontends to both of these repositories are available at and ." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:571 msgid "" "Many people have written tutorials or how-to articles about FreeBSD. Some " "are stored as part of the FDP files. In other cases, the " "author has decided to keep the documentation separate. The FDP endeavors to provide links to as much of this external " "documentation as possible." msgstr "" #. (itstool) path: chapter/title #: book.translate.xml:612 msgid "Tools" msgstr "" #. (itstool) path: chapter/para #: book.translate.xml:614 msgid "" "Several software tools are used to manage the FreeBSD documentation and " "render it to different output formats. Some of these tools are required and " "must be installed before working through the examples in the following " "chapters. Some are optional, adding capabilities or making the job of " "creating documentation less demanding." msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:622 msgid "Required Tools" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:624 msgid "" "Install textproc/docproj from the Ports Collection. This " "meta-port installs all the applications required to do " "useful work with the FreeBSD documentation. Some further notes on particular " "components are given below." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:632 msgid "DTDs and Entities" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:635 msgid "" "FreeBSD documentation uses several Document Type Definitions (DTDs) and sets of XML entities. These are all " "installed by the textproc/docproj port." msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:643 msgid "" "XHTML DTD (textproc/xhtml)" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:647 msgid "" "XHTML is the markup language of choice for the World Wide " "Web, and is used throughout the FreeBSD web site." msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:654 msgid "" "DocBook DTD (textproc/docbook-xml)" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:658 msgid "" "DocBook is designed for marking up technical documentation. Most of the " "FreeBSD documentation is written in DocBook." msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:665 msgid "ISO 8879 entities (textproc/iso8879)" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:669 msgid "" "Character entities from the ISO 8879:1986 standard used by many " "DTDs. Includes named mathematical symbols, additional " "characters in the Latin character set (accents, diacriticals, and so on), " "and Greek symbols." msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:681 msgid "Optional Tools" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:683 msgid "" "These applications are not required, but can make working on the " "documentation easier or add capabilities." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:687 msgid "Software" msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:692 msgid "Vim (editors/vim)" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:696 msgid "" "A popular editor for working with XML and derived " "documents, like DocBook XML." msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:703 msgid "Emacs (editors/emacs)" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:707 msgid "" "Both of these editors include a special mode for editing documents marked up " "according to an XML DTD. This mode " "includes commands to reduce the amount of typing needed, and help reduce the " "possibility of errors." msgstr "" #. (itstool) path: chapter/title #: book.translate.xml:749 msgid "The Working Copy" msgstr "" #. (itstool) path: chapter/para #: book.translate.xml:751 msgid "" "The working copy is a copy of the FreeBSD repository " "documentation tree downloaded onto the local computer. Changes are made to " "the local working copy, tested, and then submitted as patches to be " "committed to the main repository." msgstr "" #. (itstool) path: chapter/para #: book.translate.xml:757 msgid "" "A full copy of the documentation tree can occupy 700 megabytes of disk space." " Allow for a full gigabyte of space to have room for temporary files and " "test versions of various output formats." msgstr "" #. (itstool) path: chapter/para #: book.translate.xml:762 msgid "" "Subversion is used to manage the " "FreeBSD documentation files. It is obtained by installing the " "Subversion package:" msgstr "" #. (itstool) path: chapter/screen #: book.translate.xml:767 #, no-wrap msgid "# pkg install subversion" msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:770 msgid "Documentation and Manual Pages" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:772 msgid "" "FreeBSD documentation is not just books and articles. Manual pages for all " "the commands and configuration files are also part of the documentation, and " "part of the FDP's territory. Two repositories are " "involved: doc for the books and articles, and " "base for the operating system and manual pages. To edit " "manual pages, the base repository must be checked out " "separately." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:781 msgid "" "Repositories may contain multiple versions of documentation and source code. " "New modifications are almost always made only to the latest version, called " "head." msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:787 msgid "Choosing a Directory" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:789 msgid "" "FreeBSD documentation is traditionally stored in /usr/doc/, and system source code with manual pages in /usr/src/. These directory trees are relocatable, and users may want to put " "the working copies in other locations to avoid interfering with existing " "information in the main directories. The examples that follow use " "~/doc and ~/src, both " "subdirectories of the user's home directory." msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:802 msgid "Checking Out a Copy" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:804 msgid "" "A download of a working copy from the repository is called a " "checkout, and done with svn checkout." " This example checks out a copy of the latest version (head) of the main documentation tree:" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:812 msgid "A checkout of the source code to work on manual pages is very similar:" msgstr "" #. (itstool) path: sect1/screen #: book.translate.xml:815 #, no-wrap msgid "" "% svn checkout https://svn.FreeBSD.org/base/head " "~/src" msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:819 msgid "Updating a Working Copy" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:821 msgid "" "The documents and files in the FreeBSD repository change daily. People " "modify files and commit changes frequently. Even a short time after an " "initial checkout, there will already be differences between the local " "working copy and the main FreeBSD repository. To update the local version " "with the changes that have been made to the main repository, use " "svn update on the directory containing the local working " "copy:" msgstr "" #. (itstool) path: sect1/screen #: book.translate.xml:830 #, no-wrap msgid "" "% svn update ~/doc" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:832 msgid "" "Get in the protective habit of using svn update before " "editing document files. Someone else may have edited that file very " "recently, and the local working copy will not include the latest changes " "until it has been updated. Editing the newest version of a file is much " "easier than trying to combine an older, edited local file with the newer " "version from the repository." msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:842 msgid "Reverting Changes" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:844 msgid "" "Sometimes it turns out that changes were not necessary after all, or the " "writer just wants to start over. Files can be reset to their " "unchanged form with svn revert. For example, to erase the " "edits made to chapter.xml and reset it to unmodified " "form:" msgstr "" #. (itstool) path: sect1/screen #: book.translate.xml:851 #, no-wrap msgid "% svn revert chapter.xml" msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:855 msgid "Making a Diff" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:857 msgid "" "After edits to a file or group of files are completed, the differences " "between the local working copy and the version on the FreeBSD repository " "must be collected into a single file for submission. These diff files are produced by redirecting the output of svn diff into a file:" msgstr "" #. (itstool) path: sect1/screen #: book.translate.xml:864 #, no-wrap msgid "" "% cd ~/doc\n" "% svn diff > doc-fix-spelling." "diff" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:867 msgid "" "Give the file a meaningful name that identifies the contents. The example " "above is for spelling fixes to the whole documentation tree." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:871 msgid "" "If the diff file is to be submitted with the web Submit a FreeBSD problem " "report interface, add a .txt extension " "to give the earnest and simple-minded web form a clue that the contents are " "plain text." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:878 msgid "" "Be careful: svn diff includes all changes made in the " "current directory and any subdirectories. If there are files in the working " "copy with edits that are not ready to be submitted yet, provide a list of " "only the files that are to be included:" msgstr "" #. (itstool) path: sect1/screen #: book.translate.xml:884 #, no-wrap msgid "" "% cd ~/doc\n" "% svn diff disks/chapter.xml " "printers/chapter.xml > disks-printers.diff" msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:889 msgid "Subversion References" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:891 msgid "" "These examples show very basic usage of Subversion. More detail is available in the Subversion Book and the Subversion documentation." msgstr "" #. (itstool) path: chapter/title #: book.translate.xml:931 msgid "Documentation Directory Structure" msgstr "" #. (itstool) path: chapter/para #: book.translate.xml:933 msgid "" "Files and directories in the doc/ tree follow a " "structure meant to:" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:939 msgid "Make it easy to automate converting the document to other formats." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:944 msgid "" "Promote consistency between the different documentation organizations, to " "make it easier to switch between working on different documents." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:950 msgid "" "Make it easy to decide where in the tree new documentation should be placed." msgstr "" #. (itstool) path: chapter/para #: book.translate.xml:955 msgid "" "In addition, the documentation tree must accommodate documents in many " "different languages and encodings. It is important that the documentation " "tree structure does not enforce any particular defaults or cultural " "preferences." msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:961 msgid "The Top Level, doc/" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:964 msgid "" "There are two types of directory under doc/, each with " "very specific directory names and meanings." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:972 book.translate.xml:1026 msgid "Directory" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:973 book.translate.xml:1027 msgid "Usage" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:979 msgid "share" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:982 msgid "" "Contains files that are not specific to the various translations and " "encodings of the documentation. Contains subdirectories to further " "categorize the information. For example, the files that comprise the " "make1 infrastructure are in share/mk, while the " "additional XML support files (such as the FreeBSD " "extended DocBook DTD) are in share/xml." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:994 msgid "" "lang.encoding" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:997 msgid "" "One directory exists for each available translation and encoding of the " "documentation, for example en_US.ISO8859-1/ and " "zh_TW.UTF-8/. The names are long, but by fully " "specifying the language and encoding we prevent any future headaches when a " "translation team wants to provide documentation in the same language but in " "more than one encoding. This also avoids problems that might be caused by a " "future switch to Unicode." msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:1014 msgid "" "The lang.encoding/ Directories" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:1018 msgid "" "These directories contain the documents themselves. The documentation is " "split into up to three more categories at this level, indicated by the " "different directory names." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:1033 msgid "articles" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:1036 msgid "" "Documentation marked up as a DocBook article (or equivalent). " "Reasonably short, and broken up into sections. Normally only available as " "one XHTML file." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:1043 msgid "books" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:1045 msgid "" "Documentation marked up as a DocBook book (or equivalent). Book " "length, and broken up into chapters. Normally available as both one large " "XHTML file (for people with fast connections, or who want " "to print it easily from a browser) and as a collection of linked, smaller " "files." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:1055 msgid "man" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:1058 msgid "" "For translations of the system manual pages. This directory will contain one " "or more manN directories, corresponding to the sections that have been " "translated." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:1067 msgid "" "Not every lang." "encoding directory will have all of " "these subdirectories. It depends on how much translation has been " "accomplished by that translation team." msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:1074 msgid "Document-Specific Information" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:1076 msgid "" "This section contains specific notes about particular documents managed by " "the FDP." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:1080 msgid "The Handbook" msgstr "" #. (itstool) path: sect2/subtitle #: book.translate.xml:1082 msgid "books/handbook/" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:1084 msgid "" "The Handbook is written in DocBook XML using the FreeBSD " "DocBook extended DTD." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:1087 msgid "" "The Handbook is organized as a DocBook book. The book is divided " "into parts, each of which contains several chapters. " "chapters are further subdivided into sections (sect1) " "and subsections (sect2, sect3) and so on." msgstr "" #. (itstool) path: sect3/title #: book.translate.xml:1096 msgid "Physical Organization" msgstr "" #. (itstool) path: sect3/para #: book.translate.xml:1098 msgid "" "There are a number of files and directories within the handbook directory." msgstr "" #. (itstool) path: note/para #: book.translate.xml:1102 msgid "" "The Handbook's organization may change over time, and this document may lag " "in detailing the organizational changes. Post questions about Handbook " "organization to the FreeBSD documentation project mailing list." msgstr "" #. (itstool) path: sect4/title #: book.translate.xml:1109 msgid "Makefile" msgstr "" #. (itstool) path: sect4/para #: book.translate.xml:1111 msgid "" "The Makefile defines some variables that affect how the " "XML source is converted to other formats, and lists the " "various source files that make up the Handbook. It then includes the " "standard doc.project.mk, to bring in the rest of the " "code that handles converting documents from one format to another." msgstr "" #. (itstool) path: sect4/title #: book.translate.xml:1121 msgid "book.xml" msgstr "" #. (itstool) path: sect4/para #: book.translate.xml:1123 msgid "" "This is the top level document in the Handbook. It contains the Handbook's " "DOCTYPE declaration, " "as well as the elements that describe the Handbook's structure." msgstr "" #. (itstool) path: sect4/para #: book.translate.xml:1128 msgid "" "book.xml uses parameter entities to load in the files with the " ".ent extension. These files (described later) then " "define general entities " "that are used throughout the rest of the Handbook." msgstr "" #. (itstool) path: sect4/title #: book.translate.xml:1137 msgid "" "directory/chapter." "xml" msgstr "" #. (itstool) path: sect4/para #: book.translate.xml:1139 msgid "" "Each chapter in the Handbook is stored in a file called chapter." "xml in a separate directory from the other chapters. Each " "directory is named after the value of the id attribute on " "the chapter element." msgstr "" #. (itstool) path: sect4/para #: book.translate.xml:1146 msgid "For example, if one of the chapter files contains:" msgstr "" #. (itstool) path: sect4/programlisting #: book.translate.xml:1149 #, no-wrap msgid "" "chapter id=\"kernelconfig\"\n" "...\n" "chapter" msgstr "" #. (itstool) path: sect4/para #: book.translate.xml:1153 msgid "" "Then it will be called chapter.xml in the " "kernelconfig directory. In general, the entire contents " "of the chapter are in this one file." msgstr "" #. (itstool) path: sect4/para #: book.translate.xml:1159 msgid "" "When the XHTML version of the Handbook is produced, this " "will yield kernelconfig.html. This is because of the " "id value, and is not related to the name of the directory." "" msgstr "" #. (itstool) path: sect4/para #: book.translate.xml:1165 msgid "" "In earlier versions of the Handbook, the files were stored in the same " "directory as book.xml, and named after the value of the " "id attribute on the file's chapter element. " "Now, it is possible to include images in each chapter. Images for each " "Handbook chapter are stored within share/images/books/handbook. The localized version of these images should be placed in the " "same directory as the XML sources for each chapter. " "Namespace collisions are inevitable, and it is easier to work with several " "directories with a few files in them than it is to work with one directory " "that has many files in it." msgstr "" #. (itstool) path: sect4/para #: book.translate.xml:1180 msgid "" "A brief look will show that there are many directories with individual " "chapter.xml files, including basics/chapter." "xml, introduction/chapter.xml, and " "printing/chapter.xml." msgstr "" #. (itstool) path: important/para #: book.translate.xml:1187 msgid "" "Do not name chapters or directories after their ordering within the Handbook." " This ordering can change as the content within the Handbook is reorganized. " "Reorganization should be possible without renaming files, unless entire " "chapters are being promoted or demoted within the hierarchy." msgstr "" #. (itstool) path: sect4/para #: book.translate.xml:1195 msgid "" "The chapter.xml files are not complete XML documents that can be built individually. They can only be built as " "parts of the whole Handbook." msgstr "" #. (itstool) path: chapter/title #: book.translate.xml:1237 msgid "The Documentation Build Process" msgstr "" #. (itstool) path: chapter/para #: book.translate.xml:1239 msgid "" "This chapter covers organization of the documentation build process and how " "make1 is used to control it." msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:1243 msgid "Rendering DocBook into Output" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:1245 msgid "" "Different types of output can be produced from a single DocBook source file. " "The type of output desired is set with the FORMATS " "variable. A list of known formats is stored in KNOWN_FORMATS:" msgstr "" #. (itstool) path: sect1/screen #. (itstool) id: book.translate.xml#doc-build-rendering-known-formats #: book.translate.xml:1250 #, no-wrap msgid "" "% cd ~/doc/en_US.ISO8859-1/books/handbook\n" "% make -V KNOWN_FORMATS" msgstr "" #. (itstool) path: table/title #: book.translate.xml:1254 msgid "Common Output Formats" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:1259 msgid "FORMATS Value" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:1260 msgid "File Type" msgstr "" #. (itstool) path: row/entry #. (itstool) path: segmentedlist/segtitle #: book.translate.xml:1261 book.translate.xml:7235 book.translate.xml:8385 msgid "Description" msgstr "" #. (itstool) path: row/entry #. (itstool) path: varlistentry/term #: book.translate.xml:1267 book.translate.xml:2492 msgid "html" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:1268 msgid "HTML, one file" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:1269 msgid "" "A single book.html or article.html." "" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:1274 msgid "html-split" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:1275 msgid "HTML, multiple files" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:1276 msgid "" "Multiple HTML files, one for each chapter or section, for " "use on a typical web site." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:1282 msgid "pdf" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:1283 msgid "PDF" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:1284 msgid "Portable Document Format" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:1290 msgid "" "The default output format can vary by document, but is usually html-" "split. Other formats are chosen by setting FORMATS to a specific value. Multiple output formats can be created at a " "single time by setting FORMATS to a list of formats." msgstr "" #. (itstool) path: example/title #: book.translate.xml:1297 msgid "Build a Single HTML Output File" msgstr "" #. (itstool) path: example/screen #: book.translate.xml:1299 #, no-wrap msgid "" "% cd ~/doc/en_US.ISO8859-1/books/handbook\n" "% make FORMATS=html" msgstr "" #. (itstool) path: example/title #: book.translate.xml:1304 msgid "Build HTML-Split and PDF Output Files" msgstr "" #. (itstool) path: example/screen #: book.translate.xml:1307 #, no-wrap msgid "" "% cd ~/doc/en_US.ISO8859-1/books/handbook\n" "% make FORMATS=\"html-split pdf\"" msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:1313 msgid "The FreeBSD Documentation Build Toolset" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:1315 msgid "" "These are the tools used to build and install the FDP " "documentation." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:1320 msgid "" "The primary build tool is make1, specifically " "Berkeley Make." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:1325 msgid "" "Package building is handled by FreeBSD's pkg-" "create8." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:1330 msgid "" "gzip1 is used to create compressed versions of the document. " "bzip21 archives are also supported. tar1 is used for package " "building." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:1336 msgid "" "install1 is used to install the documentation." msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:1344 msgid "Understanding Makefiles in the Documentation Tree" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:1347 msgid "" "There are three main types of Makefiles in the FreeBSD " "Documentation Project tree." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:1352 msgid "" "Subdirectory Makefiles simply pass commands to those directories below them." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:1358 msgid "" "Documentation Makefiles describe the documents that are produced from this directory." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:1365 msgid "" "Make includes are the glue that perform the document production, and are usually of " "the form doc.xxx.mk." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:1373 msgid "Subdirectory Makefiles" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:1375 msgid "These Makefiles usually take the form of:" msgstr "" #. (itstool) path: sect2/programlisting #: book.translate.xml:1378 #, no-wrap msgid "" "SUBDIR =articles\n" "SUBDIR+=books\n" "\n" "COMPAT_SYMLINK = en\n" "\n" "DOC_PREFIX?= ${.CURDIR}/..\n" ".include \"${DOC_PREFIX}/share/mk/doc.project.mk\"" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:1386 msgid "" "The first four non-empty lines define the make1 variables " "SUBDIR, COMPAT_SYMLINK, and " "DOC_PREFIX." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:1391 msgid "" "The SUBDIR statement and COMPAT_SYMLINK statement show how to assign a value to a variable, overriding any " "previous value." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:1396 msgid "" "The second SUBDIR statement shows how a value is appended " "to the current value of a variable. The SUBDIR variable " "is now articles books." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:1401 msgid "" "The DOC_PREFIX assignment shows how a value is assigned " "to the variable, but only if it is not already defined. This is useful if " "DOC_PREFIX is not where this Makefile thinks it is - the user can override this and provide the correct " "value." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:1408 msgid "" "What does it all mean? SUBDIR mentions which " "subdirectories below this one the build process should pass any work on to." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:1412 msgid "" "COMPAT_SYMLINK is specific to compatibility symlinks " "(amazingly enough) for languages to their official encoding (doc/" "en would point to en_US.ISO-8859-1)." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:1417 msgid "" "DOC_PREFIX is the path to the root of the FreeBSD " "Document Project tree. This is not always that easy to find, and is also " "easily overridden, to allow for flexibility. .CURDIR is a " "make1 builtin variable with the path to the current directory." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:1424 msgid "" "The final line includes the FreeBSD Documentation Project's project-wide " "make1 system file doc.project.mk which is the " "glue which converts these variables into build instructions." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:1431 msgid "Documentation Makefiles" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:1433 msgid "" "These Makefiles set make1 variables that " "describe how to build the documentation contained in that directory." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:1437 msgid "Here is an example:" msgstr "" #. (itstool) path: sect2/programlisting #: book.translate.xml:1439 #, no-wrap msgid "" "MAINTAINER=nik@FreeBSD.org\n" "\n" "DOC?= book\n" "\n" "FORMATS?= html-split html\n" "\n" "INSTALL_COMPRESSED?= gz\n" "INSTALL_ONLY_COMPRESSED?=\n" "\n" "# SGML content\n" "SRCS= book.xml\n" "\n" "DOC_PREFIX?= ${.CURDIR}/../../..\n" "\n" ".include \"$(DOC_PREFIX)/share/mk/docproj.docbook.mk\"" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:1455 msgid "" "The MAINTAINER variable allows committers to claim " "ownership of a document in the FreeBSD Documentation Project, and take " "responsibility for maintaining it." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:1460 msgid "" "DOC is the name (sans the .xml " "extension) of the main document created by this directory. SRCS lists all the individual files that make up the document. This " "should also include important files in which a change should result in a " "rebuild." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:1467 msgid "" "FORMATS indicates the default formats that should be " "built for this document. INSTALL_COMPRESSED is the " "default list of compression techniques that should be used in the document " "build. INSTALL_ONLY_COMPRESS, empty by default, should be " "non-empty if only compressed documents are desired in the build." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:1475 msgid "" "The DOC_PREFIX and include statements should be familiar " "already." msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:1481 msgid "FreeBSD Documentation Project Make Includes" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:1484 msgid "" "make1 includes are best explained by inspection of the code. Here " "are the system include files:" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:1489 msgid "" "doc.project.mk is the main project include file, which " "includes all the following include files, as necessary." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:1495 msgid "" "doc.subdir.mk handles traversing of the document tree " "during the build and install processes." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:1501 msgid "" "doc.install.mk provides variables that affect ownership " "and installation of documents." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:1506 msgid "" "doc.docbook.mk is included if DOCFORMAT is docbook and DOC is set." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:1513 msgid "doc.project.mk" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:1515 msgid "By inspection:" msgstr "" #. (itstool) path: sect2/programlisting #: book.translate.xml:1517 #, no-wrap msgid "" "DOCFORMAT?= docbook\n" "MAINTAINER?= doc@FreeBSD.org\n" "\n" "PREFIX?= /usr/local\n" "PRI_LANG?= en_US.ISO8859-1\n" "\n" ".if defined(DOC)\n" ".if ${DOCFORMAT} == \"docbook\"\n" ".include \"doc.docbook.mk\"\n" ".endif\n" ".endif\n" "\n" ".include \"doc.subdir.mk\"\n" ".include \"doc.install.mk\"" msgstr "" #. (itstool) path: sect3/title #: book.translate.xml:1534 book.translate.xml:1584 msgid "Variables" msgstr "" #. (itstool) path: sect3/para #: book.translate.xml:1536 msgid "" "DOCFORMAT and MAINTAINER are assigned " "default values, if these are not set by the document make file." msgstr "" #. (itstool) path: sect3/para #: book.translate.xml:1540 msgid "" "PREFIX is the prefix under which the documentation building tools are installed. For normal " "package and port installation, this is /usr/local." msgstr "" #. (itstool) path: sect3/para #: book.translate.xml:1545 msgid "" "PRI_LANG should be set to whatever language and encoding " "is natural amongst users these documents are being built for. US English is " "the default." msgstr "" #. (itstool) path: note/para #: book.translate.xml:1551 msgid "" "PRI_LANG does not affect which documents can, or even " "will, be built. Its main use is creating links to commonly referenced " "documents into the FreeBSD documentation install root." msgstr "" #. (itstool) path: sect3/title #: book.translate.xml:1559 msgid "Conditionals" msgstr "" #. (itstool) path: sect3/para #: book.translate.xml:1561 msgid "" "The .if defined(DOC) line is an example of a " "make1 conditional which, like in other programs, defines behavior if " "some condition is true or if it is false. defined is a " "function which returns whether the variable given is defined or not." msgstr "" #. (itstool) path: sect3/para #: book.translate.xml:1567 msgid "" ".if ${DOCFORMAT} == \"docbook\", next, tests whether the " "DOCFORMAT variable is \"docbook\", and " "in this case, includes doc.docbook.mk." msgstr "" #. (itstool) path: sect3/para #: book.translate.xml:1572 msgid "" "The two .endifs close the two above conditionals, marking " "the end of their application." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:1578 msgid "doc.subdir.mk" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:1580 msgid "" "This file is too long to explain in detail. These notes describe the most " "important features." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:1588 msgid "" "SUBDIR is a list of subdirectories that the build process " "should go further down into." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:1594 msgid "" "ROOT_SYMLINKS is the name of directories that should be " "linked to the document install root from their actual locations, if the " "current language is the primary language (specified by PRI_LANG)." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:1602 msgid "" "COMPAT_SYMLINK is described in the Subdirectory Makefile section." msgstr "" #. (itstool) path: sect3/title #: book.translate.xml:1611 msgid "Targets and Macros" msgstr "" #. (itstool) path: sect3/para #: book.translate.xml:1613 msgid "" "Dependencies are described by target: " "dependency1 dependency2 ... tuples, " "where to build target, the given dependencies must be " "built first." msgstr "" #. (itstool) path: sect3/para #: book.translate.xml:1620 msgid "" "After that descriptive tuple, instructions on how to build the target may be " "given, if the conversion process between the target and its dependencies are " "not previously defined, or if this particular conversion is not the same as " "the default conversion method." msgstr "" #. (itstool) path: sect3/para #: book.translate.xml:1626 msgid "" "A special dependency .USE defines the equivalent of a " "macro." msgstr "" #. (itstool) path: sect3/programlisting #: book.translate.xml:1629 book.translate.xml:1716 #, no-wrap msgid "" "_SUBDIRUSE: .USE\n" ".for entry in ${SUBDIR}\n" " @${ECHO} \"===> ${DIRPRFX}${entry}\"\n" " @(cd ${.CURDIR}/${entry} && \\\n" " ${MAKE} ${.TARGET:S/realpackage/package/:S/realinstall/install/} DIRPRFX=" "${DIRPRFX}${entry}/ )\n" ".endfor" msgstr "" #. (itstool) path: para/buildtarget #: book.translate.xml:1636 book.translate.xml:1652 msgid "_SUBDIRUSE" msgstr "" #. (itstool) path: sect3/para #: book.translate.xml:1636 msgid "" "In the above, <_:buildtarget-1/> is now a macro which will execute the given " "commands when it is listed as a dependency." msgstr "" #. (itstool) path: sect3/para #: book.translate.xml:1640 msgid "" "What sets this macro apart from other targets? Basically, it is executed " "after the instructions given in the build procedure it " "is listed as a dependency to, and it does not adjust .TARGET, which is the variable which contains the name of the target " "currently being built." msgstr "" #. (itstool) path: sect3/programlisting #: book.translate.xml:1648 #, no-wrap msgid "clean: _SUBDIRUSE\n" " rm -f ${CLEANFILES}" msgstr "" #. (itstool) path: para/buildtarget #: book.translate.xml:1651 book.translate.xml:1655 book.translate.xml:1675 #: book.translate.xml:6101 book.translate.xml:6105 book.translate.xml:6109 msgid "clean" msgstr "" #. (itstool) path: sect3/para #: book.translate.xml:1651 msgid "" "In the above, <_:buildtarget-1/> will use the <_:buildtarget-2/> macro after " "it has executed the instruction rm -f ${CLEANFILES}. In " "effect, this causes <_:buildtarget-3/> to go further and further down the " "directory tree, deleting built files as it goes down, " "not on the way back up." msgstr "" #. (itstool) path: sect4/title #: book.translate.xml:1661 msgid "Provided Targets" msgstr "" #. (itstool) path: para/buildtarget #: book.translate.xml:1665 msgid "install" msgstr "" #. (itstool) path: para/buildtarget #: book.translate.xml:1666 msgid "package" msgstr "" #. (itstool) path: para/buildtarget #: book.translate.xml:1669 msgid "realinstall" msgstr "" #. (itstool) path: para/buildtarget #: book.translate.xml:1670 msgid "realpackage" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:1665 msgid "" "<_:buildtarget-1/> and <_:buildtarget-2/> both go down the directory tree " "calling the real versions of themselves in the subdirectories (<_:" "buildtarget-3/> and <_:buildtarget-4/> respectively)." msgstr "" #. (itstool) path: para/buildtarget #: book.translate.xml:1678 msgid "cleandir" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:1675 msgid "" "<_:buildtarget-1/> removes files created by the build process (and goes down " "the directory tree too). <_:buildtarget-2/> does the same, and also removes " "the object directory, if any." msgstr "" #. (itstool) path: sect3/title #: book.translate.xml:1686 msgid "More on Conditionals" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:1690 msgid "" "exists is another condition function which returns true " "if the given file exists." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:1696 msgid "empty returns true if the given variable is empty." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:1701 msgid "" "target returns true if the given target does not already " "exist." msgstr "" #. (itstool) path: sect3/title #: book.translate.xml:1708 msgid "Looping Constructs in make (.for)" msgstr "" #. (itstool) path: sect3/para #: book.translate.xml:1711 msgid "" ".for provides a way to repeat a set of instructions for " "each space-separated element in a variable. It does this by assigning a " "variable to contain the current element in the list being examined." msgstr "" #. (itstool) path: sect3/para #: book.translate.xml:1723 msgid "" "In the above, if SUBDIR is empty, no action is taken; if " "it has one or more elements, the instructions between .for and .endfor would repeat for every element, with " "entry being replaced with the value of the current " "element." msgstr "" #. (itstool) path: chapter/title #: book.translate.xml:1766 msgid "The Website" msgstr "" #. (itstool) path: chapter/para #: book.translate.xml:1768 msgid "" "The FreeBSD web site is part of the FreeBSD documents. Files for the web " "site are stored in the en_US.ISO8859-1/htdocs " "subdirectory of the document tree directory, ~/doc in " "this example." msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:1775 msgid "Environment Variables" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:1777 msgid "" "Several environment variables control which parts of the web site are built " "or installed, and to which directories." msgstr "" #. (itstool) path: tip/para #: book.translate.xml:1782 msgid "" "The web build system uses make1, and considers " "variables to be set when they have been defined, even if they are empty. The " "examples here show the recommended ways of defining and using these " "variables. Setting or defining these variables with other values or methods " "might lead to unexpected surprises." msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:1792 msgid "DESTDIR" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:1795 msgid "" "DESTDIR specifies the path where the web site files are to be installed." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:1798 msgid "" "This variable is best set with env1 or the user shell's " "method of setting environment variables, setenv for " "csh1 or export for " "sh1." msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:1808 msgid "ENGLISH_ONLY" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:1811 msgid "Default: undefined. Build and include all translations." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:1814 msgid "" "ENGLISH_ONLY=yes: use only the English documents and " "ignore all translations." msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:1820 msgid "WEB_ONLY" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:1823 msgid "" "Default: undefined. Build both the web site and all the books and articles." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:1826 msgid "" "WEB_ONLY=yes: build or install only HTML pages from the en_US.ISO8859-1/htdocs " "directory. Other directories and documents, including books and articles, " "will be ignored." msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:1835 msgid "WEB_LANG" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:1838 msgid "" "Default: undefined. Build and include all the available languages on the web " "site." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:1841 msgid "" "Set to a space-separated list of languages to be included in the build or " "install. The formats are the same as the directory names in the document " "root directory. For example, to include the German and French documents:" msgstr "" #. (itstool) path: listitem/screen #: book.translate.xml:1847 #, no-wrap msgid "WEB_LANG=\"de_DE.ISO8859-1 fr_FR.ISO8859-1\"" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:1852 msgid "" "WEB_ONLY, WEB_LANG, and " "ENGLISH_ONLY are make1 variables and can be " "set in /etc/make.conf, Makefile.inc, as environment variables on the command line, or in dot files." msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:1860 msgid "Building and Installing the Web Pages" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:1862 msgid "" "Having obtained the documentation and web site source files, the web site " "can be built." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:1865 msgid "" "An actual installation of the web site is run as the root user because the permissions on the web " "server directory will not allow files to be installed by an unprivileged " "user. For testing, it can be useful to install the files as a normal user to " "a temporary directory." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:1872 msgid "" "In these examples, the web site files are built by user jru in their home directory, ~/doc, with a full path of /usr/home/jru/doc." msgstr "" #. (itstool) path: tip/para #: book.translate.xml:1878 msgid "" "The web site build uses the INDEX from the Ports " "Collection and might fail if that file or /usr/ports is " "not present. The simplest approach is to install the Ports Collection." msgstr "" #. (itstool) path: example/title #: book.translate.xml:1886 msgid "Build the Full Web Site and All Documents" msgstr "" #. (itstool) path: example/para #: book.translate.xml:1888 msgid "" "Build the web site and all documents. The resulting files are left in the " "document tree:" msgstr "" #. (itstool) path: example/screen #: book.translate.xml:1891 #, no-wrap msgid "" "% cd ~/doc/en_US.ISO8859-1/htdocs/\n" "% make all" msgstr "" #. (itstool) path: example/title #: book.translate.xml:1896 msgid "Build Only the Web Site in English" msgstr "" #. (itstool) path: example/para #: book.translate.xml:1898 msgid "" "Build the web site only, in English, as user jru, and install the resulting files into " "/tmp/www for testing:" msgstr "" #. (itstool) path: example/screen #: book.translate.xml:1903 #, no-wrap msgid "" "% cd ~/doc/en_US.ISO8859-1/htdocs/\n" "% env DESTDIR=/tmp/www make ENGLISH_ONLY=yes " "WEB_ONLY=yes all install" msgstr "" #. (itstool) path: example/para #: book.translate.xml:1906 msgid "" "Changes to static files can usually be tested by viewing the modified files " "directly with a web browser. If the site has been built as shown above, a " "modified main page can be viewed with:" msgstr "" #. (itstool) path: example/screen #: book.translate.xml:1911 #, no-wrap msgid "" "% firefox /tmp/www/data/index.html" msgstr "" #. (itstool) path: example/para #: book.translate.xml:1913 msgid "" "Modifications to dynamic files can be tested with a web server running on " "the local system. After building the site as shown above, this /" "usr/local/etc/apache24/httpd.conf can be used with www/" "apache24:" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:1919 #, no-wrap msgid "" "# httpd.conf for testing the FreeBSD website\n" "Define TestRoot \"/tmp/www/data\"\n" "\n" "# directory for configuration files\n" "ServerRoot \"/usr/local\"\n" "\n" "Listen 80\n" "\n" "# minimum required modules\n" "LoadModule authz_core_module libexec/apache24/mod_authz_core.so\n" "LoadModule mime_module libexec/apache24/mod_mime.so\n" "LoadModule unixd_module libexec/apache24/mod_unixd.so\n" "LoadModule cgi_module libexec/apache24/mod_cgi.so\n" "LoadModule dir_module libexec/apache24/mod_dir.so\n" "\n" "# run the webserver as user and group\n" "User www\n" "Group www\n" "\n" "ServerAdmin you@example.com\n" "ServerName fbsdtest\n" "\n" "# deny access to all files\n" "<Directory />\n" " AllowOverride none\n" " Require all denied\n" "</Directory>\n" "\n" "# allow access to the website directory\n" "DocumentRoot \"${TestRoot}\"\n" "<Directory \"${TestRoot}\">\n" " Options Indexes FollowSymLinks\n" " AllowOverride None\n" " Require all granted\n" "</Directory>\n" "\n" "# prevent access to .htaccess and .htpasswd files\n" "<Files \".ht*\">\n" " Require all denied\n" "</Files>\n" "\n" "ErrorLog \"/var/log/httpd-error.log\"\n" "LogLevel warn\n" "\n" "# set up the CGI script directory\n" "<Directory \"${TestRoot}/cgi\">\n" " AllowOverride None\n" " Options None\n" " Require all granted\n" " Options +ExecCGI\n" " AddHandler cgi-script .cgi\n" "</Directory>\n" "\n" "Include etc/apache24/Includes/*.conf" msgstr "" #. (itstool) path: example/para #: book.translate.xml:1974 msgid "Start the web server with" msgstr "" #. (itstool) path: example/screen #: book.translate.xml:1976 #, no-wrap msgid "# service apache24 onestart" msgstr "" #. (itstool) path: example/para #: book.translate.xml:1978 msgid "" "The web site can be viewed at . Be " "aware that many links refer to the real FreeBSD site by name, and those " "links will still go to the external site instead of the local test version. " "Fully testing the local site will require temporarily setting DNS so www.FreeBSD.org resolves to " "localhost or the local IP address." msgstr "" #. (itstool) path: example/title #: book.translate.xml:1989 msgid "Build and Install the Web Site" msgstr "" #. (itstool) path: example/para #: book.translate.xml:1991 msgid "" "Build the web site and all documents as user jru. Install the resulting files as root into the default directory, /" "root/public_html:" msgstr "" #. (itstool) path: example/screen #: book.translate.xml:1998 #, no-wrap msgid "" "% cd ~/doc/en_US.ISO8859-1/htdocs\n" "% make all\n" "% su -\n" "Password:\n" "# cd /usr/home/jru/doc/en_US.ISO8859-1/htdocs\n" "# make install" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2006 msgid "" "The install process does not delete any old or outdated files that existed " "previously in the same directory. If a new copy of the site is built and " "installed every day, this command will find and delete all files that have " "not been updated in three days:" msgstr "" #. (itstool) path: sect1/screen #: book.translate.xml:2012 #, no-wrap msgid "" "# find /usr/local/www " "-ctime 3 -delete" msgstr "" #. (itstool) path: chapter/title #: book.translate.xml:2048 msgid "XML Primer" msgstr "" #. (itstool) path: chapter/para #: book.translate.xml:2050 msgid "" "Most FDP documentation is written with markup languages " "based on XML. This chapter explains what that means, how " "to read and understand the documentation source, and the XML techniques used." msgstr "" #. (itstool) path: chapter/para #: book.translate.xml:2056 msgid "" "Portions of this section were inspired by Mark Galassi's Get " "Going With DocBook." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2062 msgid "" "In the original days of computers, electronic text was simple. There were a " "few character sets like ASCII or EBCDIC, but that was about it. Text was text, and what you saw really was " "what you got. No frills, no formatting, no intelligence." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2068 msgid "" "Inevitably, this was not enough. When text is in a machine-usable format, " "machines are expected to be able to use and manipulate it intelligently. " "Authors want to indicate that certain phrases should be emphasized, or added " "to a glossary, or made into hyperlinks. Filenames could be shown in a " "typewriter style font for viewing on screen, but as " "italics when printed, or any of a myriad of other options for " "presentation." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2077 msgid "" "It was once hoped that Artificial Intelligence (AI) would make this easy. " "The computer would read the document and automatically identify key phrases, " "filenames, text that the reader should type in, examples, and more. " "Unfortunately, real life has not happened quite like that, and computers " "still require assistance before they can meaningfully process text." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2085 msgid "" "More precisely, they need help identifying what is what. Consider this text:" msgstr "" #. (itstool) path: blockquote/para #: book.translate.xml:2089 msgid "" "To remove /tmp/foo, use " "rm1." msgstr "" #. (itstool) path: blockquote/screen #: book.translate.xml:2092 #, no-wrap msgid "% rm /tmp/foo" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2095 msgid "" "It is easy to see which parts are filenames, which are commands to be typed " "in, which parts are references to manual pages, and so on. But the computer " "processing the document cannot. For this we need markup." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2100 msgid "" "Markup is commonly used to describe adding value or increasing cost. The term takes on both these " "meanings when applied to text. Markup is additional text included in the " "document, distinguished from the document's content in some way, so that " "programs that process the document can read the markup and use it when " "making decisions about the document. Editors can hide the markup from the " "user, so the user is not distracted by it." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2110 msgid "" "The extra information stored in the markup adds value " "to the document. Adding the markup to the document must typically be done by " "a person—after all, if computers could recognize the text sufficiently well " "to add the markup then there would be no need to add it in the first place. " "This increases the cost (the effort required) to create " "the document." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2119 msgid "" "The previous example is actually represented in this document like this:" msgstr "" #. (itstool) path: sect1/programlisting #: book.translate.xml:2122 #, no-wrap msgid "" "paraTo remove filename/tmp/foofilename, use " "&man.rm.1;.para\n" "\n" "screen&prompt.user; userinputrm /tmp/foouserinputscreen" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2126 msgid "The markup is clearly separate from the content." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2128 msgid "" "Markup languages define what the markup means and how it should be " "interpreted." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2131 msgid "" "Of course, one markup language might not be enough. A markup language for " "technical documentation has very different requirements than a markup " "language that is intended for cookery recipes. This, in turn, would be very " "different from a markup language used to describe poetry. What is really " "needed is a first language used to write these other markup languages. A " "meta markup language." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2139 msgid "" "This is exactly what the eXtensible Markup Language (XML) " "is. Many markup languages have been written in XML, " "including the two most used by the FDP, XHTML and DocBook." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2145 msgid "" "Each language definition is more properly called a grammar, vocabulary, " "schema or Document Type Definition (DTD). There are " "various languages to specify an XML grammar, or " "schema." msgstr "" #. (itstool) path: sect1/para #. (itstool) id: book.translate.xml#xml-primer-validating #: book.translate.xml:2151 msgid "" "A schema is a complete specification of all the " "elements that are allowed to appear, the order in which they should appear, " "which elements are mandatory, which are optional, and so forth. This makes " "it possible to write an XML parser " "which reads in both the schema and a document which claims to conform to the " "schema. The parser can then confirm whether or not all the elements required " "by the vocabulary are in the document in the right order, and whether there " "are any errors in the markup. This is normally referred to as " "validating the document." msgstr "" #. (itstool) path: note/para #: book.translate.xml:2165 msgid "" "Validation confirms that the choice of elements, their ordering, and so on, " "conforms to that listed in the grammar. It does not " "check whether appropriate markup has been used for the " "content. If all the filenames in a document were marked up as function " "names, the parser would not flag this as an error (assuming, of course, that " "the schema defines elements for filenames and functions, and that they are " "allowed to appear in the same place)." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2176 msgid "" "Most contributions to the Documentation Project will be content marked up in " "either XHTML or DocBook, rather than alterations to the " "schemas. For this reason, this book will not touch on how to write a " "vocabulary." msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:2184 msgid "Elements, Tags, and Attributes" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2186 msgid "" "All the vocabularies written in XML share certain " "characteristics. This is hardly surprising, as the philosophy behind " "XML will inevitably show through. One of the most obvious " "manifestations of this philosophy is that of content " "and elements." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2193 msgid "" "Documentation, whether it is a single web page, or a lengthy book, is " "considered to consist of content. This content is then divided and further " "subdivided into elements. The purpose of adding markup is to name and " "identify the boundaries of these elements for further processing." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2199 msgid "" "For example, consider a typical book. At the very top level, the book is " "itself an element. This book element obviously contains " "chapters, which can be considered to be elements in their own right. Each " "chapter will contain more elements, such as paragraphs, quotations, and " "footnotes. Each paragraph might contain further elements, identifying " "content that was direct speech, or the name of a character in the story." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2208 msgid "" "It may be helpful to think of this as chunking content. At " "the very top level is one chunk, the book. Look a little deeper, and there " "are more chunks, the individual chapters. These are chunked further into " "paragraphs, footnotes, character names, and so on." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2214 msgid "" "Notice how this differentiation between different elements of the content " "can be made without resorting to any XML terms. It really " "is surprisingly straightforward. This could be done with a highlighter pen " "and a printout of the book, using different colors to indicate different " "chunks of content." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2221 msgid "" "Of course, we do not have an electronic highlighter pen, so we need some " "other way of indicating which element each piece of content belongs to. In " "languages written in XML (XHTML, " "DocBook, et al) this is done by means of tags." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2227 msgid "" "A tag is used to identify where a particular element starts, and where the " "element ends. The tag is not part of the element itself." " Because each grammar was normally written to mark up specific types of " "information, each one will recognize different elements, and will therefore " "have different names for the tags." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2234 msgid "" "For an element called element-name the start tag " "will normally look like element-name. The corresponding closing tag for this element is element-name." msgstr "" #. (itstool) path: example/title #: book.translate.xml:2240 msgid "Using an Element (Start and End Tags)" msgstr "" #. (itstool) path: example/para #: book.translate.xml:2242 msgid "" "XHTML has an element for indicating that the content " "enclosed by the element is a paragraph, called p." msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:2246 #, no-wrap msgid "" "pThis is a paragraph. It starts with the " "start tag for\n" " the 'p' element, and it will end with the end tag for the 'p'\n" " element.p\n" "\n" "pThis is another paragraph. But this one is " "much shorter.p" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2253 msgid "" "Some elements have no content. For example, in XHTML, a " "horizontal line can be included in the document. For these empty elements, XML introduced a shorthand form that is " "completely equivalent to the two-tag version:" msgstr "" #. (itstool) path: example/title #: book.translate.xml:2260 msgid "Using an Element Without Content" msgstr "" #. (itstool) path: example/para #: book.translate.xml:2262 msgid "" "XHTML has an element for indicating a horizontal rule, " "called hr. This element does not wrap content, so it looks like " "this:" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:2266 #, no-wrap msgid "" "pOne paragraph.p\n" "hrhr\n" "\n" "pThis is another paragraph. A horizontal rule " "separates this\n" " from the previous paragraph.p" msgstr "" #. (itstool) path: example/para #: book.translate.xml:2272 msgid "The shorthand version consists of a single tag:" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:2274 #, no-wrap msgid "" "pOne paragraph.p\n" "hr\n" "\n" "pThis is another paragraph. A horizontal rule " "separates this\n" " from the previous paragraph.p" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2281 msgid "" "As shown above, elements can contain other elements. In the book example " "earlier, the book element contained all the chapter elements, which in turn " "contained all the paragraph elements, and so on." msgstr "" #. (itstool) path: example/title #: book.translate.xml:2287 msgid "Elements Within Elements; em" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:2289 #, no-wrap msgid "" "pThis is a simple emparagraphem where some\n" " of the emwordsem " "have been ememphasizedem.p" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2293 msgid "" "The grammar consists of rules that describe which elements can contain other " "elements, and exactly what they can contain." msgstr "" #. (itstool) path: important/para #: book.translate.xml:2298 msgid "" "People often confuse the terms tags and elements, and use the terms as if " "they were interchangeable. They are not." msgstr "" #. (itstool) path: important/para #: book.translate.xml:2302 msgid "" "An element is a conceptual part of your document. An element has a defined " "start and end. The tags mark where the element starts and ends." msgstr "" #. (itstool) path: important/para #: book.translate.xml:2306 msgid "" "When this document (or anyone else knowledgeable about XML) refers to the p tag " "they mean the literal text consisting of the three characters <, p, and >. But the phrase " "the p element refers to the whole element." msgstr "" #. (itstool) path: important/para #: book.translate.xml:2315 msgid "" "This distinction is very subtle. But keep it in mind." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2319 msgid "" "Elements can have attributes. An attribute has a name and a value, and is " "used for adding extra information to the element. This might be information " "that indicates how the content should be rendered, or might be something " "that uniquely identifies that occurrence of the element, or it might be " "something else." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2325 msgid "" "An element's attributes are written inside the start " "tag for that element, and take the form attribute-" "name=\"attribute-value\"." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2330 msgid "" "In XHTML, the p element has an attribute " "called align, which suggests an alignment " "(justification) for the paragraph to the program displaying the " "XHTML." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2336 msgid "" "The align attribute can take one of four " "defined values, left, center, " "right and justify. If the attribute is " "not specified then the default is left." msgstr "" #. (itstool) path: example/title #: book.translate.xml:2343 msgid "Using an Element with an Attribute" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:2345 #, no-wrap msgid "" "p align=\"left\"The inclusion of the align " "attribute\n" " on this paragraph was superfluous, since the default is left.p\n" "\n" "p align=\"center\"This may appear in the " "center.p" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2351 msgid "" "Some attributes only take specific values, such as left " "or justify. Others allow any value." msgstr "" #. (itstool) path: example/title #: book.translate.xml:2356 msgid "Single Quotes Around Attributes" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:2358 #, no-wrap msgid "" "p align='right'I am on the right!p" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2361 msgid "" "Attribute values in XML must be enclosed in either single " "or double quotes. Double quotes are traditional. Single quotes are useful " "when the attribute value contains double quotes." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2366 msgid "" "Information about attributes, elements, and tags is stored in catalog files. " "The Documentation Project uses standard DocBook catalogs and includes " "additional catalogs for FreeBSD-specific features. Paths to the catalog " "files are defined in an environment variable so they can be found by the " "document build tools." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:2374 book.translate.xml:2769 book.translate.xml:2905 #: book.translate.xml:3092 book.translate.xml:3385 msgid "To Do…" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:2376 msgid "" "Before running the examples in this document, install textproc/" "docproj from the FreeBSD Ports Collection. This is a " "meta-port that downloads and installs the standard " "programs and supporting files needed by the Documentation Project. " "csh1 users must use rehash for the shell to " "recognize new programs after they have been installed, or log out and then " "log back in again." msgstr "" #. (itstool) path: step/para #: book.translate.xml:2387 msgid "Create example.xml, and enter this text:" msgstr "" #. (itstool) path: step/programlisting #: book.translate.xml:2390 #, no-wrap msgid "" "!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 " "Transitional//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional." "dtd\"\n" "\n" "html xmlns=\"http://www.w3.org/1999/xhtml\"\n" " head\n" " titleAn Example XHTML Filetitle\n" " head\n" "\n" " body\n" " pThis is a paragraph containing some text." "p\n" "\n" " pThis paragraph contains some more text." "p\n" "\n" " p align=\"right\"This paragraph might be " "right-justified.p\n" " body\n" "html" msgstr "" #. (itstool) path: step/para #: book.translate.xml:2408 msgid "Try to validate this file using an XML parser." msgstr "" #. (itstool) path: step/para #: book.translate.xml:2411 msgid "" "textproc/docproj includes the xmllint " "validating parser." msgstr "" #. (itstool) path: step/para #: book.translate.xml:2416 msgid "Use xmllint to validate the document:" msgstr "" #. (itstool) path: step/screen #: book.translate.xml:2419 #, no-wrap msgid "" "% xmllint --valid --noout example.xml" msgstr "" #. (itstool) path: step/para #: book.translate.xml:2421 msgid "" "xmllint returns without displaying any output, showing " "that the document validated successfully." msgstr "" #. (itstool) path: step/para #: book.translate.xml:2427 msgid "" "See what happens when required elements are omitted. Delete the line with " "the title and title tags, and re-run the validation." msgstr "" #. (itstool) path: step/screen #: book.translate.xml:2433 #, no-wrap msgid "" "% xmllint --valid --noout example.xml\n" "example.xml:5: element head: validity error : Element head content does not " "follow the DTD, expecting ((script | style | meta | link | object | " "isindex)* , ((title , (script | style | meta | link | object | isindex)* , " "(base , (script | style | meta | link | object | isindex)*)?) | (base , " "(script | style | meta | link | object | isindex)* , title , (script | style " "| meta | link | object | isindex)*))), got ()" msgstr "" #. (itstool) path: step/para #: book.translate.xml:2436 msgid "" "This shows that the validation error comes from the fifth line of the example.xml file and " "that the content of the head is the part which " "does not follow the rules of the XHTML grammar." msgstr "" #. (itstool) path: step/para #: book.translate.xml:2443 msgid "" "Then xmllint shows the line where the error was found and " "marks the exact character position with a ^ sign." msgstr "" #. (itstool) path: step/para #: book.translate.xml:2449 msgid "Replace the title element." msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:2456 msgid "The DOCTYPE Declaration" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2458 msgid "" "The beginning of each document can specify the name of the DTD to which the document conforms. This DOCTYPE declaration is used by " "XML parsers to identify the DTD and " "ensure that the document does conform to it." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2464 msgid "" "A typical declaration for a document written to conform with version 1.0 of " "the XHTML DTD looks like this:" msgstr "" #. (itstool) path: sect1/programlisting #: book.translate.xml:2468 #, no-wrap msgid "" "!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 " "Transitional//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional." "dtd\"" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2470 msgid "That line contains a number of different components." msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:2474 msgid "<!" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:2477 msgid "" "The indicator shows this is an XML " "declaration." msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:2483 msgid "DOCTYPE" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:2486 msgid "" "Shows that this is an XML declaration of the document " "type." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:2495 msgid "" "Names the first element that " "will appear in the document." msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:2502 msgid "PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\"" msgstr "" #. (itstool) path: para/indexterm #. (itstool) path: sect2/indexterm #: book.translate.xml:2508 book.translate.xml:2549 msgid "Formal Public Identifier" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:2506 msgid "" "Lists the Formal Public Identifier (FPI) <_:indexterm-1/> " "for the DTD to which this document conforms. The " "XML parser uses this to find the correct DTD when processing this document." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:2516 msgid "" "PUBLIC is not a part of the FPI, but " "indicates to the XML processor how to find the " "DTD referenced in the FPI. Other ways " "of telling the XML parser how to find the DTD are shown later." msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:2527 msgid "" "\"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\"" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:2530 msgid "" "A local filename or a URL to find the DTD." msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:2536 msgid ">" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:2539 msgid "Ends the declaration and returns to the document." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:2546 msgid "Formal Public Identifiers (FPIs)" msgstr "" #. (itstool) path: note/para #: book.translate.xml:2554 msgid "" "It is not necessary to know this, but it is useful background, and might " "help debug problems when the XML processor cannot locate " "the DTD." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:2560 msgid "FPIs must follow a specific syntax:" msgstr "" #. (itstool) path: sect2/programlisting #: book.translate.xml:2563 #, no-wrap msgid "" "\"Owner//Keyword " "Description//Language\"" msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:2567 msgid "Owner" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:2570 msgid "The owner of the FPI." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:2572 msgid "" "The beginning of the string identifies the owner of the FPI. For example, the FPI \"ISO 8879:1986//" "ENTITIES Greek Symbols//EN\" lists ISO 8879:1986 as being the owner for the set of entities for Greek symbols. " "ISO 8879:1986 is the International Organization for " "Standardization (ISO) number for the SGML standard, the predecessor (and a superset) of XML." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:2585 msgid "" "Otherwise, this string will either look like -//Owner or +//Owner (notice the only difference is the leading + or " "-)." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:2592 msgid "" "If the string starts with - then the owner information is " "unregistered, with a + identifying it as registered." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:2597 msgid "" "ISO 9070:1991 defines how registered names are generated. " "It might be derived from the number of an ISO " "publication, an ISBN code, or an organization code " "assigned according to ISO 6523. Additionally, a " "registration authority could be created in order to assign registered names. " "The ISO council delegated this to the American National " "Standards Institute (ANSI)." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:2608 msgid "" "Because the FreeBSD Project has not been registered, the owner string is " "-//FreeBSD. As seen in the example, the W3C are not a registered owner either." msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:2616 msgid "Keyword" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:2619 msgid "" "There are several keywords that indicate the type of information in the file." " Some of the most common keywords are DTD, " "ELEMENT, ENTITIES, and TEXT. DTD is used only for DTD " "files, ELEMENT is usually used for DTD " "fragments that contain only entity or element declarations. TEXT is used for XML content (text and tags)." msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:2634 msgid "Description" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:2637 msgid "" "Any description can be given for the contents of this file. This may include " "version numbers or any short text that is meaningful and unique for the " "XML system." msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:2645 msgid "Language" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:2648 msgid "" "An ISO two-character code that identifies the native " "language for the file. EN is used for English." msgstr "" #. (itstool) path: sect3/title #: book.translate.xml:2656 msgid "catalog Files" msgstr "" #. (itstool) path: sect3/para #: book.translate.xml:2658 msgid "" "With the syntax above, an XML processor needs to have " "some way of turning the FPI into the name of the file " "containing the DTD. A catalog file (typically called " "catalog) contains lines that map FPIs to filenames. For example, if the catalog file contained the line:" msgstr "" #. (itstool) path: sect3/programlisting #: book.translate.xml:2668 #, no-wrap msgid "" "PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" \"1.0/" "transitional.dtd\"" msgstr "" #. (itstool) path: sect3/para #: book.translate.xml:2670 msgid "" "The XML processor knows that the DTD " "is called transitional.dtd in the 1.0 subdirectory of the directory that held catalog." msgstr "" #. (itstool) path: sect3/para #: book.translate.xml:2676 msgid "" "Examine the contents of /usr/local/share/xml/dtd/xhtml/catalog." "xml. This is the catalog file for the XHTML " "DTDs that were installed as part of the textproc/" "docproj port." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:2685 msgid "Alternatives to FPIs" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:2687 msgid "" "Instead of using an FPI to indicate the DTD to which the document conforms (and therefore, which file on the " "system contains the DTD), the filename can be explicitly " "specified." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:2693 msgid "The syntax is slightly different:" msgstr "" #. (itstool) path: sect2/programlisting #: book.translate.xml:2695 #, no-wrap msgid "!DOCTYPE html SYSTEM \"/path/to/file.dtd\"" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:2697 msgid "" "The SYSTEM keyword indicates that the XML processor should locate the DTD in a system " "specific fashion. This typically (but not always) means the DTD will be provided as a filename." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:2703 msgid "" "Using FPIs is preferred for reasons of portability. If " "the SYSTEM identifier is used, then the DTD must be provided and kept in the same location for everyone." msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:2711 msgid "Escaping Back to XML" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2713 msgid "" "Some of the underlying XML syntax can be useful within " "documents. For example, comments can be included in the document, and will " "be ignored by the parser. Comments are entered using XML " "syntax. Other uses for XML syntax will be shown later." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2719 msgid "" "XML sections begin with a <! tag " "and end with a >. These sections contain instructions " "for the parser rather than elements of the document. Everything between " "these tags is XML syntax. The DOCTYPE declaration shown earlier is an example " "of XML syntax included in the document." msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:2731 msgid "Comments" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2733 msgid "" "An XML document may contain comments. They may appear " "anywhere as long as they are not inside tags. They are even allowed in some " "locations inside the DTD (e.g., between entity declarations)." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2739 msgid "" "XML comments start with the string <!--" " and end with the string -->." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2743 msgid "Here are some examples of valid XML comments:" msgstr "" #. (itstool) path: example/title #: book.translate.xml:2747 msgid "XML Generic Comments" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:2749 #, no-wrap msgid "" "<!-- This is inside the comment -->\n" "\n" "<!--This is another comment-->\n" "\n" "<!-- This is how you\n" " write multiline comments -->\n" "\n" "<p>A simple <!-- Comment inside an element's content --> " "paragraph.</p>" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2759 msgid "" "XML comments may contain any strings except " "--:" msgstr "" #. (itstool) path: example/title #: book.translate.xml:2763 msgid "Erroneous XML Comment" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:2765 #, no-wrap msgid "<!-- This comment--is wrong -->" msgstr "" #. (itstool) path: step/para #: book.translate.xml:2773 msgid "" "Add some comments to example.xml, and check that the " "file still validates using xmllint." msgstr "" #. (itstool) path: step/para #: book.translate.xml:2779 msgid "" "Add some invalid comments to example.xml, and see the " "error messages that xmllint gives when it encounters an " "invalid comment." msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:2789 msgid "Entities" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2791 msgid "" "Entities are a mechanism for assigning names to chunks of content. As an " "XML parser processes a document, any entities it finds " "are replaced by the content of the entity." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2796 msgid "" "This is a good way to have re-usable, easily changeable chunks of content in " "XML documents. It is also the only way to include one " "marked up file inside another using XML." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2801 msgid "" "There are two types of entities for two different situations: " "general entities and parameter entities." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:2806 msgid "General Entities" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:2808 msgid "" "General entities are used to assign names to reusable chunks of text. These " "entities can only be used in the document. They cannot be used in an " "XML context." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:2813 msgid "" "To include the text of a general entity in the document, include " "&entity-name; in the text. " "For example, consider a general entity called current.version which expands to the current version number of a product. To use it " "in the document, write:" msgstr "" #. (itstool) path: sect2/programlisting #: book.translate.xml:2821 #, no-wrap msgid "" "paraThe current version of our product is\n" " &current.version;.para" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:2824 msgid "" "When the version number changes, edit the definition of the general entity, " "replacing the value. Then reprocess the document." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:2828 msgid "" "General entities can also be used to enter characters that could not " "otherwise be included in an XML document. For example, " "< and & cannot normally appear " "in an XML document. The XML parser " "sees the < symbol as the start of a tag. Likewise, " "when the & symbol is seen, the next text is expected " "to be an entity name." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:2837 msgid "" "These symbols can be included by using two predefined general entities: " "&lt; and &amp;." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:2841 msgid "" "General entities can only be defined within an XML " "context. Such definitions are usually done immediately after the DOCTYPE " "declaration." msgstr "" #. (itstool) path: example/title #: book.translate.xml:2846 msgid "Defining General Entities" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:2848 #, no-wrap msgid "" "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\"\n" "\"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\" [\n" "<!ENTITY current.version \"3.0-RELEASE\">\n" "<!ENTITY last.version \"2.2.7-RELEASE\">\n" "]>" msgstr "" #. (itstool) path: example/para #: book.translate.xml:2854 msgid "" "The DOCTYPE declaration has been extended by adding a square bracket at the " "end of the first line. The two entities are then defined over the next two " "lines, the square bracket is closed, and then the DOCTYPE declaration is " "closed." msgstr "" #. (itstool) path: example/para #: book.translate.xml:2860 msgid "" "The square brackets are necessary to indicate that the DTD indicated by the " "DOCTYPE declaration is being extended." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:2867 msgid "Parameter Entities" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:2869 msgid "" "Parameter entities, like general entities, are used to assign names to reusable " "chunks of text. But parameter entities can only be used within an XML context." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:2876 msgid "" "Parameter entity definitions are similar to those for general entities. " "However, parameter entities are included with %entity-" "name;. The definition also includes the % between the ENTITY keyword and the name of the " "entity." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:2884 msgid "" "For a mnemonic, think Parameter entities use the " "Percent symbol." msgstr "" #. (itstool) path: example/title #: book.translate.xml:2889 msgid "Defining Parameter Entities" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:2891 #, no-wrap msgid "" "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\"\n" "\"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\" [\n" "<!ENTITY % entity \"<!ENTITY version '1.0'>\">\n" "<!-- use the parameter entity -->\n" "%entity;\n" "]>" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:2899 msgid "" "At first sight, parameter entities do not look very useful, but they make it " "possible to include other files " "into an XML document." msgstr "" #. (itstool) path: step/para #: book.translate.xml:2909 msgid "Add a general entity to example.xml." msgstr "" #. (itstool) path: step/programlisting #: book.translate.xml:2912 #, no-wrap msgid "" "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\"\n" "\"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\" [\n" "<!ENTITY version \"1.1\">\n" "]>\n" "\n" "html xmlns=\"http://www.w3.org/1999/xhtml\"\n" " head\n" " titleAn Example XHTML Filetitle\n" " head\n" "\n" " <!-- There may be some comments in here as well -->\n" "\n" " body\n" " pThis is a paragraph containing some text." "p\n" "\n" " pThis paragraph contains some more text." "p\n" "\n" " p align=\"right\"This paragraph might be " "right-justified.p\n" "\n" " pThe current version of this document is: " "&version;p\n" " body\n" "html" msgstr "" #. (itstool) path: step/para #: book.translate.xml:2937 msgid "Validate the document using xmllint." msgstr "" #. (itstool) path: step/para #: book.translate.xml:2942 msgid "" "Load example.xml into a web browser. It may have to be " "copied to example.html before the browser recognizes it " "as an XHTML document." msgstr "" #. (itstool) path: step/para #: book.translate.xml:2948 msgid "" "Older browsers with simple parsers may not render this file as expected. The " "entity reference &version; may not be replaced by the " "version number, or the XML context closing " "]> may not be recognized and instead shown in the " "output." msgstr "" #. (itstool) path: step/para #: book.translate.xml:2957 msgid "" "The solution is to normalize the document with an " "XML normalizer. The normalizer reads valid XML and writes equally valid XML which has been " "transformed in some way. One way the normalizer transforms the input is by " "expanding all the entity references in the document, replacing the entities " "with the text that they represent." msgstr "" #. (itstool) path: step/para #: book.translate.xml:2966 msgid "" "xmllint can be used for this. It also has an option to " "drop the initial DTD section so that the closing " "]> does not confuse browsers:" msgstr "" #. (itstool) path: step/screen #: book.translate.xml:2971 #, no-wrap msgid "" "% xmllint --noent --dropdtd example.xml > " "example.html" msgstr "" #. (itstool) path: step/para #: book.translate.xml:2973 msgid "" "A normalized copy of the document with entities expanded is produced in " "example.html, ready to load into a web browser." msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:2982 msgid "Using Entities to Include Files" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:2984 msgid "" "Both general and parameter entities are " "particularly useful for including one file inside another." msgstr "" #. (itstool) path: sect2/title #. (itstool) path: example/title #: book.translate.xml:2991 book.translate.xml:3007 msgid "Using General Entities to Include Files" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:2993 msgid "" "Consider some content for an XML book organized into " "files, one file per chapter, called chapter1.xml, " "chapter2.xml, and so forth, with a book.xml that will contain these chapters." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:3000 msgid "" "In order to use the contents of these files as the values for entities, they " "are declared with the SYSTEM keyword. This directs the " "XML parser to include the contents of the named file as " "the value of the entity." msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:3009 #, no-wrap msgid "" "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\"\n" "\"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\" [\n" "<!ENTITY chapter.1 SYSTEM \"chapter1.xml\">\n" "<!ENTITY chapter.2 SYSTEM \"chapter2.xml\">\n" "<!ENTITY chapter.3 SYSTEM \"chapter3.xml\">\n" "<!-- And so forth -->\n" "]>\n" "\n" "html xmlns=\"http://www.w3.org/1999/xhtml\"\n" " <!-- Use the entities to load in the chapters -->\n" "\n" " &chapter.1;\n" " &chapter.2;\n" " &chapter.3;\n" "html" msgstr "" #. (itstool) path: warning/para #: book.translate.xml:3027 msgid "" "When using general entities to include other files within a document, the " "files being included (chapter1.xml, chapter2." "xml, and so on) must not start with a " "DOCTYPE declaration. This is a syntax error because entities are low-level " "constructs and they are resolved before any parsing happens." msgstr "" #. (itstool) path: sect2/title #. (itstool) path: example/title #: book.translate.xml:3039 book.translate.xml:3058 msgid "Using Parameter Entities to Include Files" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:3041 msgid "" "Parameter entities can only be used inside an XML context." " Including a file in an XML context can be used to ensure " "that general entities are reusable." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:3046 msgid "" "Suppose that there are many chapters in the document, and these chapters " "were reused in two different books, each book organizing the chapters in a " "different fashion." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:3050 msgid "" "The entities could be listed at the top of each book, but that quickly " "becomes cumbersome to manage." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:3053 msgid "" "Instead, place the general entity definitions inside one file, and use a " "parameter entity to include that file within the document." msgstr "" #. (itstool) path: example/para #: book.translate.xml:3060 msgid "" "Place the entity definitions in a separate file called chapters." "ent and containing this text:" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:3064 #, no-wrap msgid "" "<!ENTITY chapter.1 SYSTEM \"chapter1.xml\">\n" "<!ENTITY chapter.2 SYSTEM \"chapter2.xml\">\n" "<!ENTITY chapter.3 SYSTEM \"chapter3.xml\">" msgstr "" #. (itstool) path: example/para #: book.translate.xml:3068 msgid "" "Create a parameter entity to refer to the contents of the file. Then use the " "parameter entity to load the file into the document, which will then make " "all the general entities available for use. Then use the general entities as " "before:" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:3074 #, no-wrap msgid "" "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\"\n" "\"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\" [\n" "<!-- Define a parameter entity to load in the chapter general entities --" ">\n" "<!ENTITY % chapters SYSTEM \"chapters.ent\">\n" "\n" "<!-- Now use the parameter entity to load in this file -->\n" "%chapters;\n" "]>\n" "\n" "html xmlns=\"http://www.w3.org/1999/xhtml\"\n" " &chapter.1;\n" " &chapter.2;\n" " &chapter.3;\n" "html" msgstr "" #. (itstool) path: sect3/title #: book.translate.xml:3095 msgid "Use General Entities to Include Files" msgstr "" #. (itstool) path: step/para #: book.translate.xml:3099 msgid "" "Create three files, para1.xml, para2.xml, and para3.xml." msgstr "" #. (itstool) path: step/para #: book.translate.xml:3103 msgid "Put content like this in each file:" msgstr "" #. (itstool) path: step/programlisting #: book.translate.xml:3105 #, no-wrap msgid "" "pThis is the first paragraph.p" msgstr "" #. (itstool) path: step/para #: book.translate.xml:3109 book.translate.xml:3162 msgid "Edit example.xml so that it looks like this:" msgstr "" #. (itstool) path: step/programlisting #: book.translate.xml:3112 #, no-wrap msgid "" "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\"\n" "\"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\" [\n" "<!ENTITY version \"1.1\">\n" "<!ENTITY para1 SYSTEM \"para1.xml\">\n" "<!ENTITY para2 SYSTEM \"para2.xml\">\n" "<!ENTITY para3 SYSTEM \"para3.xml\">\n" "]>\n" "\n" "html xmlns=\"http://www.w3.org/1999/xhtml\"\n" " head\n" " titleAn Example XHTML Filetitle\n" " head\n" "\n" " body\n" " pThe current version of this document is: " "&version;p\n" "\n" " &para1;\n" " &para2;\n" " &para3;\n" " body\n" "html" msgstr "" #. (itstool) path: step/para #: book.translate.xml:3136 book.translate.xml:3197 msgid "" "Produce example.html by normalizing example." "xml." msgstr "" #. (itstool) path: step/screen #: book.translate.xml:3139 book.translate.xml:3200 #, no-wrap msgid "" "% xmllint --dropdtd --noent example.xml > " "example.html" msgstr "" #. (itstool) path: step/para #: book.translate.xml:3143 book.translate.xml:3204 msgid "" "Load example.html into the web browser and confirm that " "the paran.xml files have " "been included in example.html." msgstr "" #. (itstool) path: sect3/title #: book.translate.xml:3153 msgid "Use Parameter Entities to Include Files" msgstr "" #. (itstool) path: note/para #: book.translate.xml:3156 msgid "The previous steps must have completed before this step." msgstr "" #. (itstool) path: step/programlisting #: book.translate.xml:3165 #, no-wrap msgid "" "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\"\n" "\"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\" [\n" "<!ENTITY % entities SYSTEM \"entities.ent\"> %entities;\n" "]>\n" "\n" "html xmlns=\"http://www.w3.org/1999/xhtml\"\n" " head\n" " titleAn Example XHTML Filetitle\n" " head\n" "\n" " body\n" " pThe current version of this document is: " "&version;p\n" "\n" " &para1;\n" " &para2;\n" " &para3;\n" " body\n" "html" msgstr "" #. (itstool) path: step/para #: book.translate.xml:3186 msgid "" "Create a new file called entities.ent with this content:" "" msgstr "" #. (itstool) path: step/programlisting #: book.translate.xml:3190 #, no-wrap msgid "" "<!ENTITY version \"1.1\">\n" "<!ENTITY para1 SYSTEM \"para1.xml\">\n" "<!ENTITY para2 SYSTEM \"para2.xml\">\n" "<!ENTITY para3 SYSTEM \"para3.xml\">" msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:3216 msgid "Marked Sections" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:3218 msgid "" "XML provides a mechanism to indicate that particular " "pieces of the document should be processed in a special way. These are " "called marked sections." msgstr "" #. (itstool) path: example/title #: book.translate.xml:3224 msgid "Structure of a Marked Section" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:3226 #, no-wrap msgid "" "<![KEYWORD[\n" " Contents of marked section\n" "]]>" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:3231 msgid "" "As expected of an XML construct, a marked section starts " "with <!." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:3234 msgid "The first square bracket begins the marked section." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:3236 msgid "" "KEYWORD describes how this marked section is to " "be processed by the parser." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:3239 msgid "" "The second square bracket indicates the start of the marked section's " "content." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:3242 msgid "" "The marked section is finished by closing the two square brackets, and then " "returning to the document context from the XML context " "with >." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:3248 msgid "Marked Section Keywords" msgstr "" #. (itstool) path: sect3/title #: book.translate.xml:3251 msgid "CDATA" msgstr "" #. (itstool) path: sect3/para #: book.translate.xml:3253 msgid "" "These keywords denote the marked sections content model, and allow you to change it from the default." msgstr "" #. (itstool) path: sect3/para #: book.translate.xml:3257 msgid "" "When an XML parser is processing a document, it keeps " "track of the content model." msgstr "" #. (itstool) path: sect3/para #: book.translate.xml:3261 msgid "" "The content model describes the content the parser is expecting to see and " "what it will do with that content." msgstr "" #. (itstool) path: sect3/para #: book.translate.xml:3265 msgid "The CDATA content model is one of the most useful." msgstr "" #. (itstool) path: sect3/para #: book.translate.xml:3268 msgid "" "CDATA is for Character Data. When the " "parser is in this content model, it expects to see only characters. In this " "model the < and & symbols lose " "their special status, and will be treated as ordinary characters." msgstr "" #. (itstool) path: note/para #: book.translate.xml:3276 msgid "" "When using CDATA in examples of text marked up in " "XML, remember that the content of CDATA is not validated. The included text must be check with other means. " "For example, the content could be written in another document, validated, " "and then pasted into the CDATA section." msgstr "" #. (itstool) path: example/title #: book.translate.xml:3286 msgid "Using a CDATA Marked Section" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:3289 #, no-wrap msgid "" "paraHere is an example of how to include some " "text that contains\n" " many literal&lt;literal and literal&amp;literal\n" " symbols. The sample text is a fragment of\n" " acronymXHTMLacronym. The surrounding text (para and\n" " programlisting) are from DocBook.para\n" "\n" "programlisting<![CDATA[pThis is a sample that shows some of the\n" " elements within acronymXHTMLacronym. Since the angle\n" " brackets are used so many times, it is simpler to say the whole\n" " example is a CDATA marked section than to use the entity names for\n" " the left and right angle brackets throughout.p\n" "\n" " ul\n" " liThis is a listitemli\n" " liThis is a second listitemli\n" " liThis is a third listitemli\n" " ul\n" "\n" " pThis is the end of the example.p]]>programlisting" msgstr "" #. (itstool) path: sect3/title #: book.translate.xml:3312 msgid "INCLUDE and IGNORE" msgstr "" #. (itstool) path: sect3/para #: book.translate.xml:3315 msgid "" "When the keyword is INCLUDE, then the contents of the " "marked section will be processed. When the keyword is IGNORE, the marked section is ignored and will not be processed. It will " "not appear in the output." msgstr "" #. (itstool) path: example/title #: book.translate.xml:3322 msgid "" "Using INCLUDE and IGNORE in Marked " "Sections" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:3325 #, no-wrap msgid "" "<![INCLUDE[\n" " This text will be processed and included.\n" "]]>\n" "\n" "<![IGNORE[\n" " This text will not be processed or included.\n" "]]>" msgstr "" #. (itstool) path: sect3/para #: book.translate.xml:3334 msgid "" "By itself, this is not too useful. Text to be removed from the document " "could be cut out, or wrapped in comments." msgstr "" #. (itstool) path: sect3/para #: book.translate.xml:3338 msgid "" "It becomes more useful when controlled by parameter entities, yet this usage is limited to " "entity files." msgstr "" #. (itstool) path: sect3/para #: book.translate.xml:3343 msgid "" "For example, suppose that documentation was produced in a hard-copy version " "and an electronic version. Some extra text is desired in the electronic " "version content that was not to appear in the hard-copy." msgstr "" #. (itstool) path: sect3/para #: book.translate.xml:3348 msgid "" "Create an entity file that defines general entities to include each chapter " "and guard these definitions with a parameter entity that can be set to " "either INCLUDE or IGNORE to control " "whether the entity is defined. After these conditional general entity " "definitions, place one more definition for each general entity to set them " "to an empty value. This technique makes use of the fact that entity " "definitions cannot be overridden but the first definition always takes " "effect. So the inclusion of the chapter is controlled with the corresponding " "parameter entity. Set to INCLUDE, the first general " "entity definition will be read and the second one will be ignored. Set to " "IGNORE, the first definition will be ignored and the " "second one will take effect." msgstr "" #. (itstool) path: example/title #: book.translate.xml:3365 msgid "Using a Parameter Entity to Control a Marked Section" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:3368 #, no-wrap msgid "" "<!ENTITY % electronic.copy \"INCLUDE\">\n" "\n" "<![%electronic.copy;[\n" "<!ENTITY chap.preface SYSTEM \"preface.xml\">\n" "]]>\n" "\n" "<!ENTITY chap.preface \"\">" msgstr "" #. (itstool) path: example/para #: book.translate.xml:3376 msgid "" "When producing the hard-copy version, change the parameter entity's " "definition to:" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:3379 #, no-wrap msgid "<!ENTITY % electronic.copy \"IGNORE\">" msgstr "" #. (itstool) path: step/para #: book.translate.xml:3389 msgid "Modify entities.ent to contain the following:" msgstr "" #. (itstool) path: step/programlisting #: book.translate.xml:3392 #, no-wrap msgid "" "<!ENTITY version \"1.1\">\n" "<!ENTITY % conditional.text \"IGNORE\">\n" "\n" "<![%conditional.text;[\n" "<!ENTITY para1 SYSTEM \"para1.xml\">\n" "]]>\n" "\n" "<!ENTITY para1 \"\">\n" "\n" "<!ENTITY para2 SYSTEM \"para2.xml\">\n" "<!ENTITY para3 SYSTEM \"para3.xml\">" msgstr "" #. (itstool) path: step/para #: book.translate.xml:3406 msgid "" "Normalize example.xml and notice that the conditional " "text is not present in the output document. Set the parameter entity guard " "to INCLUDE and regenerate the normalized document and the " "text will appear again. This method makes sense if there are more " "conditional chunks depending on the same condition. For example, to control " "generating printed or online text." msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:3421 msgid "Conclusion" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:3423 msgid "" "That is the conclusion of this XML primer. For reasons of " "space and complexity, several things have not been covered in depth (or at " "all). However, the previous sections cover enough XML to " "introduce the organization of the FDP documentation." msgstr "" #. (itstool) path: chapter/title #: book.translate.xml:3464 msgid "XHTML Markup" msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:3467 book.translate.xml:4070 book.translate.xml:7336 #: book.translate.xml:8250 msgid "Introduction" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:3469 msgid "" "This chapter describes usage of the XHTML markup language " "used for the FreeBSD web site." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:3472 msgid "" "XHTML is the XML version of the " "HyperText Markup Language, the markup language of choice on the World Wide " "Web. More information can be found at http://www.w3.org/." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:3477 msgid "" "XHTML is used to mark up pages on the FreeBSD web site. " "It is usually not used to mark up other documentation, since DocBook offers " "a far richer set of elements from which to choose. Consequently, " "XHTML pages will normally only be encountered when " "writing for the web site." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:3484 msgid "" "HTML has gone through a number of versions. The " "XML-compliant version described here is called " "XHTML. The latest widespread version is XHTML 1.0, available in both strict and " "transitional variants." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:3491 msgid "" "The XHTML DTDs are available from the " "Ports Collection in textproc/xhtml. They are " "automatically installed by the textproc/docproj port." msgstr "" #. (itstool) path: note/para #: book.translate.xml:3498 msgid "" "This is not an exhaustive list of elements, since that " "would just repeat the documentation for XHTML. The aim is " "to list those elements most commonly used. Please post questions about " "elements or uses not covered here to the FreeBSD documentation project " "mailing list." msgstr "" #. (itstool) path: note/title #: book.translate.xml:3506 book.translate.xml:4109 msgid "Inline Versus Block" msgstr "" #. (itstool) path: note/para #: book.translate.xml:3508 book.translate.xml:4111 msgid "" "In the remainder of this document, when describing elements, " "inline means that the element can occur within a block " "element, and does not cause a line break. A block " "element, by comparison, will cause a line break (and other processing) when " "it is encountered." msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:3518 msgid "Formal Public Identifier (FPI)" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:3520 msgid "" "There are a number of XHTML FPIs, " "depending upon the version, or level of XHTML to which a document conforms. Most XHTML " "documents on the FreeBSD web site comply with the transitional version of " "XHTML 1.0." msgstr "" #. (itstool) path: sect1/programlisting #: book.translate.xml:3527 #, no-wrap msgid "PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\"" msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:3531 msgid "Sectional Elements" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:3533 msgid "" "An XHTML document is normally split into two sections. " "The first section, called the head, contains meta-" "information about the document, such as its title, the name of the author, " "the parent document, and so on. The second section, the body, contains content that will be displayed to the user." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:3541 msgid "" "These sections are indicated with head and body " "elements respectively. These elements are contained within the top-level " "html element." msgstr "" #. (itstool) path: example/title #: book.translate.xml:3547 msgid "Normal XHTML Document Structure" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:3550 #, no-wrap msgid "" "html xmlns=\"http://www.w3.org/1999/xhtml\"\n" " head\n" " titleThe Document's Titletitle\n" " head\n" "\n" " body\n" "\n" " …\n" "\n" " body\n" "html" msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:3565 book.translate.xml:4709 msgid "Block Elements" msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:3568 msgid "Headings" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:3570 msgid "" "XHTML has tags to denote headings in the document at up " "to six different levels." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:3573 msgid "" "The largest and most prominent heading is h1, then h2, " "continuing down to h6." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:3577 msgid "The element's content is the text of the heading." msgstr "" #. (itstool) path: example/title #: book.translate.xml:3580 msgid "h1, h2, and Other Header Tags" msgstr "" #. (itstool) path: example/para #: book.translate.xml:3583 book.translate.xml:3618 book.translate.xml:3634 #: book.translate.xml:3679 book.translate.xml:3711 book.translate.xml:3788 #: book.translate.xml:3816 book.translate.xml:3838 book.translate.xml:3860 #: book.translate.xml:3916 book.translate.xml:3933 book.translate.xml:3963 #: book.translate.xml:3988 book.translate.xml:4728 book.translate.xml:4754 #: book.translate.xml:4835 book.translate.xml:4869 book.translate.xml:4916 #: book.translate.xml:4976 book.translate.xml:5037 book.translate.xml:5133 #: book.translate.xml:5269 book.translate.xml:5431 book.translate.xml:5490 #: book.translate.xml:5517 book.translate.xml:5547 book.translate.xml:5586 #: book.translate.xml:5694 book.translate.xml:5751 book.translate.xml:5802 #: book.translate.xml:5921 book.translate.xml:5989 book.translate.xml:6018 #: book.translate.xml:6039 book.translate.xml:6081 book.translate.xml:6136 #: book.translate.xml:6169 book.translate.xml:6186 book.translate.xml:6220 #: book.translate.xml:6244 book.translate.xml:6724 book.translate.xml:6740 msgid "Usage:" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:3585 #, no-wrap msgid "" "h1First sectionh1\n" "\n" "<!-- Document introduction goes here -->\n" "\n" "h2This is the heading for the first " "sectionh2\n" "\n" "<!-- Content for the first section goes here -->\n" "\n" "h3This is the heading for the first sub-" "sectionh3\n" "\n" "<!-- Content for the first sub-section goes here -->\n" "\n" "h2This is the heading for the second " "sectionh2\n" "\n" "<!-- Content for the second section goes here -->" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:3602 msgid "" "Generally, an XHTML page should have one first level " "heading (h1). This can contain many second level headings " "(h2), which can in turn contain many third level headings. Do not " "leave gaps in the numbering." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:3610 book.translate.xml:4712 msgid "Paragraphs" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:3612 msgid "" "XHTML supports a single paragraph element, p." msgstr "" #. (itstool) path: example/title #: book.translate.xml:3616 msgid "p Example" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:3620 #, no-wrap msgid "" "pThis is a paragraph. It can contain just " "about any\n" " other element.p" msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:3626 book.translate.xml:4741 msgid "Block Quotations" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:3628 msgid "" "A block quotation is an extended quotation from another document that will " "appear in a separate paragraph." msgstr "" #. (itstool) path: example/title #: book.translate.xml:3632 book.translate.xml:4752 msgid "blockquote Example" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:3636 #, no-wrap msgid "" "pA small excerpt from the US Constitution:p\n" "\n" "blockquoteWe the People of the United States, " "in Order to form\n" " a more perfect Union, establish Justice, insure domestic\n" " Tranquility, provide for the common defence, promote the general\n" " Welfare, and secure the Blessings of Liberty to ourselves and our\n" " Posterity, do ordain and establish this Constitution for the\n" " United States of America.blockquote" msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:3648 msgid "Lists" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:3650 msgid "" "XHTML can present the user with three types of lists: " "ordered, unordered, and definition." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:3653 msgid "" "Entries in an ordered list will be numbered, while entries in an unordered " "list will be preceded by bullet points. Definition lists have two sections " "for each entry. The first section is the term being defined, and the second " "section is the definition." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:3659 msgid "" "Ordered lists are indicated by the ol element, unordered lists by " "the ul element, and definition lists by the dl element." "" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:3664 msgid "" "Ordered and unordered lists contain listitems, indicated by the li element. A listitem can contain textual content, or it may be further " "wrapped in one or more p elements." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:3669 msgid "" "Definition lists contain definition terms (dt) and definition " "descriptions (dd). A definition term can only contain inline " "elements. A definition description can contain other block elements." msgstr "" #. (itstool) path: example/title #: book.translate.xml:3676 msgid "ul and ol Example" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:3681 #, no-wrap msgid "" "pAn unordered list. Listitems will probably " "be\n" " preceded by bullets.p\n" "\n" "ul\n" " liFirst itemli\n" "\n" " liSecond itemli\n" "\n" " liThird itemli\n" "ul\n" "\n" "pAn ordered list, with list items consisting " "of multiple\n" " paragraphs. Each item (note: not each paragraph) will be\n" " numbered.p\n" "\n" "ol\n" " lipThis is the " "first item. It only has one paragraph.pli\n" "\n" " lipThis is the " "first paragraph of the second item.p\n" "\n" " pThis is the second paragraph of the " "second item.pli\n" "\n" " lipThis is the " "first and only paragraph of the third\n" " item.pli\n" "ol" msgstr "" #. (itstool) path: example/title #: book.translate.xml:3709 msgid "Definition Lists with dl" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:3713 #, no-wrap msgid "" "dl\n" " dtTerm 1dt\n" "\n" " ddpParagraph 1 " "of definition 1.p\n" "\n" " pParagraph 2 of definition 1.pdd\n" "\n" " dtTerm 2dt\n" "\n" " ddpParagraph 1 " "of definition 2.pdd\n" "\n" " dtTerm 3dt\n" "\n" " ddpParagraph 1 " "of definition 3.pdd\n" "dl" msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:3732 msgid "Pre-formatted Text" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:3734 msgid "" "Pre-formatted text is shown to the user exactly as it is in the file. Text " "is shown in a fixed font. Multiple spaces and line breaks are shown exactly " "as they are in the file." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:3739 msgid "Wrap pre-formatted text in the pre element." msgstr "" #. (itstool) path: example/title #: book.translate.xml:3743 msgid "pre Example" msgstr "" #. (itstool) path: example/para #: book.translate.xml:3745 msgid "" "For example, the pre tags could be used to mark up an email " "message:" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:3748 #, no-wrap msgid "" "pre From: nik@FreeBSD.org\n" " To: freebsd-doc@FreeBSD.org\n" " Subject: New documentation available\n" "\n" " There is a new copy of my primer for contributors to the FreeBSD\n" " Documentation Project available at\n" "\n" " &lt;URL:https://people.FreeBSD.org/~nik/primer/index.html&gt;\n" "\n" " Comments appreciated.\n" "\n" " Npre" msgstr "" #. (itstool) path: example/para #: book.translate.xml:3761 msgid "" "Keep in mind that < and & still " "are recognized as special characters in pre-formatted text. This is why the " "example shown had to use &lt; instead of " "<. For consistency, &gt; was " "used in place of >, too. Watch out for the special " "characters that may appear in text copied from a plain-text source, like an " "email message or program code." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:3774 book.translate.xml:5242 msgid "Tables" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:3776 msgid "" "Mark up tabular information using the table element. A table " "consists of one or more table rows (tr), each containing one or " "more cells of table data (td). Each cell can contain other block " "elements, such as paragraphs or lists. It can also contain another table " "(this nesting can repeat indefinitely). If the cell only contains one " "paragraph then the pelement is not needed." msgstr "" #. (itstool) path: example/title #: book.translate.xml:3786 msgid "Simple Use of table" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:3790 #, no-wrap msgid "" "pThis is a simple 2x2 table.p\n" "\n" "table\n" " tr\n" " tdTop left celltd\n" "\n" " tdTop right celltd\n" " tr\n" "\n" " tr\n" " tdBottom left celltd\n" "\n" " tdBottom right celltd\n" " tr\n" "table" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:3807 msgid "" "A cell can span multiple rows and columns by adding the rowspan or colspan " "attributes with values for the number of rows or columns to be spanned." msgstr "" #. (itstool) path: example/title #: book.translate.xml:3813 msgid "Using rowspan" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:3818 #, no-wrap msgid "" "pOne tall thin cell on the left, two short " "cells next to\n" " it on the right.p\n" "\n" "table\n" " tr\n" " td rowspan=\"2\"Long and thintd\n" " tr\n" "\n" " tr\n" " tdTop celltd\n" "\n" " tdBottom celltd\n" " tr\n" "table" msgstr "" #. (itstool) path: example/title #: book.translate.xml:3835 msgid "Using colspan" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:3840 #, no-wrap msgid "" "pOne long cell on top, two short cells below " "it.p\n" "\n" "table\n" " tr\n" " td colspan=\"2\"Top celltd\n" " tr\n" "\n" " tr\n" " tdBottom left celltd\n" "\n" " tdBottom right celltd\n" " tr\n" "table" msgstr "" #. (itstool) path: example/title #: book.translate.xml:3856 msgid "" "Using rowspan and colspan Together" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:3862 #, no-wrap msgid "" "pOn a 3x3 grid, the top left block is a 2x2 " "set of\n" " cells merged into one. The other cells are normal.p\n" "\n" "table\n" " tr\n" " td colspan=\"2\" rowspan=\"2\"Top left " "large celltd\n" "\n" " tdTop right celltd\n" " tr\n" "\n" " tr\n" " <!-- Because the large cell on the left merges into\n" " this row, the first <td> will occur on its\n" " right -->\n" "\n" " tdMiddle right celltd\n" " tr\n" "\n" " tr\n" " tdBottom left celltd\n" "\n" " tdBottom middle celltd\n" "\n" " tdBottom right celltd\n" " tr\n" "table" msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:3893 book.translate.xml:5469 msgid "In-line Elements" msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:3896 book.translate.xml:5472 msgid "Emphasizing Information" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:3898 msgid "" "Two levels of emphasis are available in XHTML, em and strong. em is for a normal level of emphasis " "and strong indicates stronger emphasis." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:3904 msgid "" "em is typically rendered in italic and strong is " "rendered in bold. This is not always the case, and should not be relied upon." " According to best practices, web pages only hold structural and semantical " "information, and stylesheets are later applied to them. Think of semantics, " "not formatting, when using these tags." msgstr "" #. (itstool) path: example/title #: book.translate.xml:3913 msgid "em and strong Example" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:3918 #, no-wrap msgid "" "pemThisem has been emphasized, while\n" " strongthisstrong " "has been strongly emphasized.p" msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:3924 msgid "Indicating Fixed-Pitch Text" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:3926 msgid "" "Content that should be rendered in a fixed pitch (typewriter) typeface is " "tagged with tt (for teletype)." msgstr "" #. (itstool) path: example/title #: book.translate.xml:3931 msgid "tt Example" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:3935 #, no-wrap msgid "" "pMany system settings are stored in\n" " tt/etctt.p" msgstr "" #. (itstool) path: sect2/title #. (itstool) path: sect1/title #: book.translate.xml:3941 book.translate.xml:6562 msgid "Links" msgstr "" #. (itstool) path: note/para #: book.translate.xml:3944 msgid "Links are also inline elements." msgstr "" #. (itstool) path: sect3/title #. (itstool) path: sect2/title #: book.translate.xml:3948 book.translate.xml:6657 msgid "Linking to Other Documents on the Web" msgstr "" #. (itstool) path: sect3/para #: book.translate.xml:3950 msgid "" "A link points to the URL of a document on the web. The " "link is indicated with a, and the href attribute contains the URL of the target document. " "The content of the element becomes the link, indicated to the user by " "showing it in a different color or with an underline." msgstr "" #. (itstool) path: example/title #: book.translate.xml:3960 msgid "Using a href=\"...\"" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:3965 #, no-wrap msgid "" "pMore information is available at the\n" " a href=\"http://www.&os;.org/\"&os; " "web sitea.p" msgstr "" #. (itstool) path: sect3/para #: book.translate.xml:3969 msgid "This link always takes the user to the top of the linked document." msgstr "" #. (itstool) path: sect3/title #: book.translate.xml:3974 msgid "Linking to Specific Parts of Documents" msgstr "" #. (itstool) path: sect3/para #: book.translate.xml:3976 msgid "" "To link to a specific point within a document, that document must include an " "anchor at the desired point. Anchors are included by " "setting the id attribute of an element to a " "name. This example creates an anchor by setting the id attribute of a p element." "" msgstr "" #. (itstool) path: example/title #: book.translate.xml:3986 msgid "Creating an Anchor" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:3990 #, no-wrap msgid "" "p id=\"samplepara\"This paragraph can be " "referenced\n" " in other links with the name ttsampleparatt.p" msgstr "" #. (itstool) path: sect3/para #: book.translate.xml:3994 msgid "" "Links to anchors are similar to plain links, but include a # symbol and the anchor's ID at the end of the " "URL." msgstr "" #. (itstool) path: example/title #: book.translate.xml:4000 msgid "Linking to a Named Part of a Different Document" msgstr "" #. (itstool) path: example/para #: book.translate.xml:4003 msgid "" "The samplepara example is part of a document called " "foo.html. A link to that specific paragraph in the " "document is constructed in this example." msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:4008 #, no-wrap msgid "" "pMore information can be found in the\n" " a href=\"foo.html#samplepara\"sample " "paragrapha of\n" " ttfoo.htmltt." "p" msgstr "" #. (itstool) path: sect3/para #: book.translate.xml:4013 msgid "" "To link to a named anchor within the same document, omit the document's " "URL, and just use the # symbol " "followed by the name of the anchor." msgstr "" #. (itstool) path: example/title #: book.translate.xml:4019 msgid "Linking to a Named Part of the Same Document" msgstr "" #. (itstool) path: example/para #: book.translate.xml:4021 msgid "" "The samplepara example resides in this document. To link " "to it:" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:4024 #, no-wrap msgid "" "pMore information can be found in the\n" " a href=\"#samplepara\"sample paragrapha of this\n" " document.p" msgstr "" #. (itstool) path: chapter/title #: book.translate.xml:4067 msgid "DocBook Markup" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:4072 msgid "" "This chapter is an introduction to DocBook as it is used for FreeBSD " "documentation. DocBook is a large and complex markup system, but the subset " "described here covers the parts that are most widely used for FreeBSD " "documentation. While a moderate subset is covered, it is impossible to " "anticipate every situation. Please post questions that this document does " "not answer to the FreeBSD documentation project mailing list." msgstr "" #. (itstool) path: footnote/para #: book.translate.xml:4083 msgid "" "A short history can be found under http://www.oasis-open.org/docbook/intro." "shtml#d0e41." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:4080 msgid "" "DocBook was originally developed by HaL Computer Systems and O'Reilly & " "Associates to be a Document Type Definition (DTD) for " "writing technical documentation <_:footnote-1/>. Since 1998 it is maintained " "by the DocBook Technical Committee. As such, and " "unlike LinuxDoc and XHTML, DocBook is very heavily " "oriented towards markup that describes what something " "is, rather than describing how it should be presented." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:4091 msgid "" "The DocBook DTD is available from the Ports Collection in " "the textproc/docbook-xml port. It is automatically " "installed as part of the textproc/docproj port." msgstr "" #. (itstool) path: note/title #: book.translate.xml:4099 msgid "Formal Versus Informal" msgstr "" #. (itstool) path: note/para #: book.translate.xml:4101 msgid "" "Some elements may exist in two forms, formal and " "informal. Typically, the formal version of the element " "will consist of a title followed by the informal version of the element. The " "informal version will not have a title." msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:4121 msgid "FreeBSD Extensions" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:4123 msgid "" "The FreeBSD Documentation Project has extended the DocBook DTD with additional elements and entities. These additions serve to " "make some of the markup easier or more precise." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:4128 msgid "" "Throughout the rest of this document, the term DocBook is " "used to mean the FreeBSD-extended DocBook DTD." msgstr "" #. (itstool) path: note/para #: book.translate.xml:4133 msgid "" "Most of these extensions are not unique to FreeBSD, it was just felt that " "they were useful enhancements for this particular project. Should anyone " "from any of the other *nix camps (NetBSD, OpenBSD, Linux, …) be interested " "in collaborating on a standard DocBook extension set, please contact " "Documentation Engineering Team doceng@FreeBSD.org." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:4142 msgid "FreeBSD Elements" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:4144 msgid "" "The additional FreeBSD elements are not (currently) in the Ports Collection. " "They are stored in the FreeBSD Subversion tree, as head/share/xml/freebsd." "dtd." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:4148 msgid "" "FreeBSD-specific elements used in the examples below are clearly marked." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:4153 msgid "FreeBSD Entities" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:4155 msgid "" "This table shows some of the most useful entities available in the " "FDP. For a complete list, see the *.ent files in doc/share/xml." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4175 msgid "FreeBSD Name Entities" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4180 msgid "&os;" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4181 msgid "FreeBSD" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4186 msgid "&os.stable;" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4187 msgid "FreeBSD-STABLE" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4192 msgid "&os.current;" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4193 msgid "FreeBSD-CURRENT" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4204 msgid "Manual Page Entities" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4209 msgid "&man.ls.1;" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4210 msgid "" "ls1" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4211 msgid "" "Usage: &man.ls.1; is the manual page for <command>ls</" "command>." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4217 msgid "&man.cp.1;" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4218 book.translate.xml:8901 msgid "" "cp1" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4219 msgid "" "Usage: The manual page for <command>cp</command> is " "&man.cp.1;." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4225 msgid "" "&man.command." "sectionnumber;" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4226 msgid "" "link to command manual page in section " "sectionnumber" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4230 msgid "" "Entities are defined for all the FreeBSD manual pages." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4242 msgid "FreeBSD Mailing List Entities" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4247 msgid "&a.doc;" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4248 msgid "" "FreeBSD documentation project mailing list" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4249 msgid "Usage: A link to the &a.doc;." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4254 msgid "&a.questions;" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4255 msgid "" "FreeBSD general questions mailing list" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4256 msgid "Usage: A link to the &a.questions;." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4261 msgid "&a.listname;" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4262 msgid "link to listname" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4264 msgid "" "Entities are defined for all the FreeBSD " "mailing lists." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4275 msgid "FreeBSD Document Link Entities" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4280 msgid "&url.books.handbook;" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4281 msgid "" "@@URL_RELPREFIX@@/doc/en_US.ISO8859-1/books/handbook" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4282 msgid "" "Usage: A link to the <link xlink:href=\"&url.books.handbook;/" "advanced-networking.html\">Advanced Networking</link> chapter of " "the Handbook." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4289 msgid "&url.books.bookname;" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4290 msgid "" "relative path to bookname" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4292 msgid "" "Entities are defined for all the FreeBSD books." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4297 msgid "&url.articles.committers-guide;" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4298 msgid "" "@@URL_RELPREFIX@@/doc/en_US.ISO8859-1/articles/committers-guide" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4299 msgid "" "Usage: A link to the <link xlink:href=\"&url.articles." "committers-guide;\">Committer's Guide</link> article." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4306 msgid "" "&url.articles.articlename;" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4307 msgid "" "relative path to articlename" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4309 msgid "" "Entities are defined for all the FreeBSD articles." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4320 msgid "Other Operating System Name Entities" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4325 msgid "&linux;" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4326 msgid "Linux" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4327 msgid "The Linux operating system." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4331 book.translate.xml:9535 msgid "&unix;" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4332 book.translate.xml:9534 msgid "UNIX" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4333 msgid "The UNIX operating system." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4337 msgid "&windows;" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4338 msgid "Windows" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4339 msgid "" "The Windows operating system." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4349 msgid "Miscellaneous Entities" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4354 msgid "&prompt.root;" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4356 msgid "The root user prompt." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4361 msgid "&prompt.user;" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4363 msgid "A prompt for an unprivileged user." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4367 msgid "&postscript;" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4368 msgid "PostScript" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4369 msgid "" "The PostScript programming " "language." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4374 msgid "&tex;" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4375 msgid "TeX" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4376 msgid "The TeX typesetting language." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4381 msgid "&xorg;" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4382 msgid "Xorg" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:4383 msgid "The Xorg open source X Window System." msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:4393 msgid "Formal Public Identifier (FPI)" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:4395 msgid "" "In compliance with the DocBook guidelines for writing FPIs for DocBook customizations, the FPI for the " "FreeBSD extended DocBook DTD is:" msgstr "" #. (itstool) path: sect1/programlisting #: book.translate.xml:4400 #, no-wrap msgid "PUBLIC \"-//FreeBSD//DTD DocBook V4.2-Based Extension//EN\"" msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:4404 msgid "Document Structure" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:4406 msgid "" "DocBook allows structuring documentation in several ways. The FreeBSD " "Documentation Project uses two primary types of DocBook document: the book " "and the article." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:4410 msgid "" "Books are organized into chapters. This is a mandatory " "requirement. There may be parts between the book and the chapter " "to provide another layer of organization. For example, the Handbook is " "arranged in this way." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:4416 msgid "" "A chapter may (or may not) contain one or more sections. These are indicated " "with the sect1 element. If a section contains another section " "then use the sect2 element, and so on, up to sect5." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:4422 msgid "Chapters and sections contain the remainder of the content." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:4425 msgid "" "An article is simpler than a book, and does not use chapters. Instead, the " "content of an article is organized into one or more sections, using the same " "sect1 (and sect2 and so on) elements that are used in " "books." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:4431 msgid "" "The nature of the document being written should be used to determine whether " "it is best marked up as a book or an article. Articles are well suited to " "information that does not need to be broken down into several chapters, and " "that is, relatively speaking, quite short, at up to 20-25 pages of content. " "Books are best suited to information that can be broken up into several " "chapters, possibly with appendices and similar content as well." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:4440 msgid "" "The FreeBSD tutorials are all marked up as articles, while this document, the FAQ, and the Handbook are all marked up as books, for " "example." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:4447 msgid "Starting a Book" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:4449 msgid "" "The content of a book is contained within the book element. As " "well as containing structural markup, this element can contain elements that " "include additional information about the book. This is either meta-" "information, used for reference purposes, or additional content used to " "produce a title page." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:4456 book.translate.xml:4511 msgid "This additional information is contained within info." msgstr "" #. (itstool) path: example/title #: book.translate.xml:4460 msgid "Boilerplate book with info" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:4466 #, no-wrap msgid "" "book\n" " info\n" " titleYour Title Heretitle\n" "\n" " author\n" " personname\n" " firstnameYour first namefirstname\n" " surnameYour surnamesurname\n" " personname\n" "\n" " affiliation\n" " address\n" " emailYour email " "addressemail\n" " address\n" " affiliation\n" " author\n" "\n" " copyright\n" " year1998year\n" " holder role=\"mailto:your email " "address\"Your nameholder\n" " copyright\n" "\n" " releaseinfo$FreeBSD$releaseinfo\n" "\n" " abstract\n" " paraInclude an abstract of " "the book's contents here.para\n" " abstract\n" " info\n" "\n" " …\n" "\n" "book" msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:4502 msgid "Starting an Article" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:4504 msgid "" "The content of the article is contained within the article " "element. As well as containing structural markup, this element can contain " "elements that include additional information about the article. This is " "either meta-information, used for reference purposes, or additional content " "used to produce a title page." msgstr "" #. (itstool) path: example/title #: book.translate.xml:4515 msgid "Boilerplate article with info" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:4521 #, no-wrap msgid "" "article\n" " info\n" " titleYour title heretitle\n" "\n" " author\n" " personname\n" " firstnameYour first namefirstname\n" " surnameYour surnamesurname\n" " personname\n" "\n" " affiliation\n" " address\n" " emailYour email addressemailaddress\n" " address\n" " affiliation\n" " author\n" "\n" " copyright\n" " year1998year\n" " holder role=\"mailto:your email " "address\"Your nameholder\n" " copyright\n" "\n" " releaseinfo$FreeBSD$releaseinfo\n" "\n" " abstract\n" " paraInclude an abstract of " "the article's contents here.para\n" " abstract\n" " info\n" "\n" " …\n" "\n" "article" msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:4557 msgid "Indicating Chapters" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:4559 msgid "" "Use chapter to mark up your chapters. Each chapter has a " "mandatory title. Articles do not contain chapters, they are " "reserved for books." msgstr "" #. (itstool) path: example/title #: book.translate.xml:4565 msgid "A Simple Chapter" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:4567 #, no-wrap msgid "" "chapter\n" " titleThe Chapter's Titletitle\n" "\n" " ...\n" "chapter" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:4574 msgid "" "A chapter cannot be empty; it must contain elements in addition to " "title. If you need to include an empty chapter then just use an " "empty paragraph." msgstr "" #. (itstool) path: example/title #: book.translate.xml:4580 msgid "Empty Chapters" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:4582 #, no-wrap msgid "" "chapter\n" " titleThis is An Empty Chaptertitle\n" "\n" " parapara\n" "chapter" msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:4591 msgid "Sections Below Chapters" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:4593 msgid "" "In books, chapters may (but do not need to) be broken up into sections, " "subsections, and so on. In articles, sections are the main structural " "element, and each article must contain at least one section. Use the " "sectn element. The n indicates the section number, which identifies the section " "level." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:4601 msgid "" "The first sectn is sect1. " "You can have one or more of these in a chapter. They can contain one or more " "sect2 elements, and so on, down to sect5." msgstr "" #. (itstool) path: example/title #: book.translate.xml:4609 msgid "Sections in Chapters" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:4611 #, no-wrap msgid "" "chapter\n" " titleA Sample Chaptertitle\n" "\n" " paraSome text in the chapter.para\n" "\n" " sect1\n" " titleFirst Sectiontitle\n" "\n" " …\n" " sect1\n" "\n" " sect1\n" " titleSecond Sectiontitle\n" "\n" " sect2\n" " titleFirst Sub-Sectiontitle\n" "\n" " sect3\n" " titleFirst Sub-Sub-Sectiontitle\n" "\n" " …\n" " sect3\n" " sect2\n" "\n" " sect2\n" " titleSecond Sub-Section (1.2.2)title\n" "\n" " …\n" " sect2\n" " sect1\n" "chapter" msgstr "" #. (itstool) path: note/para #: book.translate.xml:4645 msgid "" "Section numbers are automatically generated and prepended to titles when the " "document is rendered to an output format. The generated section numbers and " "titles from the example above will be:" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:4652 msgid "1.1. First Section" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:4656 msgid "1.2. Second Section" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:4660 msgid "1.2.1. First Sub-Section" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:4664 msgid "1.2.1.1. First Sub-Sub-Section" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:4668 msgid "1.2.2. Second Sub-Section" msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:4675 msgid "Subdividing Using part Elements" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:4678 msgid "" "parts introduce another level of organization between book and chapter with one or more parts. This cannot " "be done in an article." msgstr "" #. (itstool) path: sect2/programlisting #: book.translate.xml:4684 #, no-wrap msgid "" "part\n" " titleIntroductiontitle\n" "\n" " chapter\n" " titleOverviewtitle\n" "\n" " ...\n" " chapter\n" "\n" " chapter\n" " titleWhat is FreeBSD?title\n" "\n" " ...\n" " chapter\n" "\n" " chapter\n" " titleHistorytitle\n" "\n" " ...\n" " chapter\n" "part" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:4714 msgid "" "DocBook supports three types of paragraphs: formalpara, " "para, and simpara." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:4718 msgid "" "Almost all paragraphs in FreeBSD documentation use para. " "formalpara includes a title element, and simpara disallows some elements from within para. Stick with " "para." msgstr "" #. (itstool) path: example/title #: book.translate.xml:4726 msgid "para Example" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:4730 #, no-wrap msgid "" "paraThis is a paragraph. It can contain just " "about any\n" " other element.para" msgstr "" #. (itstool) path: example/para #. (itstool) path: sect2/para #: book.translate.xml:4733 book.translate.xml:4771 book.translate.xml:4848 #: book.translate.xml:4879 book.translate.xml:4938 book.translate.xml:5000 #: book.translate.xml:5075 book.translate.xml:5151 book.translate.xml:5210 #: book.translate.xml:5294 book.translate.xml:5335 book.translate.xml:5444 #: book.translate.xml:5496 book.translate.xml:5525 book.translate.xml:5553 #: book.translate.xml:5601 book.translate.xml:5713 book.translate.xml:5763 #: book.translate.xml:5810 book.translate.xml:5947 book.translate.xml:5995 #: book.translate.xml:6024 book.translate.xml:6045 book.translate.xml:6097 #: book.translate.xml:6143 book.translate.xml:6173 book.translate.xml:6196 #: book.translate.xml:6226 book.translate.xml:6248 book.translate.xml:6700 #: book.translate.xml:6714 book.translate.xml:6729 book.translate.xml:6747 msgid "Appearance:" msgstr "" #. (itstool) path: example/para #: book.translate.xml:4735 msgid "This is a paragraph. It can contain just about any other element." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:4743 msgid "" "A block quotation is an extended quotation from another document that should " "not appear within the current paragraph. These are rarely needed." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:4747 msgid "" "Blockquotes can optionally contain a title and an attribution (or they can " "be left untitled and unattributed)." msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:4756 #, no-wrap msgid "" "paraA small excerpt from the US Constitution:" "para\n" "\n" "blockquote\n" " titlePreamble to the Constitution of the " "United Statestitle\n" "\n" " attributionCopied from a web site " "somewhereattribution\n" "\n" " paraWe the People of the United States, in " "Order to form a more\n" " perfect Union, establish Justice, insure domestic Tranquility,\n" " provide for the common defence, promote the general Welfare, and\n" " secure the Blessings of Liberty to ourselves and our Posterity, do\n" " ordain and establish this Constitution for the United States of\n" " America.para\n" "blockquote" msgstr "" #. (itstool) path: example/para #: book.translate.xml:4773 msgid "A small excerpt from the US Constitution:" msgstr "" #. (itstool) path: blockquote/title #: book.translate.xml:4776 msgid "Preamble to the Constitution of the United States" msgstr "" #. (itstool) path: blockquote/attribution #: book.translate.xml:4779 msgid "Copied from a web site somewhere" msgstr "" #. (itstool) path: blockquote/para #: book.translate.xml:4782 msgid "" "We the People of the United States, in Order to form a more perfect Union, " "establish Justice, insure domestic Tranquility, provide for the common " "defence, promote the general Welfare, and secure the Blessings of Liberty to " "ourselves and our Posterity, do ordain and establish this Constitution for " "the United States of America." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:4794 msgid "Tips, Notes, Warnings, Cautions, and Important Information" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:4797 msgid "" "Extra information may need to be separated from the main body of the text. " "Typically this is meta information of which the user should " "be aware." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:4802 msgid "" "Several types of admonitions are available: tip, note, " "warning, caution, and important." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:4807 msgid "" "Which admonition to choose depends on the situation. The DocBook " "documentation suggests:" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:4813 msgid "Note is for information that should be heeded by all readers." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:4818 msgid "Important is a variation on Note." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:4822 msgid "" "Caution is for information regarding possible data loss or software damage." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:4827 msgid "" "Warning is for information regarding possible hardware damage or injury to " "life or limb." msgstr "" #. (itstool) path: example/title #: book.translate.xml:4833 msgid "tip and important Example" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:4837 #, no-wrap msgid "" "tip\n" " para&os; may reduce stress.para\n" "tip\n" "\n" "important\n" " paraPlease use admonitions sparingly. Too " "many admonitions\n" " are visually jarring and can have the opposite of the\n" " intended effect.para\n" "important" msgstr "" #. (itstool) path: tip/para #: book.translate.xml:4851 msgid "FreeBSD may reduce stress." msgstr "" #. (itstool) path: important/para #: book.translate.xml:4855 msgid "" "Please use admonitions sparingly. Too many admonitions are visually jarring " "and can have the opposite of the intended effect." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:4864 msgid "Examples can be shown with example." msgstr "" #. (itstool) path: example/title #: book.translate.xml:4867 msgid "example Source" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:4871 #, no-wrap msgid "" "example\n" " paraEmpty files can be created easily:para\n" "\n" " screen&prompt.user; userinputtouch file1 file2 file3userinputscreen\n" "example" msgstr "" #. (itstool) path: example/title #: book.translate.xml:4882 msgid "Rendered example" msgstr "" #. (itstool) path: example/para #: book.translate.xml:4884 msgid "Empty files can be created easily:" msgstr "" #. (itstool) path: example/screen #: book.translate.xml:4886 #, no-wrap msgid "% touch file1 file2 file3" msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:4891 msgid "Lists and Procedures" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:4893 msgid "" "Information often needs to be presented as lists, or as a number of steps " "that must be carried out in order to accomplish a particular goal." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:4897 msgid "" "To do this, use itemizedlist, orderedlist, " "variablelist, or procedure. There are other types of " "list elements in DocBook, but we will not cover them here." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:4902 msgid "" "itemizedlist and orderedlist are similar to their " "counterparts in HTML, ul and ol. " "Each one consists of one or more listitem elements, and each " "listitem contains one or more block elements. The listitem elements are analogous to HTML's li tags. " "However, unlike HTML, they are required." msgstr "" #. (itstool) path: example/title #: book.translate.xml:4913 msgid "itemizedlist and orderedlist Example" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:4918 #, no-wrap msgid "" "itemizedlist\n" " listitem\n" " paraThis is the first itemized item.para\n" " listitem\n" "\n" " listitem\n" " paraThis is the second itemized item.para\n" " listitem\n" "itemizedlist\n" "\n" "orderedlist\n" " listitem\n" " paraThis is the first ordered item.para\n" " listitem\n" "\n" " listitem\n" " paraThis is the second ordered item.para\n" " listitem\n" "orderedlist" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:4942 msgid "This is the first itemized item." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:4946 msgid "This is the second itemized item." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:4952 msgid "This is the first ordered item." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:4956 msgid "This is the second ordered item." msgstr "" #. (itstool) path: sect2/para #. (itstool) id: book.translate.xml#docbook-markup-varlist #: book.translate.xml:4961 msgid "" "An alternate and often useful way of presenting information is the " "variablelist. These are lists where each entry has a term and a " "description. They are well suited for many types of descriptions, and " "present information in a form that is often easier for the reader than " "sections and subsections." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:4969 msgid "" "A variablelist has a title, and then pairs of " "term and listitem entries." msgstr "" #. (itstool) path: example/title #: book.translate.xml:4974 msgid "variablelist Example" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:4978 #, no-wrap msgid "" "variablelist\n" " varlistentry\n" " termParallelterm\n" "\n" " listitem\n" " paraIn parallel communications, groups " "of bits arrive\n" " at the same time over multiple communications\n" " channels.para\n" " listitem\n" " varlistentry\n" "\n" " varlistentry\n" " termSerialterm\n" "\n" " listitem\n" " paraIn serial communications, bits " "arrive one at a\n" " time over a single communications\n" " channel.para\n" " listitem\n" " varlistentry\n" "variablelist" msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:5004 msgid "Parallel" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:5007 msgid "" "In parallel communications, groups of bits arrive at the same time over " "multiple communications channels." msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:5014 msgid "Serial" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:5017 msgid "" "In serial communications, bits arrive one at a time over a single " "communications channel." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:5024 msgid "" "A procedure shows a series of steps, which may in turn " "consist of more steps or substeps. Each step contains block elements and may include an optional title." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:5029 msgid "" "Sometimes, steps are not sequential, but present a choice: do " "this or do that, but not both. For " "these alternative choices, use stepalternatives." msgstr "" #. (itstool) path: example/title #: book.translate.xml:5035 msgid "procedure Example" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:5039 #, no-wrap msgid "" "procedure\n" " step\n" " paraDo this.para\n" " step\n" "\n" " step\n" " paraThen do this.para\n" " step\n" "\n" " step\n" " substeps\n" " step\n" " paraAnd now do this smaller thing.para\n" " step\n" "\n" " step\n" " paraAnd now do this other smaller " "thing.para\n" " step\n" " substeps\n" " step\n" "\n" " step\n" " paraFinally, do one of these:para\n" "\n" " stepalternatives\n" " step\n" " paraGo left.para\n" " step\n" "\n" " step\n" " paraGo right.para\n" " step\n" " stepalternatives\n" " step\n" "procedure" msgstr "" #. (itstool) path: step/para #: book.translate.xml:5079 msgid "Do this." msgstr "" #. (itstool) path: step/para #: book.translate.xml:5083 msgid "Then do this." msgstr "" #. (itstool) path: step/para #: book.translate.xml:5089 msgid "And now do this small thing." msgstr "" #. (itstool) path: step/para #: book.translate.xml:5093 msgid "And this other small thing." msgstr "" #. (itstool) path: step/para #: book.translate.xml:5099 msgid "Finally, do one of these:" msgstr "" #. (itstool) path: step/para #: book.translate.xml:5103 msgid "Go left." msgstr "" #. (itstool) path: step/para #: book.translate.xml:5107 msgid "Go right." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:5116 msgid "Showing File Samples" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:5118 msgid "" "Fragments of a file (or perhaps a complete file) are shown by wrapping them " "in the programlisting element." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:5122 msgid "" "White space and line breaks within programlisting are significant. In particular, this means that the opening tag should " "appear on the same line as the first line of the output, and the closing tag " "should appear on the same line as the last line of the output, otherwise " "spurious blank lines may be included." msgstr "" #. (itstool) path: example/title #: book.translate.xml:5131 msgid "programlisting Example" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:5135 #, no-wrap msgid "" "paraWhen finished, the program will look like\n" " this:para\n" "\n" "programlisting#include &lt;stdio.h&gt;\n" "\n" "int\n" "main(void)\n" "{\n" " printf(\"hello, world\\n\");\n" " return 0;\n" "}programlisting" msgstr "" #. (itstool) path: example/para #: book.translate.xml:5147 msgid "" "Notice how the angle brackets in the #include line need " "to be referenced by their entities instead of being included literally." msgstr "" #. (itstool) path: example/para #: book.translate.xml:5153 book.translate.xml:5212 msgid "When finished, the program will look like this:" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:5155 #, no-wrap msgid "" "#include <stdio.h>\n" "\n" "int\n" "main(void)\n" "{\n" " printf(\"hello, world\\n\");\n" " return 0;\n" "}" msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:5167 msgid "Callouts" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:5169 msgid "" "A callout is a visual marker for referring to a piece of text or specific " "position within an example." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:5173 msgid "" "Callouts are marked with the co element. Each element must have a " "unique id assigned to it. After the example, include a " "calloutlist that describes each callout." msgstr "" #. (itstool) path: example/title #: book.translate.xml:5180 msgid "co and calloutlist Example" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:5183 #, no-wrap msgid "" "paraWhen finished, the program will look like\n" " this:para\n" "\n" "programlisting#include &lt;stdio.h&gt; " "co xml:id=\"co-ex-include\"\n" "\n" "int co xml:id=\"co-ex-return\"\n" "main(void)\n" "{\n" " printf(\"hello, world\\n\"); co xml:id=\"co-ex-" "printf\"\n" "}programlisting\n" "\n" "calloutlist\n" " callout arearefs=\"co-ex-include\"\n" " paraIncludes the standard IO header file." "para\n" " callout\n" "\n" " callout arearefs=\"co-ex-return\"\n" " paraSpecifies that functionmain()function " "returns an\n" " int.para\n" " callout\n" "\n" " callout arearefs=\"co-ex-printf\"\n" " paraThe functionprintf()function call that writes\n" " literalhello, worldliteral to standard output.para\n" " callout\n" "calloutlist" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:5214 #, no-wrap msgid "" "#include <stdio.h> \n" "\n" "int \n" "main(void)\n" "{\n" " printf(\"hello, world\\n\"); \n" "}" msgstr "" #. (itstool) path: callout/para #: book.translate.xml:5224 msgid "Includes the standard IO header file." msgstr "" #. (itstool) path: callout/para #: book.translate.xml:5228 msgid "Specifies that main() returns an int." msgstr "" #. (itstool) path: callout/para #: book.translate.xml:5233 msgid "" "The printf() call that writes hello, world to standard output." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:5244 msgid "" "Unlike HTML, DocBook does not need tables for layout " "purposes, as the stylesheet handles those issues. Instead, just use tables " "for marking up tabular data." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:5249 msgid "" "In general terms (and see the DocBook documentation for more detail) a table " "(which can be either formal or informal) consists of a table " "element. This contains at least one tgroup element, which " "specifies (as an attribute) the number of columns in this table group. " "Within the tablegroup there is one thead element, which contains " "elements for the table headings (column headings), and one tbody " "which contains the body of the table." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:5260 msgid "" "Both tgroup and thead contain row elements, " "which in turn contain entry elements. Each entry " "element specifies one cell in the table." msgstr "" #. (itstool) path: example/title #: book.translate.xml:5267 msgid "informaltable Example" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:5271 #, no-wrap msgid "" "informaltable pgwide=\"1\"\n" " tgroup cols=\"2\"\n" " thead\n" " row\n" " entryThis is Column Head 1entry\n" " entryThis is Column Head 2entry\n" " row\n" " thead\n" "\n" " tbody\n" " row\n" " entryRow 1, column 1entry\n" " entryRow 1, column 2entry\n" " row\n" "\n" " row\n" " entryRow 2, column 1entry\n" " entryRow 2, column 2entry\n" " row\n" " tbody\n" " tgroup\n" "informaltable" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:5300 book.translate.xml:5341 msgid "This is Column Head 1" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:5301 book.translate.xml:5342 msgid "This is Column Head 2" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:5307 book.translate.xml:5348 msgid "Row 1, column 1" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:5308 book.translate.xml:5349 msgid "Row 1, column 2" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:5312 book.translate.xml:5353 msgid "Row 2, column 1" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:5313 book.translate.xml:5354 msgid "Row 2, column 2" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:5320 msgid "" "Always use the pgwide attribute with a value of " "1 with the informaltable element. A bug in " "Internet Explorer can cause the table to render incorrectly if this is " "omitted." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:5326 msgid "" "Table borders can be suppressed by setting the frame " "attribute to none in the informaltable element." " For example, informaltable frame=\"none\"." msgstr "" #. (itstool) path: example/title #: book.translate.xml:5332 msgid "Table with frame=\"none\" Example" msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:5363 msgid "Examples for the User to Follow" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:5365 msgid "" "Examples for the user to follow are often necessary. Typically, these will " "consist of dialogs with the computer; the user types in a command, the user " "gets a response back, the user types another command, and so on." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:5370 msgid "A number of distinct elements and entities come into play here." msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:5375 msgid "screen" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:5378 msgid "" "Everything the user sees in this example will be on the computer screen, so " "the next element is screen." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:5382 msgid "Within screen, white space is significant." msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:5388 msgid "" "prompt, &prompt.root; and " "&prompt.user;" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:5393 msgid "" "Some of the things the user will be seeing on the screen are prompts from " "the computer (either from the operating system, command shell, or " "application). These should be marked up using prompt." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:5399 msgid "" "As a special case, the two shell prompts for the normal user and the root " "user have been provided as entities. To indicate the user is at a shell " "prompt, use one of &prompt.root; and " "&prompt.user; as necessary. They do not need to be " "inside prompt." msgstr "" #. (itstool) path: note/para #: book.translate.xml:5408 msgid "" "&prompt.root; and &prompt.user; are FreeBSD extensions to DocBook, and are not part of the original " "DTD." msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:5417 msgid "userinput" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:5420 msgid "" "When displaying text that the user should type in, wrap it in " "userinput tags. It will be displayed differently than system " "output text." msgstr "" #. (itstool) path: example/title #: book.translate.xml:5428 msgid "screen, prompt, and userinput Example" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:5433 #, no-wrap msgid "" "screen&prompt.user; userinputls -1userinput\n" "foo1\n" "foo2\n" "foo3\n" "&prompt.user; userinputls -1 | grep " "foo2userinput\n" "foo2\n" "&prompt.user; userinputsuuserinput\n" "promptPassword: prompt\n" "&prompt.root; userinputcat foo2userinput\n" "This is the file called 'foo2'screen" msgstr "" #. (itstool) path: example/screen #: book.translate.xml:5446 #, no-wrap msgid "" "% ls -1\n" "foo1\n" "foo2\n" "foo3\n" "% ls -1 | grep foo2\n" "foo2\n" "% su\n" "Password: \n" "# cat foo2\n" "This is the file called 'foo2'" msgstr "" #. (itstool) path: note/para #: book.translate.xml:5459 msgid "" "Even though we are displaying the contents of the file foo2, it is not marked up as programlisting. Reserve programlisting for showing fragments of files " "outside the context of user actions." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:5474 msgid "" "To emphasize a particular word or phrase, use emphasis. This may " "be presented as italic, or bold, or might be spoken differently with a text-" "to-speech system." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:5479 msgid "" "There is no way to change the presentation of the emphasis within the " "document, no equivalent of HTML's b and " "i. If the information being presented is important, then consider " "presenting it in important rather than emphasis." msgstr "" #. (itstool) path: example/title #: book.translate.xml:5488 msgid "emphasis Example" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:5492 #, no-wrap msgid "" "para&os; is without doubt emphasistheemphasis\n" " premiere &unix;-like operating system for the Intel\n" " architecture.para" msgstr "" #. (itstool) path: example/para #: book.translate.xml:5498 msgid "" "FreeBSD is without doubt the premiere UNIX-like operating system for the Intel " "architecture." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:5505 book.translate.xml:9231 msgid "Acronyms" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:5507 msgid "" "Many computer terms are acronyms, words formed from the " "first letter of each word in a phrase. Acronyms are marked up into " "acronym elements. It is helpful to the reader when an acronym is " "defined on the first use, as shown in the example below." msgstr "" #. (itstool) path: example/title #: book.translate.xml:5515 msgid "acronym Example" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:5519 #, no-wrap msgid "" "paraRequest For Comments (acronymRFCacronym) 1149\n" " defined the use of avian carriers for transmission of\n" " Internet Protocol (acronymIPacronym) data. The\n" " quantity of acronymIPacronym data currently\n" " transmitted in that manner is unknown.para" msgstr "" #. (itstool) path: example/para #: book.translate.xml:5527 msgid "" "Request For Comments (RFC) 1149 defined the use of avian " "carriers for transmission of Internet Protocol (IP) data. " "The quantity of IP data currently transmitted in that " "manner is unknown." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:5536 msgid "Quotations" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:5538 msgid "" "To quote text from another document or source, or to denote a phrase that is " "used figuratively, use quote. Most of the markup tags available " "for normal text are also available from within a quote." msgstr "" #. (itstool) path: example/title #: book.translate.xml:5545 msgid "quote Example" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:5549 #, no-wrap msgid "" "paraHowever, make sure that the search does " "not go beyond the\n" " quoteboundary between local and public " "administrationquote,\n" " as acronymRFCacronym 1535 calls it.para" msgstr "" #. (itstool) path: example/para #: book.translate.xml:5555 msgid "" "However, make sure that the search does not go beyond the boundary " "between local and public administration, as RFC " "1535 calls it." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:5563 msgid "Keys, Mouse Buttons, and Combinations" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:5565 msgid "" "To refer to a specific key on the keyboard, use keycap. To refer " "to a mouse button, use mousebutton. And to refer to combinations " "of key presses or mouse clicks, wrap them all in keycombo." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:5571 msgid "" "keycombo has an attribute called action, which " "may be one of click, double-click, " "other, press, seq, " "or simul. The last two values denote whether the keys or " "buttons should be pressed in sequence, or simultaneously." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:5579 msgid "" "The stylesheets automatically add any connecting symbols, such as " "+, between the key names, when wrapped in keycombo." msgstr "" #. (itstool) path: example/title #: book.translate.xml:5584 msgid "Keys, Mouse Buttons, and Combinations Example" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:5588 #, no-wrap msgid "" "paraTo switch to the second virtual terminal, " "press\n" " keycombo action=\"simul\"keycapAltkeycap\n" " keycapF1keycapkeycombo.para\n" "\n" "paraTo exit commandvicommand without saving changes, type\n" " keycombo action=\"seq\"keycapEsckeycapkeycap:keycap\n" " keycapqkeycapkeycap!keycapkeycombo.para\n" "\n" "paraMy window manager is configured so that\n" " keycombo action=\"simul\"keycapAltkeycap\n" " mousebuttonrightmousebutton\n" " keycombo mouse button is used to move windows." "para" msgstr "" #. (itstool) path: example/para #: book.translate.xml:5603 msgid "" "To switch to the second virtual terminal, press Alt F1." msgstr "" #. (itstool) path: example/para #: book.translate.xml:5607 msgid "" "To exit vi without saving changes, type Esc : q " "!." msgstr "" #. (itstool) path: example/para #: book.translate.xml:5614 msgid "" "My window manager is configured so that " "Alt right mouse " "button is used to move windows." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:5623 msgid "Applications, Commands, Options, and Cites" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:5625 msgid "" "Both applications and commands are frequently referred to when writing " "documentation. The distinction between them is that an application is the " "name of a program or suite of programs that fulfill a particular task. A " "command is the filename of a program that the user can type and run at a " "command line." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:5632 msgid "" "It is often necessary to show some of the options that a command might take." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:5635 msgid "" "Finally, it is often useful to list a command with its manual section " "number, in the command(number) format so common in Unix " "manuals." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:5639 msgid "Mark up application names with application." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:5642 msgid "" "To list a command with its manual section number (which should be most of " "the time) the DocBook element is citerefentry. This will contain " "a further two elements, refentrytitle and manvolnum. " "The content of refentrytitle is the name of the command, and the " "content of manvolnum is the manual page section." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:5652 msgid "" "This can be cumbersome to write, and so a series of general entities have been created to make " "this easier. Each entity takes the form &man." "manual-page.manual-section;." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:5658 msgid "" "The file that contains these entities is in doc/share/xml/man-refs." "ent, and can be referred to using this FPI:" msgstr "" #. (itstool) path: sect2/programlisting #: book.translate.xml:5662 #, no-wrap msgid "PUBLIC \"-//FreeBSD//ENTITIES DocBook Manual Page Entities//EN\"" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:5664 msgid "" "Therefore, the introduction to FreeBSD documentation will usually include " "this:" msgstr "" #. (itstool) path: sect2/programlisting #: book.translate.xml:5667 #, no-wrap msgid "" "<!DOCTYPE book PUBLIC \"-//FreeBSD//DTD DocBook V4.1-Based Extension//" "EN\" [\n" "\n" "<!ENTITY % man PUBLIC \"-//FreeBSD//ENTITIES DocBook Manual Page Entities/" "/EN\">\n" "%man;\n" "\n" "…\n" "\n" "]>" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:5676 msgid "" "Use command to include a command name in-line but " "present it as something the user should type." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:5680 msgid "" "Use option to mark up the options which will be passed to a " "command." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:5683 msgid "" "When referring to the same command multiple times in close proximity, it is " "preferred to use the &man.command." "section; notation to markup the first " "reference and use command to markup subsequent references. This " "makes the generated output, especially HTML, appear " "visually better." msgstr "" #. (itstool) path: example/title #: book.translate.xml:5692 msgid "Applications, Commands, and Options Example" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:5696 #, no-wrap msgid "" "paraapplicationSendmailapplication is the most\n" " widely used Unix mail application.para\n" "\n" "paraapplicationSendmailapplication includes the\n" " citerefentry\n" " refentrytitlesendmailrefentrytitle\n" " manvolnum8manvolnum\n" " citerefentry, &man.mailq.1;, and &man." "newaliases.1;\n" " programs.para\n" "\n" "paraOne of the command line parameters to citerefentry\n" " refentrytitlesendmailrefentrytitle\n" " manvolnum8manvolnum\n" " citerefentry, option-bpoption, will display the current\n" " status of messages in the mail queue. Check this on the command\n" " line by running commandsendmail -bpcommand.para" msgstr "" #. (itstool) path: example/para #: book.translate.xml:5715 msgid "" "Sendmail is the most widely used Unix mail " "application." msgstr "" #. (itstool) path: example/para #: book.translate.xml:5718 msgid "" "Sendmail includes the " "sendmail 8 , mailq1, and " "newaliases1 programs." msgstr "" #. (itstool) path: example/para #: book.translate.xml:5725 msgid "" "One of the command line parameters to " "sendmail 8 , , will display the current status of " "messages in the mail queue. Check this on the command line by running " "sendmail -bp." msgstr "" #. (itstool) path: note/para #: book.translate.xml:5736 msgid "" "Notice how the &man.command." "section; notation is easier to follow." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:5743 msgid "Files, Directories, Extensions, Device Names" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:5745 msgid "" "To refer to the name of a file, a directory, a file extension, or a device " "name, use filename." msgstr "" #. (itstool) path: example/title #: book.translate.xml:5749 msgid "filename Example" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:5753 #, no-wrap msgid "" "paraThe source for the Handbook in English is " "found in\n" " filename/usr/doc/en_US.ISO8859-1/books/" "handbook/filename.\n" " The main file is called filenamebook.xmlfilename.\n" " There is also a filenameMakefilefilename and a\n" " number of files with a filename.entfilename extension.para\n" "\n" "parafilenamekbd0filename is the first keyboard detected\n" " by the system, and appears in\n" " filename/devfilename.para" msgstr "" #. (itstool) path: example/para #: book.translate.xml:5765 msgid "" "The source for the Handbook in English is found in /usr/doc/en_US." "ISO8859-1/books/handbook/. The main file is called book." "xml. There is also a Makefile and a number " "of files with a .ent extension." msgstr "" #. (itstool) path: example/para #: book.translate.xml:5771 msgid "" "kbd0 is the first keyboard detected by the system, and " "appears in /dev." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:5778 msgid "The Name of Ports" msgstr "" #. (itstool) path: note/title #: book.translate.xml:5781 book.translate.xml:5825 book.translate.xml:6057 msgid "FreeBSD Extension" msgstr "" #. (itstool) path: note/para #: book.translate.xml:5783 book.translate.xml:5827 book.translate.xml:6059 msgid "" "These elements are part of the FreeBSD extension to DocBook, and do not " "exist in the original DocBook DTD." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:5788 msgid "" "To include the name of a program from the FreeBSD Ports Collection in the " "document, use the package tag. Since the Ports Collection can be " "installed in any number of locations, only include the category and the port " "name; do not include /usr/ports." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:5794 msgid "" "By default, package refers to a binary package. To refer to a " "port that will be built from source, set the role " "attribute to port." msgstr "" #. (itstool) path: example/title #: book.translate.xml:5800 msgid "package Example" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:5804 #, no-wrap msgid "" "paraInstall the packagenet/wiresharkpackage " "binary\n" " package to view network traffic.para\n" "\n" "parapackage role=" "\"port\"net/wiresharkpackage can also be\n" " built and installed from the Ports Collection.para" msgstr "" #. (itstool) path: example/para #: book.translate.xml:5812 msgid "" "Install the net/wireshark binary package to view network " "traffic." msgstr "" #. (itstool) path: example/para #: book.translate.xml:5815 msgid "" "net/wireshark can also be built and " "installed from the Ports Collection." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:5821 msgid "" "Hosts, Domains, IP Addresses, User Names, Group Names, and Other System " "Items" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:5832 msgid "" "Information for system items is marked up with " "systemitem. The class attribute is used to " "identify the particular type of information shown." msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:5839 msgid "class=\"domainname\"" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:5842 msgid "" "The text is a domain name, such as FreeBSD.org or " "ngo.org.uk. There is no hostname component." msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:5850 msgid "class=\"etheraddress\"" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:5853 msgid "" "The text is an Ethernet MAC address, expressed as a " "series of 2 digit hexadecimal numbers separated by colons." msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:5860 msgid "class=\"fqdomainname\"" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:5863 msgid "" "The text is a Fully Qualified Domain Name, with both hostname and domain " "name parts." msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:5869 msgid "class=\"ipaddress\"" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:5872 msgid "" "The text is an IP address, probably expressed as a dotted " "quad." msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:5878 msgid "class=\"netmask\"" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:5881 msgid "" "The text is a network mask, which might be expressed as a dotted quad, a " "hexadecimal string, or as a / followed by a number " "(CIDR notation)." msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:5889 msgid "class=\"systemname\"" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:5892 msgid "" "With class=\"systemname\" the marked up information is " "the simple hostname, such as freefall or " "wcarchive." msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:5900 msgid "class=\"username\"" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:5903 msgid "The text is a username, like root." msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:5909 msgid "class=\"groupname\"" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:5912 msgid "The text is a groupname, like wheel." msgstr "" #. (itstool) path: example/title #: book.translate.xml:5919 msgid "systemitem and Classes Example" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:5923 #, no-wrap msgid "" "paraThe local machine can always be referred " "to by the\n" " name systemitem class=\"systemname\"localhostsystemitem, which will have the IP\n" " address systemitem class=\"ipaddress\"127.0." "0.1systemitem.para\n" "\n" "paraThe systemitem " "class=\"domainname\"FreeBSD.orgsystemitem\n" " domain contains a number of different hosts, including\n" " systemitem class=\"fqdomainname\"freefall." "FreeBSD.orgsystemitem and\n" " systemitem class=\"fqdomainname\"bento." "FreeBSD.orgsystemitem.para\n" "\n" "paraWhen adding an acronymIPacronym alias to an\n" " interface (using commandifconfigcommand)\n" " emphasisalwaysemphasis use a netmask of\n" " systemitem class=\"netmask\"255.255.255." "255systemitem (which can\n" " also be expressed as\n" " systemitem class=\"netmask\"0xffffffffsystemitem).para\n" "\n" "paraThe acronymMACacronym address uniquely identifies\n" " every network card in existence. A typical\n" " acronymMACacronym address looks like\n" " systemitem class=\"etheraddress\"08:00:20:87:" "ef:d0systemitem.para\n" "\n" "paraTo carry out most system administration " "functions\n" " requires logging in as systemitem class=" "\"username\"rootsystemitem.para" msgstr "" #. (itstool) path: example/para #: book.translate.xml:5949 msgid "" "The local machine can always be referred to by the name " "localhost, which will have the IP address " "127.0.0.1." msgstr "" #. (itstool) path: example/para #: book.translate.xml:5954 msgid "" "The FreeBSD.org domain " "contains a number of different hosts, including freefall.FreeBSD.org and bento.FreeBSD.org." msgstr "" #. (itstool) path: example/para #: book.translate.xml:5960 msgid "" "When adding an IP alias to an interface (using " "ifconfig) always use a netmask of " "255.255.255.255 (which can also " "be expressed as 0xffffffff)." msgstr "" #. (itstool) path: example/para #: book.translate.xml:5967 msgid "" "The MAC address uniquely identifies every network card in " "existence. A typical MAC address looks like 08:00:20:87:ef:d0." msgstr "" #. (itstool) path: example/para #: book.translate.xml:5971 msgid "" "To carry out most system administration functions requires logging in as " "root." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:5978 msgid "Uniform Resource Identifiers (URIs)" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:5981 msgid "" "Occasionally it is useful to show a Uniform Resource Identifier " "(URI) without making it an active hyperlink. The " "uri element makes this possible:" msgstr "" #. (itstool) path: example/title #: book.translate.xml:5987 msgid "uri Example" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:5991 #, no-wrap msgid "" "paraThis URL shows only as " "text:\n" " urihttps://www.FreeBSD.orguri. It does not\n" " create a link.para" msgstr "" #. (itstool) path: example/para #: book.translate.xml:5997 msgid "" "This URL shows only as text: https://www.FreeBSD." "org. It does not create a link." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:6002 msgid "To create links, see ." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:6007 msgid "Email Addresses" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:6009 msgid "" "Email addresses are marked up as email elements. In the " "HTML output format, the wrapped text becomes a hyperlink " "to the email address. Other output formats that support hyperlinks may also " "make the email address into a link." msgstr "" #. (itstool) path: example/title #: book.translate.xml:6016 msgid "email with a Hyperlink Example" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:6020 #, no-wrap msgid "" "paraAn email address that does not actually " "exist, like\n" " emailnotreal@example.comemail, can be used as an\n" " example.para" msgstr "" #. (itstool) path: example/para #: book.translate.xml:6026 msgid "" "An email address that does not actually exist, like notreal@example." "com, can be used as an example." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:6031 msgid "" "A FreeBSD-specific extension allows setting the role " "attribute to nolink to prevent the creation of the " "hyperlink to the email address." msgstr "" #. (itstool) path: example/title #: book.translate.xml:6037 msgid "email Without a Hyperlink Example" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:6041 #, no-wrap msgid "" "paraSometimes a link to an email address like\n" " email role=\"nolink\"notreal@example.comemail is not\n" " desired.para" msgstr "" #. (itstool) path: example/para #: book.translate.xml:6047 msgid "" "Sometimes a link to an email address like notreal@example.com is not desired." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:6054 msgid "Describing Makefiles" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:6064 msgid "" "Two elements exist to describe parts of Makefiles, " "buildtarget and varname." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:6068 msgid "" "buildtarget identifies a build target exported by a " "Makefile that can be given as a parameter to " "make. varname identifies a variable that can " "be set (in the environment, on the command line with make, or within the Makefile) to influence the " "process." msgstr "" #. (itstool) path: example/title #: book.translate.xml:6078 msgid "buildtarget and varname Example" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:6083 #, no-wrap msgid "" "paraTwo common targets in a filenameMakefilefilename\n" " are buildtargetallbuildtarget and\n" " buildtargetcleanbuildtarget.para\n" "\n" "paraTypically, invoking buildtargetallbuildtarget " "will\n" " rebuild the application, and invoking\n" " buildtargetcleanbuildtarget will remove the temporary\n" " files (filename.ofilename for example) created by the\n" " build process.para\n" "\n" "parabuildtargetcleanbuildtarget may be controlled by a\n" " number of variables, including varnameCLOBBERvarname\n" " and varnameRECURSEvarname.para" msgstr "" #. (itstool) path: para/buildtarget #: book.translate.xml:6100 book.translate.xml:6103 msgid "all" msgstr "" #. (itstool) path: example/para #: book.translate.xml:6099 msgid "" "Two common targets in a Makefile are <_:buildtarget-1/> " "and <_:buildtarget-2/>." msgstr "" #. (itstool) path: example/para #: book.translate.xml:6103 msgid "" "Typically, invoking <_:buildtarget-1/> will rebuild the application, and " "invoking <_:buildtarget-2/> will remove the temporary files (.o for example) created by the build process." msgstr "" #. (itstool) path: example/para #: book.translate.xml:6109 msgid "" "<_:buildtarget-1/> may be controlled by a number of variables, including " "CLOBBER and RECURSE." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:6116 msgid "Literal Text" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:6118 msgid "" "Literal text, or text which should be entered verbatim, is often needed in " "documentation. This is text that is excerpted from another file, or which " "should be copied exactly as shown from the documentation into another file." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:6123 msgid "" "Some of the time, programlisting will be sufficient to denote " "this text. But programlisting is not always appropriate, " "particularly when you want to include a portion of a file in-line with the rest of the paragraph." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:6130 msgid "On these occasions, use literal." msgstr "" #. (itstool) path: example/title #: book.translate.xml:6134 msgid "literal Example" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:6138 #, no-wrap msgid "" "paraThe literalmaxusers 10literal line in the kernel\n" " configuration file determines the size of many system tables, and is\n" " a rough guide to how many simultaneous logins the system will\n" " support.para" msgstr "" #. (itstool) path: example/para #: book.translate.xml:6145 msgid "" "The maxusers 10 line in the kernel configuration file " "determines the size of many system tables, and is a rough guide to how many " "simultaneous logins the system will support." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:6153 msgid "Showing Items That the User Must Fill In" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:6156 msgid "" "There will often be times when the user is shown what to do, or referred to " "a file or command line, but cannot simply copy the example provided. " "Instead, they must supply some information themselves." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:6161 msgid "" "replaceable is designed for this eventuality. Use it " "inside other elements to indicate parts of that " "element's content that the user must replace." msgstr "" #. (itstool) path: example/title #: book.translate.xml:6167 msgid "replaceable Example" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:6171 #, no-wrap msgid "" "screen&prompt.user; userinputman replaceablecommandreplaceableuserinputscreen" msgstr "" #. (itstool) path: informalexample/screen #: book.translate.xml:6176 #, no-wrap msgid "" "% man command" msgstr "" #. (itstool) path: example/para #: book.translate.xml:6179 msgid "" "replaceable can be used in many different elements, including " "literal. This example also shows that replaceable " "should only be wrapped around the content that the user is meant to provide. The other content should be left alone." msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:6188 #, no-wrap msgid "" "paraThe literalmaxusers replaceablenreplaceableliteral\n" " line in the kernel configuration file determines the size of many system\n" " tables, and is a rough guide to how many simultaneous logins the system " "will\n" " support.para\n" "\n" "paraFor a desktop workstation, literal32literal is a good " "value\n" " for replaceablenreplaceable.para" msgstr "" #. (itstool) path: example/para #: book.translate.xml:6198 msgid "" "The maxusers n line in the " "kernel configuration file determines the size of many system tables, and is " "a rough guide to how many simultaneous logins the system will support." msgstr "" #. (itstool) path: example/para #: book.translate.xml:6204 msgid "" "For a desktop workstation, 32 is a good value for " "n." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:6210 msgid "Showing GUI Buttons" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:6212 msgid "" "Buttons presented by a graphical user interface are marked with " "guibutton. To make the text look more like a graphical button, " "brackets and non-breaking spaces are added surrounding the text." msgstr "" #. (itstool) path: example/title #: book.translate.xml:6218 msgid "guibutton Example" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:6222 #, no-wrap msgid "" "paraEdit the file, then click\n" " guibutton[&nbsp;Save&nbsp;]guibutton to save the\n" " changes.para" msgstr "" #. (itstool) path: example/para #: book.translate.xml:6228 msgid "" "Edit the file, then click [ Save ] to save the " "changes." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:6235 msgid "Quoting System Errors" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:6237 msgid "" "System errors generated by FreeBSD are marked with errorname. " "This indicates the exact error that appears." msgstr "" #. (itstool) path: example/title #: book.translate.xml:6242 msgid "errorname Example" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:6246 #, no-wrap msgid "" "screenerrornamePanic: cannot mount rooterrornamescreen" msgstr "" #. (itstool) path: informalexample/screen #: book.translate.xml:6251 #, no-wrap msgid "Panic: cannot mount root" msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:6258 msgid "Images" msgstr "" #. (itstool) path: important/para #: book.translate.xml:6261 msgid "" "Image support in the documentation is somewhat experimental. The mechanisms " "described here are unlikely to change, but that is not guaranteed." msgstr "" #. (itstool) path: important/para #: book.translate.xml:6265 msgid "" "To provide conversion between different image formats, the graphics/" "ImageMagick port must be installed. This port is not included in " "the textproc/docproj meta port, and must be installed " "separately." msgstr "" #. (itstool) path: important/para #: book.translate.xml:6271 msgid "" "A good example of the use of images is the doc/en_US.ISO8859-1/" "articles/vm-design/ document. Examine the files in that directory " "to see how these elements are used together. Build different output formats " "to see how the format determines what images are shown in the rendered " "document." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:6280 msgid "Image Formats" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:6282 msgid "" "The following image formats are currently supported. An image file will " "automatically be converted to bitmap or vector image depending on the output " "document format." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:6286 msgid "" "These are the only formats in which images should be " "committed to the documentation repository." msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:6292 msgid "EPS (Encapsulated Postscript)" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:6296 msgid "" "Images that are primarily vector based, such as network diagrams, time " "lines, and similar, should be in this format. These images have a ." "eps extension." msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:6304 msgid "PNG (Portable Network Graphic)" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:6308 msgid "" "For bitmaps, such as screen captures, use this format. These images have the " ".png extension." msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:6315 msgid "PIC (PIC graphics language)" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:6318 msgid "" "PIC is a language for drawing simple vector-based figures " "used in the pic1 utility. These images have the .pic extension." msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:6326 msgid "SCR (SCReen capture)" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:6329 msgid "" "This format is specific to screenshots of console output. The following " "command generates an SCR file shot.scr from video " "buffer of /dev/ttyv0:" msgstr "" #. (itstool) path: listitem/screen #: book.translate.xml:6334 #, no-wrap msgid "" "# vidcontrol -p < " "/dev/ttyv0 > " "shot.scr" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:6336 msgid "" "This is preferable to PNG format for screenshots because " "the SCR file contains plain text of the command lines so " "that it can be converted to a PNG image or a plain text " "depending on the output document format." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:6346 msgid "" "Use the appropriate format for each image. Documentation will often have a " "mix of EPS and PNG images. The " "Makefiles ensure that the correct format image is " "chosen depending on the output format used. Do not commit the same " "image to the repository in two different formats." msgstr "" #. (itstool) path: important/para #: book.translate.xml:6355 msgid "" "The Documentation Project may eventually switch to using the SVG (Scalable Vector Graphic) format for vector images. However, the " "current state of SVG capable editing tools makes this " "impractical." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:6364 msgid "Image File Locations" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:6366 msgid "" "Image files can be stored in one of several locations, depending on the " "document and image:" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:6371 msgid "" "In the same directory as the document itself, usually done for articles and " "small books that keep all their files in a single directory." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:6377 msgid "" "In a subdirectory of the main document. Typically done when a large book " "uses separate subdirectories to organize individual chapters." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:6381 msgid "" "When images are stored in a subdirectory of the main document directory, the " "subdirectory name must be included in their paths in the Makefile and the imagedata element." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:6389 msgid "" "In a subdirectory of doc/share/images named after the " "document. For example, images for the Handbook are stored in doc/" "share/images/books/handbook. Images that work for multiple " "translations are stored in this upper level of the documentation file tree. " "Generally, these are images that can be used unchanged in non-English " "translations of the document." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:6402 msgid "Image Markup" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:6404 msgid "" "Images are included as part of a mediaobject. The " "mediaobject can contain other, more specific objects. We are " "concerned with two, the imageobject and the textobject." "" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:6409 msgid "" "Include one imageobject, and two textobject elements. " "The imageobject will point to the name of the image file without " "the extension. The textobject elements contain information that " "will be presented to the user as well as, or instead of, the image itself." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:6416 msgid "" "Text elements are shown to the reader in several situations. When the " "document is viewed in HTML, text elements are shown while " "the image is loading, or if the mouse pointer is hovered over the image, or " "if a text-only browser is being used. In formats like plain text where " "graphics are not possible, the text elements are shown instead of the " "graphical ones." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:6424 msgid "" "This example shows how to include an image called fig1.png in a document. The image is a rectangle with an A inside it:" msgstr "" #. (itstool) path: sect2/programlisting #: book.translate.xml:6428 #, no-wrap msgid "" "mediaobject\n" " imageobject\n" " imagedata fileref=\"fig1\" \n" " imageobject\n" "\n" " textobject\n" " literallayout class=\"monospaced\"+--------" "-------+ \n" "| A |\n" "+---------------+literallayout\n" " textobject\n" "\n" " textobject\n" " phraseA picturephrase \n" " textobject\n" "mediaobject" msgstr "" #. (itstool) path: callout/para #: book.translate.xml:6446 msgid "" "Include an imagedata element inside the imageobject " "element. The fileref attribute should contain the " "filename of the image to include, without the extension. The stylesheets " "will work out which extension should be added to the filename automatically." msgstr "" #. (itstool) path: callout/para #: book.translate.xml:6456 msgid "" "The first textobject contains a literallayout element, " "where the class attribute is set to monospaced. This is an opportunity to demonstrate ASCII art " "skills. This content will be used if the document is converted to plain text." "" msgstr "" #. (itstool) path: callout/para #: book.translate.xml:6464 msgid "" "Notice how the first and last lines of the content of the " "literallayout element butt up next to the element's tags. This " "ensures no extraneous white space is included." msgstr "" #. (itstool) path: callout/para #: book.translate.xml:6471 msgid "" "The second textobject contains a single phrase element." " The contents of this phrase will become the alt " "attribute for the image when this document is converted to HTML." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:6481 msgid "Image Makefile Entries" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:6483 msgid "" "Images must be listed in the Makefile in the " "IMAGES variable. This variable must contain the names of " "all the source images. For example, if there are three " "figures, fig1.eps, fig2.png, " "fig3.png, then the Makefile should " "have lines like this in it." msgstr "" #. (itstool) path: sect2/programlisting #: book.translate.xml:6492 #, no-wrap msgid "…\n" "IMAGES= fig1.eps fig2.png fig3.png\n" "…" msgstr "" #. (itstool) path: sect2/para #. (itstool) path: question/para #: book.translate.xml:6496 book.translate.xml:7086 msgid "or" msgstr "" #. (itstool) path: sect2/programlisting #: book.translate.xml:6498 #, no-wrap msgid "…\n" "IMAGES= fig1.eps\n" "IMAGES+= fig2.png\n" "IMAGES+= fig3.png\n" "…" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:6504 msgid "" "Again, the Makefile will work out the complete list of " "images it needs to build the source document, you only need to list the " "image files you provided." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:6511 msgid "Images and Chapters in Subdirectories" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:6513 msgid "" "Be careful when separating documentation into smaller files in different " "directories (see )." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:6516 msgid "" "Suppose there is a book with three chapters, and the chapters are stored in " "their own directories, called chapter1/chapter.xml, " "chapter2/chapter.xml, and chapter3/chapter." "xml. If each chapter has images associated with it, place those " "images in each chapter's subdirectory (chapter1/, " "chapter2/, and chapter3/)." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:6526 msgid "" "However, doing this requires including the directory names in the " "IMAGES variable in the Makefile, " "and including the directory name in the imagedata element in the document." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:6532 msgid "" "For example, if the book has chapter1/fig1.png, then " "chapter1/chapter.xml should contain:" msgstr "" #. (itstool) path: sect2/programlisting #: book.translate.xml:6537 #, no-wrap msgid "" "mediaobject\n" " imageobject\n" " imagedata fileref=\"chapter1/fig1\" \n" " imageobject\n" "\n" " …\n" "\n" "mediaobject" msgstr "" #. (itstool) path: callout/para #: book.translate.xml:6548 msgid "" "The directory name must be included in the fileref " "attribute." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:6553 msgid "The Makefile must contain:" msgstr "" #. (itstool) path: sect2/programlisting #: book.translate.xml:6555 #, no-wrap msgid "…\n" "IMAGES= chapter1/fig1.png\n" "…" msgstr "" #. (itstool) path: note/para #: book.translate.xml:6565 msgid "" "Links are also in-line elements. To show a URI without " "creating a link, see ." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:6571 msgid "xml:id Attributes" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:6573 msgid "" "Most DocBook elements accept an xml:id attribute to give " "that part of the document a unique name. The xml:id can " "be used as a target for a crossreference or link." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:6578 msgid "" "Any portion of the document that will be a link target must have an " "xml:id attribute. Assigning an xml:id " "to all chapters and sections, even if there are no current plans to link to " "them, is a good idea. These xml:ids can be used as unique " "reference points by anyone referring to the HTML version " "of the document." msgstr "" #. (itstool) path: example/title #: book.translate.xml:6587 msgid "xml:id on Chapters and Sections Example" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:6590 #, no-wrap msgid "" "chapter xml:id=\"introduction\"\n" " titleIntroductiontitle\n" "\n" " paraThis is the introduction. It contains a " "subsection,\n" " which is identified as well.para\n" "\n" " sect1 xml:id=\"introduction-moredetails\"\n" " titleMore Detailstitle\n" "\n" " paraThis is a subsection.para\n" " sect1\n" "chapter" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:6604 msgid "" "Use descriptive values for xml:id names. The values must " "be unique within the entire document, not just in a single file. In the " "example, the subsection xml:id is constructed by " "appending text to the chapter xml:id. This ensures that " "the xml:ids are unique. It also helps both reader and " "anyone editing the document to see where the link is located within the " "document, similar to a directory path to a file." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:6616 msgid "Crossreferences with xref" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:6618 msgid "" "xref provides the reader with a link to jump to another section " "of the document. The target xml:id is specified in the " "linkend attribute, and xref generates the link " "text automatically." msgstr "" #. (itstool) path: example/title #: book.translate.xml:6625 msgid "xref Example" msgstr "" #. (itstool) path: example/para #: book.translate.xml:6627 msgid "" "Assume that this fragment appears somewhere in a document that includes the " "xml:id example shown above:" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:6631 #, no-wrap msgid "" "paraMore information can be found\n" " in xref linkend=\"introduction\".para\n" "\n" "paraMore specific information can be found\n" " in xref linkend=\"introduction-moredetails\"." "para" msgstr "" #. (itstool) path: example/para #: book.translate.xml:6637 msgid "" "The link text will be generated automatically, looking like " "(emphasized text indicates the link text):" msgstr "" #. (itstool) path: blockquote/para #: book.translate.xml:6642 msgid "" "More information can be found in Chapter 1, Introduction." msgstr "" #. (itstool) path: blockquote/para #: book.translate.xml:6645 msgid "" "More specific information can be found in Section 1.1, More " "Details." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:6651 msgid "" "The link text is generated automatically from the chapter and section number " "and title elements." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:6660 msgid "" "The link element described here allows the writer to define the link text. " "When link text is used, it is very important to be descriptive to give the " "reader an idea of where the link goes. Remember that DocBook can be rendered " "to multiple types of media. The reader might be looking at a printed book or " "other form of media where there are no links. If the link text is not " "descriptive enough, the reader might not be able to locate the linked " "section." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:6669 msgid "" "The xlink:href attribute is the URL of " "the page, and the content of the element is the text that will be displayed " "for the user to activate." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:6674 msgid "" "In many situations, it is preferable to show the actual URL rather than text. This can be done by leaving out the element text " "entirely." msgstr "" #. (itstool) path: example/title #: book.translate.xml:6679 msgid "link to a FreeBSD Documentation Web Page Example" msgstr "" #. (itstool) path: example/para #: book.translate.xml:6682 msgid "" "Link to the book or article URL entity. To link to a " "specific chapter in a book, add a slash and the chapter file name, followed " "by an optional anchor within the chapter. For articles, link to the article " "URL entity, followed by an optional anchor within the " "article. URL entities can be found in doc/share/" "xml/urls.ent." msgstr "" #. (itstool) path: example/para #: book.translate.xml:6691 msgid "Usage for FreeBSD book links:" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:6693 #, no-wrap msgid "" "paraRead the link\n" " xlink:href=\"&url.books.handbook;/svn.html#svn-intro\"SVN\n" " introductionlink, then pick the nearest " "mirror from\n" " the list of link\n" " xlink:href=\"&url.books.handbook;/svn.html#svn-mirrors\"Subversion\n" " mirror siteslink.para" msgstr "" #. (itstool) path: example/para #: book.translate.xml:6702 msgid "" "Read the SVN introduction, then pick the nearest " "mirror from the list of Subversion mirror sites." msgstr "" #. (itstool) path: example/para #: book.translate.xml:6707 msgid "Usage for FreeBSD article links:" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:6709 #, no-wrap msgid "" "paraRead this\n" " link xlink:href=\"&url.articles.bsdl-gpl;\"article\n" " about the BSD licenselink, or just the\n" " link xlink:href=\"&url.articles.bsdl-" "gpl;#intro\"introductionlink.para" msgstr "" #. (itstool) path: example/para #: book.translate.xml:6716 msgid "" "Read this article about the BSD license, or just the introduction." msgstr "" #. (itstool) path: example/title #: book.translate.xml:6722 msgid "link to a FreeBSD Web Page Example" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:6726 #, no-wrap msgid "" "paraOf course, you could stop reading this " "document and go to the\n" " link xlink:href=\"&url.base;/index.html\"FreeBSD home pagelink instead.para" msgstr "" #. (itstool) path: example/para #: book.translate.xml:6731 msgid "" "Of course, you could stop reading this document and go to the FreeBSD home page instead." msgstr "" #. (itstool) path: example/title #: book.translate.xml:6737 msgid "link to an External Web Page Example" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:6742 #, no-wrap msgid "" "paraWikipedia has an excellent reference on\n" " link\n" " xlink:href=\"http://en.wikipedia.org/wiki/GUID_Partition_Table\"GUID\n" " Partition Tableslink.para" msgstr "" #. (itstool) path: example/para #: book.translate.xml:6749 msgid "" "Wikipedia has an excellent reference on GUID Partition Tables." msgstr "" #. (itstool) path: example/para #: book.translate.xml:6752 msgid "The link text can be omitted to show the actual URL:" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:6755 #, no-wrap msgid "" "paraWikipedia has an excellent reference on\n" " GUID Partition Tables: link\n" " xlink:href=\"http://en.wikipedia.org/wiki/GUID_Partition_Table\"link.para" msgstr "" #. (itstool) path: example/para #: book.translate.xml:6759 msgid "" "The same link can be entered using shorter notation instead of a separate " "ending tag:" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:6762 #, no-wrap msgid "" "paraWikipedia has an excellent reference on\n" " GUID Partition Tables: link\n" " xlink:href=\"http://en.wikipedia.org/wiki/GUID_Partition_Table\"." "para" msgstr "" #. (itstool) path: example/para #: book.translate.xml:6766 msgid "The two methods are equivalent. Appearance:" msgstr "" #. (itstool) path: example/para #: book.translate.xml:6768 msgid "" "Wikipedia has an excellent reference on GUID Partition Tables: http://en." "wikipedia.org/wiki/GUID_Partition_Table." msgstr "" #. (itstool) path: chapter/title #: book.translate.xml:6807 msgid "Style Sheets" msgstr "" #. (itstool) path: chapter/para #: book.translate.xml:6809 msgid "" "XML is concerned with content, and says nothing about how " "that content should be presented to the reader or rendered on paper. " "Multiple style sheet languages have been developed to " "describe visual layout, including Extensible Stylesheet Language " "Transformation (XSLT), Document Style Semantics and " "Specification Language (DSSSL), and Cascading Style " "Sheets (CSS)." msgstr "" #. (itstool) path: chapter/para #: book.translate.xml:6818 msgid "" "The FDP documents use XSLT stylesheets " "to transform DocBook into XHTML, and then CSS formatting is applied to the XHTML pages. " "Printable output is currently rendered with legacy DSSSL " "stylesheets, but this will probably change in the future." msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:6827 msgid "CSS" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:6829 msgid "" "Cascading Style Sheets (CSS) are a mechanism for " "attaching style information (font, weight, size, color, and so forth) to " "elements in an XHTML document without abusing " "XHTML to do so." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:6836 msgid "The DocBook Documents" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:6838 msgid "" "The FreeBSD XSLT and DSSSL stylesheets " "refer to docbook.css, which is expected to be present " "in the same directory as the XHTML files. The project-" "wide CSS file is copied from doc/share/misc/" "docbook.css when documents are converted to XHTML, and is installed automatically." msgstr "" #. (itstool) path: chapter/title #: book.translate.xml:6882 msgid "Translations" msgstr "" #. (itstool) path: chapter/para #: book.translate.xml:6884 msgid "" "This is the FAQ for people translating the FreeBSD documentation (FAQ, " "Handbook, tutorials, manual pages, and others) to different languages." msgstr "" #. (itstool) path: chapter/para #: book.translate.xml:6888 msgid "" "It is very heavily based on the translation FAQ from " "the FreeBSD German Documentation Project, originally written by Frank " "Gründer elwood@mc5sys.in-berlin.de and translated back to " "English by Bernd Warken bwarken@mayn.de." msgstr "" #. (itstool) path: chapter/para #: book.translate.xml:6894 msgid "" "The FAQ is maintained by the Documentation Engineering Team " "doceng@FreeBSD.org." msgstr "" #. (itstool) path: question/para #: book.translate.xml:6899 msgid "What do i18n and l10n mean?" msgstr "" #. (itstool) path: answer/para #: book.translate.xml:6904 msgid "" "i18n means internationalization and " "l10n means localization. They are just a " "convenient shorthand." msgstr "" #. (itstool) path: answer/para #: book.translate.xml:6909 msgid "" "i18n can be read as i followed by 18 " "letters, followed by n. Similarly, l10n is " "l followed by 10 letters, followed by n." msgstr "" #. (itstool) path: question/para #: book.translate.xml:6918 msgid "Is there a mailing list for translators?" msgstr "" #. (itstool) path: answer/para #: book.translate.xml:6922 msgid "" "Yes. Different translation groups have their own mailing lists. The list of " "translation projects has more information about the mailing lists and " "web sites run by each translation project. In addition there is " "freebsd-translators@freebsd.org for general translation " "discussion." msgstr "" #. (itstool) path: question/para #: book.translate.xml:6934 msgid "Are more translators needed?" msgstr "" #. (itstool) path: answer/para #: book.translate.xml:6938 msgid "" "Yes. The more people work on translation the faster it gets done, and the " "faster changes to the English documentation are mirrored in the translated " "documents." msgstr "" #. (itstool) path: answer/para #: book.translate.xml:6943 msgid "You do not have to be a professional translator to be able to help." msgstr "" #. (itstool) path: question/para #: book.translate.xml:6950 msgid "What languages do I need to know?" msgstr "" #. (itstool) path: answer/para #: book.translate.xml:6954 msgid "" "Ideally, you will have a good knowledge of written English, and obviously " "you will need to be fluent in the language you are translating to." msgstr "" #. (itstool) path: answer/para #: book.translate.xml:6958 msgid "" "English is not strictly necessary. For example, you could do a Hungarian " "translation of the FAQ from the Spanish translation." msgstr "" #. (itstool) path: question/para #: book.translate.xml:6966 msgid "What software do I need to know?" msgstr "" #. (itstool) path: answer/para #: book.translate.xml:6970 msgid "" "It is strongly recommended that you maintain a local copy of the FreeBSD " "Subversion repository (at least the documentation part). This can be done by " "running:" msgstr "" #. (itstool) path: answer/screen #: book.translate.xml:6974 #, no-wrap msgid "" "% svn checkout https://svn.FreeBSD.org/doc/head/ " "head" msgstr "" #. (itstool) path: answer/para #: book.translate.xml:6976 msgid "" "svn.FreeBSD.org is a " "public SVN server. Verify the server certificate from the " "list of Subversion mirror sites." msgstr "" #. (itstool) path: note/para #: book.translate.xml:6982 msgid "" "This will require the devel/subversion package to be " "installed." msgstr "" #. (itstool) path: answer/para #: book.translate.xml:6987 msgid "" "You should be comfortable using svn. This will " "allow you to see what has changed between different versions of the files " "that make up the documentation." msgstr "" #. (itstool) path: answer/para #: book.translate.xml:6992 msgid "" "For example, to view the differences between revisions r33733 and r33734 of en_US.ISO8859-1/books/" "fdp-primer/book.xml, run:" msgstr "" #. (itstool) path: answer/screen #: book.translate.xml:6997 #, no-wrap msgid "" "% svn diff -r33733:" "33734 en_US.ISO8859-1/books/fdp-primer/book.xml" msgstr "" #. (itstool) path: answer/para #: book.translate.xml:6999 msgid "" "Please see the complete explanation of using Subversion in FreeBSD in the FreeBSD Handbook." msgstr "" #. (itstool) path: question/para #: book.translate.xml:7007 msgid "How do I find out who else might be translating to the same language?" msgstr "" #. (itstool) path: answer/para #: book.translate.xml:7012 msgid "" "The Documentation Project translations page lists the translation " "efforts that are currently known about. If others are already working on " "translating documentation to your language, please do not duplicate their " "efforts. Instead, contact them to see how you can help." msgstr "" #. (itstool) path: answer/para #: book.translate.xml:7019 msgid "" "If no one is listed on that page as translating for your language, then send " "a message to the FreeBSD documentation project mailing list in " "case someone else is thinking of doing a translation, but has not announced " "it yet." msgstr "" #. (itstool) path: question/para #: book.translate.xml:7028 msgid "No one else is translating to my language. What do I do?" msgstr "" #. (itstool) path: answer/para #: book.translate.xml:7033 msgid "" "Congratulations, you have just started the FreeBSD your-" "language-here Documentation Translation Project. " "Welcome aboard." msgstr "" #. (itstool) path: answer/para #: book.translate.xml:7038 msgid "" "First, decide whether or not you have got the time to spare. Since you are " "the only person working on your language at the moment it is going to be " "your responsibility to publicize your work and coordinate any volunteers " "that might want to help you." msgstr "" #. (itstool) path: answer/para #: book.translate.xml:7044 msgid "" "Write an email to the Documentation Project mailing list, announcing that " "you are going to translate the documentation, so the Documentation Project " "translations page can be maintained." msgstr "" #. (itstool) path: answer/para #: book.translate.xml:7049 msgid "" "If there is already someone in your country providing FreeBSD mirroring " "services you should contact them and ask if you can have some webspace for " "your project, and possibly an email address or mailing list services." msgstr "" #. (itstool) path: answer/para #: book.translate.xml:7054 msgid "" "Then pick a document and start translating. It is best to start with " "something fairly small—either the FAQ, or one of the tutorials." msgstr "" #. (itstool) path: question/para #: book.translate.xml:7062 msgid "I have translated some documentation, where do I send it?" msgstr "" #. (itstool) path: answer/para #: book.translate.xml:7067 msgid "" "That depends. If you are already working with a translation team (such as " "the Japanese team, or the German team) then they will have their own " "procedures for handling submitted documentation, and these will be outlined " "on their web pages." msgstr "" #. (itstool) path: answer/para #: book.translate.xml:7073 msgid "" "If you are the only person working on a particular language (or you are " "responsible for a translation project and want to submit your changes back " "to the FreeBSD project) then you should send your translation to the FreeBSD " "project (see the next question)." msgstr "" #. (itstool) path: question/para #: book.translate.xml:7083 msgid "" "I am the only person working on translating to this language, how do I " "submit my translation?" msgstr "" #. (itstool) path: question/para #: book.translate.xml:7088 msgid "" "We are a translation team, and want to submit documentation that our members " "have translated for us." msgstr "" #. (itstool) path: answer/para #: book.translate.xml:7094 msgid "" "First, make sure your translation is organized properly. This means that it " "should drop into the existing documentation tree and build straight away." msgstr "" #. (itstool) path: answer/para #: book.translate.xml:7098 msgid "" "Currently, the FreeBSD documentation is stored in a top level directory " "called head/. Directories below this are named " "according to the language code they are written in, as defined in ISO639 " "(/usr/share/misc/iso639 on a version of FreeBSD newer " "than 20th January 1999)." msgstr "" #. (itstool) path: answer/para #: book.translate.xml:7105 msgid "" "If your language can be encoded in different ways (for example, Chinese) " "then there should be directories below this, one for each encoding format " "you have provided." msgstr "" #. (itstool) path: answer/para #: book.translate.xml:7109 msgid "Finally, you should have directories for each document." msgstr "" #. (itstool) path: answer/para #: book.translate.xml:7112 msgid "For example, a hypothetical Swedish translation might look like:" msgstr "" #. (itstool) path: answer/programlisting #: book.translate.xml:7115 #, no-wrap msgid "" "head/\n" " sv_SE.ISO8859-1/\n" " Makefile\n" " htdocs/\n" " docproj/\n" " books/\n" " faq/\n" " Makefile\n" " book.xml" msgstr "" #. (itstool) path: answer/para #: book.translate.xml:7125 msgid "" "sv_SE.ISO8859-1 is the name of the translation, in " "lang.encoding form. Note the two Makefiles, which will be used to " "build the documentation." msgstr "" #. (itstool) path: answer/para #: book.translate.xml:7131 msgid "" "Use tar1 and gzip1 to compress up your " "documentation, and send it to the project." msgstr "" #. (itstool) path: answer/screen #: book.translate.xml:7134 #, no-wrap msgid "" "% cd doc\n" "% tar cf swedish-docs.tar sv_SE.ISO8859-1\n" "% gzip -9 swedish-docs.tar" msgstr "" #. (itstool) path: answer/para #: book.translate.xml:7138 msgid "" "Put swedish-docs.tar.gz somewhere. If you do not have " "access to your own webspace (perhaps your ISP does not let you have any) " "then you can email Documentation Engineering Team doceng@FreeBSD.org, and arrange to email the files when it is convenient." msgstr "" #. (itstool) path: answer/para #: book.translate.xml:7144 msgid "" "Either way, you should use Bugzilla to submit a report indicating that you " "have submitted the documentation. It would be very helpful if you could get " "other people to look over your translation and double check it first, since " "it is unlikely that the person committing it will be fluent in the language." msgstr "" #. (itstool) path: answer/para #: book.translate.xml:7151 msgid "" "Someone (probably the Documentation Project Manager, currently Documentation " "Engineering Team doceng@FreeBSD.org) will then take your " "translation and confirm that it builds. In particular, the following things " "will be looked at:" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:7158 msgid "Do all your files use RCS strings (such as \"ID\")?" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:7163 msgid "" "Does make all in the sv_SE.ISO8859-1 " "directory work correctly?" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:7169 msgid "Does make install work correctly?" msgstr "" #. (itstool) path: answer/para #: book.translate.xml:7174 msgid "" "If there are any problems then whoever is looking at the submission will get " "back to you to work them out." msgstr "" #. (itstool) path: answer/para #: book.translate.xml:7177 msgid "" "If there are no problems your translation will be committed as soon as " "possible." msgstr "" #. (itstool) path: question/para #: book.translate.xml:7184 msgid "Can I include language or country specific text in my translation?" msgstr "" #. (itstool) path: answer/para #: book.translate.xml:7189 msgid "We would prefer that you did not." msgstr "" #. (itstool) path: answer/para #: book.translate.xml:7191 msgid "" "For example, suppose that you are translating the Handbook to Korean, and " "want to include a section about retailers in Korea in your Handbook." msgstr "" #. (itstool) path: answer/para #: book.translate.xml:7195 msgid "" "There is no real reason why that information should not be in the English " "(or German, or Spanish, or Japanese, or …) versions as well. It is feasible " "that an English speaker in Korea might try to pick up a copy of FreeBSD " "whilst over there. It also helps increase FreeBSD's perceived presence " "around the globe, which is not a bad thing." msgstr "" #. (itstool) path: answer/para #: book.translate.xml:7203 msgid "" "If you have country specific information, please submit it as a change to " "the English Handbook (using Bugzilla) and then translate the change back to " "your language in the translated Handbook." msgstr "" #. (itstool) path: answer/para #: book.translate.xml:7208 msgid "Thanks." msgstr "" #. (itstool) path: question/para #: book.translate.xml:7214 msgid "How should language specific characters be included?" msgstr "" #. (itstool) path: answer/para #: book.translate.xml:7219 msgid "" "Non-ASCII characters in the documentation should be included using SGML " "entities." msgstr "" #. (itstool) path: answer/para #: book.translate.xml:7222 msgid "" "Briefly, these look like an ampersand (&), the name of the entity, and a " "semi-colon (;)." msgstr "" #. (itstool) path: answer/para #: book.translate.xml:7225 msgid "" "The entity names are defined in ISO8879, which is in the ports tree as " "textproc/iso8879." msgstr "" #. (itstool) path: answer/para #: book.translate.xml:7228 msgid "A few examples include:" msgstr "" #. (itstool) path: segmentedlist/segtitle #: book.translate.xml:7231 msgid "Entity" msgstr "" #. (itstool) path: segmentedlist/segtitle #: book.translate.xml:7233 msgid "Appearance" msgstr "" #. (itstool) path: seglistitem/seg #: book.translate.xml:7238 msgid "&eacute;" msgstr "" #. (itstool) path: seglistitem/seg #: book.translate.xml:7239 msgid "é" msgstr "" #. (itstool) path: seglistitem/seg #: book.translate.xml:7240 msgid "Small e with an acute accent" msgstr "" #. (itstool) path: seglistitem/seg #: book.translate.xml:7244 msgid "&Eacute;" msgstr "" #. (itstool) path: seglistitem/seg #: book.translate.xml:7245 msgid "É" msgstr "" #. (itstool) path: seglistitem/seg #: book.translate.xml:7246 msgid "Large E with an acute accent" msgstr "" #. (itstool) path: seglistitem/seg #: book.translate.xml:7250 msgid "&uuml;" msgstr "" #. (itstool) path: seglistitem/seg #: book.translate.xml:7251 msgid "ü" msgstr "" #. (itstool) path: seglistitem/seg #: book.translate.xml:7252 msgid "Small u with an umlaut" msgstr "" #. (itstool) path: answer/para #: book.translate.xml:7256 msgid "" "After you have installed the iso8879 port, the files in /usr/local/" "share/xml/iso8879 contain the complete list." msgstr "" #. (itstool) path: question/para #: book.translate.xml:7264 msgid "Addressing the reader" msgstr "" #. (itstool) path: answer/para #: book.translate.xml:7268 msgid "" "In the English documents, the reader is addressed as you, " "there is no formal/informal distinction as there is in some languages." msgstr "" #. (itstool) path: answer/para #: book.translate.xml:7272 msgid "" "If you are translating to a language which does distinguish, use whichever " "form is typically used in other technical documentation in your language. If " "in doubt, use a mildly polite form." msgstr "" #. (itstool) path: question/para #: book.translate.xml:7281 msgid "Do I need to include any additional information in my translations?" msgstr "" #. (itstool) path: answer/para #: book.translate.xml:7286 msgid "Yes." msgstr "" #. (itstool) path: answer/para #: book.translate.xml:7288 msgid "" "The header of the English version of each document will look something like " "this:" msgstr "" #. (itstool) path: answer/programlisting #: book.translate.xml:7291 #, no-wrap msgid "" "<!--\n" " The FreeBSD Documentation Project\n" "\n" " $FreeBSD: head/en_US.ISO8859-1/books/faq/book.xml 38674 2012-04-14 13:" "52:52Z $\n" "-->" msgstr "" #. (itstool) path: answer/para #: book.translate.xml:7297 msgid "" "The exact boilerplate may change, but it will always include a $FreeBSD$ " "line and the phrase The FreeBSD Documentation Project. " "Note that the $FreeBSD part is expanded automatically by Subversion, so it " "should be empty (just $FreeBSD$) for new files." msgstr "" #. (itstool) path: answer/para #: book.translate.xml:7305 msgid "" "Your translated documents should include their own $FreeBSD$ line, and " "change the FreeBSD Documentation Project line to " "The FreeBSD language Documentation " "Project." msgstr "" #. (itstool) path: answer/para #: book.translate.xml:7311 msgid "" "In addition, you should add a third line which indicates which revision of " "the English text this is based on." msgstr "" #. (itstool) path: answer/para #: book.translate.xml:7314 msgid "So, the Spanish version of this file might start:" msgstr "" #. (itstool) path: answer/programlisting #: book.translate.xml:7316 #, no-wrap msgid "" "<!--\n" " The FreeBSD Spanish Documentation Project\n" "\n" " $FreeBSD: head/es_ES.ISO8859-1/books/faq/book.xml 38826 2012-05-17 19:" "12:14Z hrs $\n" " Original revision: r38674\n" "-->" msgstr "" #. (itstool) path: chapter/title #: book.translate.xml:7333 msgid "PO Translations" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:7338 msgid "" "The GNU gettext system offers translators " "an easy way to create and maintain translations of documents. Translatable " "strings are extracted from the original document into a PO (Portable Object) file. Translated versions of the strings are " "entered with a separate editor. The strings can be used directly or built " "into a complete translated version of the original document." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:7351 msgid "" "The procedure shown in is assumed " "to have already been performed. The TRANSLATOR option is " "required and already enabled by default in the textproc/docproj port." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:7357 msgid "" "This example shows the creation of a Spanish translation of the short Leap Seconds article." msgstr "" #. (itstool) path: procedure/title #: book.translate.xml:7362 msgid "Install a PO Editor" msgstr "" #. (itstool) path: step/para #: book.translate.xml:7365 msgid "" "A PO editor is needed to edit translation files. This " "example uses editors/poedit." msgstr "" #. (itstool) path: step/screen #: book.translate.xml:7369 #, no-wrap msgid "" "# cd /usr/ports/editors/poedit\n" "# make install clean" msgstr "" #. (itstool) path: procedure/title #: book.translate.xml:7375 msgid "Initial Setup" msgstr "" #. (itstool) path: procedure/para #: book.translate.xml:7377 msgid "" "When a new translation is first created, the directory structure and " "Makefile must be created or copied from the English " "original:" msgstr "" #. (itstool) path: step/para #: book.translate.xml:7382 msgid "" "Create a directory for the new translation. The English article source is in " "~/doc/en_US.ISO8859-1/articles/leap-seconds/. The " "Spanish translation will go in ~/doc/es_ES.ISO8859-1/articles/leap-" "seconds/. The path is the same except for the name of the " "language directory." msgstr "" #. (itstool) path: step/screen #: book.translate.xml:7390 #, no-wrap msgid "" "% svn mkdir --parents ~/doc/es_ES.ISO8859-1/" "articles/leap-seconds/" msgstr "" #. (itstool) path: step/para #: book.translate.xml:7394 msgid "" "Copy the Makefile from the original document into the " "translation directory:" msgstr "" #. (itstool) path: step/screen #: book.translate.xml:7397 #, no-wrap msgid "" "% svn cp ~/doc/en_US.ISO8859-1/articles/leap-" "seconds/Makefile \\\n" " ~/doc/es_ES.ISO8859-1/articles/leap-seconds/" msgstr "" #. (itstool) path: procedure/title #: book.translate.xml:7403 msgid "Translation" msgstr "" #. (itstool) path: procedure/para #: book.translate.xml:7405 msgid "" "Translating a document consists of two steps: extracting translatable " "strings from the original document, and entering translations for those " "strings. These steps are repeated until the translator feels that enough of " "the document has been translated to produce a usable translated document." msgstr "" #. (itstool) path: step/para #: book.translate.xml:7413 msgid "" "Extract the translatable strings from the original English version into a " "PO file:" msgstr "" #. (itstool) path: step/screen #: book.translate.xml:7416 #, no-wrap msgid "" "% cd ~/doc/es_ES.ISO8859-1/articles/leap-seconds/" "\n" "% make po" msgstr "" #. (itstool) path: step/para #: book.translate.xml:7421 msgid "" "Use a PO editor to enter translations in the PO file. There are several different editors available. " "poedit from editors/poedit is shown here." msgstr "" #. (itstool) path: step/para #: book.translate.xml:7427 msgid "" "The PO file name is the two-character language code " "followed by an underline and a two-character region code. For Spanish, the " "file name is es_ES.po." msgstr "" #. (itstool) path: step/screen #: book.translate.xml:7432 book.translate.xml:7880 #, no-wrap msgid "% poedit es_ES.po" msgstr "" #. (itstool) path: procedure/title #: book.translate.xml:7437 msgid "Generating a Translated Document" msgstr "" #. (itstool) path: step/para #: book.translate.xml:7440 msgid "Generate the translated document:" msgstr "" #. (itstool) path: step/screen #: book.translate.xml:7442 #, no-wrap msgid "" "% cd ~/doc/es_ES.ISO8859-1/articles/leap-seconds/" "\n" "% make tran" msgstr "" #. (itstool) path: step/para #: book.translate.xml:7445 msgid "" "The name of the generated document matches the name of the English original, " "usually article.xml for articles or book.xml for books." msgstr "" #. (itstool) path: step/para #: book.translate.xml:7452 msgid "" "Check the generated file by rendering it to HTML and " "viewing it with a web browser:" msgstr "" #. (itstool) path: step/screen #: book.translate.xml:7456 #, no-wrap msgid "" "% make FORMATS=html\n" "% firefox article.html" msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:7463 msgid "Creating New Translations" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:7465 msgid "" "The first step to creating a new translated document is locating or creating " "a directory to hold it. FreeBSD puts translated documents in a subdirectory " "named for their language and region in the format " "lang_REGION. lang is a two-character lowercase code." " It is followed by an underscore character and then the two-character " "uppercase REGION code." msgstr "" #. (itstool) path: table/title #: book.translate.xml:7476 msgid "Language Names" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7481 msgid "Language" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7482 msgid "Region" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7483 msgid "Translated Directory Name" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7484 msgid "PO File Name" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7485 msgid "Character Set" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7491 msgid "English" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7492 msgid "United States" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7493 msgid "en_US.ISO8859-1" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7494 msgid "en_US.po" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7495 book.translate.xml:7511 book.translate.xml:7519 #: book.translate.xml:7535 book.translate.xml:7543 book.translate.xml:7591 #: book.translate.xml:7607 msgid "ISO 8859-1" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7499 msgid "Bengali" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7500 msgid "Bangladesh" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7501 msgid "bn_BD.UTF-8" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7502 msgid "bn_BD.po" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7503 book.translate.xml:7575 book.translate.xml:7583 #: book.translate.xml:7631 book.translate.xml:7639 msgid "UTF-8" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7507 msgid "Danish" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7508 msgid "Denmark" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7509 msgid "da_DK.ISO8859-1" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7510 msgid "da_DK.po" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7515 msgid "German" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7516 msgid "Germany" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7517 msgid "de_DE.ISO8859-1" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7518 msgid "de_DE.po" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7523 msgid "Greek" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7524 msgid "Greece" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7525 msgid "el_GR.ISO8859-7" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7526 msgid "el_GR.po" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7527 msgid "ISO 8859-7" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7531 msgid "Spanish" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7532 msgid "Spain" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7533 msgid "es_ES.ISO8859-1" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7534 msgid "es_ES.po" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7539 msgid "French" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7540 msgid "France" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7541 msgid "fr_FR.ISO8859-1" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7542 msgid "fr_FR.po" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7547 msgid "Hungarian" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7548 msgid "Hungary" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7549 msgid "hu_HU.ISO8859-2" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7550 msgid "hu_HU.po" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7551 book.translate.xml:7599 msgid "ISO 8859-2" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7555 msgid "Italian" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7556 msgid "Italy" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7557 msgid "it_IT.ISO8859-15" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7558 msgid "it_IT.po" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7559 msgid "ISO 8859-15" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7563 msgid "Japanese" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7564 msgid "Japan" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7565 msgid "ja_JP.eucJP" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7566 msgid "ja_JP.po" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7567 msgid "EUC JP" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7571 msgid "Korean" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7572 msgid "Korea" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7573 msgid "ko_KR.UTF-8" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7574 msgid "ko_KR.po" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7579 msgid "Mongolian" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7580 msgid "Mongolia" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7581 msgid "mn_MN.UTF-8" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7582 msgid "mn_MN.po" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7587 msgid "Dutch" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7588 msgid "Netherlands" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7589 msgid "nl_NL.ISO8859-1" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7590 msgid "nl_NL.po" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7595 msgid "Polish" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7596 msgid "Poland" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7597 msgid "pl_PL.ISO8859-2" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7598 msgid "pl_PL.po" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7603 msgid "Portuguese" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7604 msgid "Brazil" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7605 msgid "pt_BR.ISO8859-1" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7606 msgid "pt_BR.po" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7611 msgid "Russian" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7612 msgid "Russia" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7613 msgid "ru_RU.KOI8-R" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7614 msgid "ru_RU.po" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7615 msgid "KOI8-R" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7619 msgid "Turkish" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7620 msgid "Turkey" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7621 msgid "tr_TR.ISO8859-9" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7622 msgid "tr_TR.po" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7623 msgid "ISO 8859-9" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7627 book.translate.xml:7635 msgid "Chinese" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7628 msgid "China" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7629 msgid "zh_CN.UTF-8" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7630 msgid "zh_CN.po" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7636 msgid "Taiwan" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7637 msgid "zh_TW.UTF-8" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:7638 msgid "zh_TW.po" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:7645 msgid "" "The translations are in subdirectories of the main documentation directory, " "here assumed to be ~/doc/ as shown in . For example, German translations are located in " "~/doc/de_DE.ISO8859-1/, and French translations are in " "~/doc/fr_FR.ISO8859-1/." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:7654 msgid "" "Each language directory contains separate subdirectories named for the type " "of documents, usually articles/ and books/." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:7659 msgid "" "Combining these directory names gives the complete path to an article or " "book. For example, the French translation of the NanoBSD article is in " "~/doc/fr_FR.ISO8859-1/articles/nanobsd/, and the " "Mongolian translation of the Handbook is in ~/doc/mn_MN.UTF-8/" "books/handbook/." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:7666 msgid "" "A new language directory must be created when translating a document to a " "new language. If the language directory already exists, only a subdirectory " "in the articles/ or books/ " "directory is needed." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:7672 msgid "" "FreeBSD documentation builds are controlled by a Makefile in the same directory. With simple articles, the " "Makefile can often just be copied verbatim from the " "original English directory. The translation process combines multiple " "separate book.xml and chapter.xml " "files in books into a single file, so the Makefile for " "book translations must be copied and modified." msgstr "" #. (itstool) path: example/title #: book.translate.xml:7683 msgid "Creating a Spanish Translation of the Porter's Handbook" msgstr "" #. (itstool) path: example/para #: book.translate.xml:7686 msgid "" "Create a new Spanish translation of the Porter's Handbook. The " "original is a book in ~/doc/en_US.ISO8859-1/books/porters-handbook/" "." msgstr "" #. (itstool) path: step/para #: book.translate.xml:7693 msgid "" "The Spanish language books directory ~/doc/es_ES.ISO8859-1/books/ already exists, so only a new subdirectory for the Porter's " "Handbook is needed:" msgstr "" #. (itstool) path: step/screen #: book.translate.xml:7697 #, no-wrap msgid "" "% cd ~/doc/es_ES.ISO8859-1/books/\n" "% svn mkdir porters-handbook\n" "A porters-handbook" msgstr "" #. (itstool) path: step/para #: book.translate.xml:7703 msgid "Copy the Makefile from the original book:" msgstr "" #. (itstool) path: step/screen #: book.translate.xml:7706 #, no-wrap msgid "" "% cd ~/doc/es_ES.ISO8859-1/books/porters-" "handbook\n" "% svn cp ~/doc/en_US.ISO8859-1/books/porters-" "handbook/Makefile .\n" "A Makefile" msgstr "" #. (itstool) path: step/para #: book.translate.xml:7710 msgid "" "Modify the contents of the Makefile to only expect a " "single book.xml:" msgstr "" #. (itstool) path: step/programlisting #: book.translate.xml:7714 #, no-wrap msgid "" "#\n" "# $FreeBSD$\n" "#\n" "# Build the FreeBSD Porter's Handbook.\n" "#\n" "\n" "MAINTAINER=doc@FreeBSD.org\n" "\n" "DOC?= book\n" "\n" "FORMATS?= html-split\n" "\n" "INSTALL_COMPRESSED?= gz\n" "INSTALL_ONLY_COMPRESSED?=\n" "\n" "# XML content\n" "SRCS= book.xml\n" "\n" "# Images from the cross-document image library\n" "IMAGES_LIB+= callouts/1.png\n" "IMAGES_LIB+= callouts/2.png\n" "IMAGES_LIB+= callouts/3.png\n" "IMAGES_LIB+= callouts/4.png\n" "IMAGES_LIB+= callouts/5.png\n" "IMAGES_LIB+= callouts/6.png\n" "IMAGES_LIB+= callouts/7.png\n" "IMAGES_LIB+= callouts/8.png\n" "IMAGES_LIB+= callouts/9.png\n" "IMAGES_LIB+= callouts/10.png\n" "IMAGES_LIB+= callouts/11.png\n" "IMAGES_LIB+= callouts/12.png\n" "IMAGES_LIB+= callouts/13.png\n" "IMAGES_LIB+= callouts/14.png\n" "IMAGES_LIB+= callouts/15.png\n" "IMAGES_LIB+= callouts/16.png\n" "IMAGES_LIB+= callouts/17.png\n" "IMAGES_LIB+= callouts/18.png\n" "IMAGES_LIB+= callouts/19.png\n" "IMAGES_LIB+= callouts/20.png\n" "IMAGES_LIB+= callouts/21.png\n" "\n" "URL_RELPREFIX?= ../../../..\n" "DOC_PREFIX?= ${.CURDIR}/../../..\n" "\n" ".include \"${DOC_PREFIX}/share/mk/doc.project.mk\"" msgstr "" #. (itstool) path: step/para #: book.translate.xml:7760 msgid "" "Now the document structure is ready for the translator to begin translating " "with make po." msgstr "" #. (itstool) path: example/title #: book.translate.xml:7768 msgid "" "Creating a French Translation of the PGP Keys Article" msgstr "" #. (itstool) path: example/para #: book.translate.xml:7771 msgid "" "Create a new French translation of the PGP Keys article. The original is an article in ~/doc/en_US.ISO8859-1/" "articles/pgpkeys/." msgstr "" #. (itstool) path: step/para #: book.translate.xml:7778 msgid "" "The French language article directory ~/doc/fr_FR.ISO8859-1/" "articles/ already exists, so only a new subdirectory for the " "PGP Keys article is needed:" msgstr "" #. (itstool) path: step/screen #: book.translate.xml:7782 #, no-wrap msgid "" "% cd ~/doc/fr_FR.ISO8859-1/articles/\n" "% svn mkdir pgpkeys\n" "A pgpkeys" msgstr "" #. (itstool) path: step/para #: book.translate.xml:7788 msgid "Copy the Makefile from the original article:" msgstr "" #. (itstool) path: step/screen #: book.translate.xml:7791 #, no-wrap msgid "" "% cd ~/doc/fr_FR.ISO8859-1/articles/pgpkeys\n" "% svn cp ~/doc/en_US.ISO8859-1/articles/pgpkeys/" "Makefile .\n" "A Makefile" msgstr "" #. (itstool) path: step/para #: book.translate.xml:7795 msgid "" "Check the contents of the Makefile. Because this is a " "simple article, in this case the Makefile can be used " "unchanged. The $FreeBSD...$ version string on the second " "line will be replaced by the version control system when this file is " "committed." msgstr "" #. (itstool) path: step/programlisting #: book.translate.xml:7802 #, no-wrap msgid "" "#\n" "# $FreeBSD$\n" "#\n" "# Article: PGP Keys\n" "\n" "DOC?= article\n" "\n" "FORMATS?= html\n" "WITH_ARTICLE_TOC?= YES\n" "\n" "INSTALL_COMPRESSED?= gz\n" "INSTALL_ONLY_COMPRESSED?=\n" "\n" "SRCS= article.xml\n" "\n" "# To build with just key fingerprints, set FINGERPRINTS_ONLY.\n" "\n" "URL_RELPREFIX?= ../../../..\n" "DOC_PREFIX?= ${.CURDIR}/../../..\n" "\n" ".include \"${DOC_PREFIX}/share/mk/doc.project.mk\"" msgstr "" #. (itstool) path: step/para #: book.translate.xml:7824 msgid "" "With the document structure complete, the PO file can be " "created with make po." msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:7833 msgid "Translating" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:7835 msgid "" "The gettext system greatly reduces the number of " "things that must be tracked by a translator. Strings to be translated are " "extracted from the original document into a PO file. Then " "a PO editor is used to enter the translated versions of " "each string." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:7842 msgid "" "The FreeBSD PO translation system does not overwrite " "PO files, so the extraction step can be run at any time " "to update the PO file." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:7847 msgid "" "A PO editor is used to edit the file. editors/poedit is shown in these examples because it is " "simple and has minimal requirements. Other PO editors " "offer features to make the job of translating easier. The Ports Collection " "offers several of these editors, including devel/" "gtranslator." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:7855 msgid "" "It is important to preserve the PO file. It contains all " "of the work that translators have done." msgstr "" #. (itstool) path: example/title #: book.translate.xml:7859 msgid "Translating the Porter's Handbook to Spanish" msgstr "" #. (itstool) path: example/para #: book.translate.xml:7861 msgid "Enter Spanish translations of the contents of the Porter's Handbook." msgstr "" #. (itstool) path: step/para #: book.translate.xml:7866 msgid "" "Change to the Spanish Porter's Handbook directory and update the " "PO file. The generated PO file is " "called es_ES.po as shown in ." msgstr "" #. (itstool) path: step/screen #: book.translate.xml:7872 #, no-wrap msgid "" "% cd ~/doc/es_ES.ISO8859-1/books/porters-" "handbook\n" "% make po" msgstr "" #. (itstool) path: step/para #: book.translate.xml:7877 msgid "Enter translations using a PO editor:" msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:7887 msgid "Tips for Translators" msgstr "" #. (itstool) path: sect2/title #. (itstool) path: example/title #: book.translate.xml:7890 book.translate.xml:7896 msgid "Preserving XML Tags" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:7892 msgid "" "Preserve XML tags that are shown in the English original." msgstr "" #. (itstool) path: example/para #: book.translate.xml:7898 msgid "English original:" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:7900 #, no-wrap msgid "" "If acronymNTPacronym is not being used" msgstr "" #. (itstool) path: example/para #: book.translate.xml:7902 msgid "Spanish translation:" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:7904 #, no-wrap msgid "" "Si acronymNTPacronym no se utiliza" msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:7909 msgid "Preserving Spaces" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:7911 msgid "" "Preserve existing spaces at the beginning and end of strings to be " "translated. The translated version must have these spaces also." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:7917 msgid "Verbatim Tags" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:7919 msgid "The contents of some tags should be copied verbatim, not translated:" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:7924 msgid "citerefentry" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:7928 msgid "command" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:7932 msgid "filename" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:7936 msgid "literal" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:7940 msgid "manvolnum" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:7944 msgid "orgname" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:7948 msgid "package" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:7952 msgid "programlisting" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:7956 msgid "prompt" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:7960 msgid "refentrytitle" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:7964 msgid "screen" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:7968 msgid "userinput" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:7972 msgid "varname" msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:7978 msgid "$FreeBSD$ Strings" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:7981 msgid "" "The $FreeBSD$ version strings used in files require special handling. In " "examples like , these " "strings are not meant to be expanded. The English documents use " "&dollar; entities to avoid including actual literal " "dollar signs in the file:" msgstr "" #. (itstool) path: sect2/programlisting #: book.translate.xml:7988 book.translate.xml:8006 #, no-wrap msgid "&dollar;FreeBSD&dollar;" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:7990 msgid "" "The &dollar; entities are not seen as dollar signs by " "the version control system and so the string is not expanded into a version " "string." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:7994 msgid "" "When a PO file is created, the &dollar; entities used in examples are replaced with actual dollar signs. " "The resulting literal $FreeBSD$ string will be wrongly " "expanded by the version control system when the file is committed." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:8001 msgid "" "The same technique as used in the English documents can be used in the " "translation. The &dollar; is used to replace the " "dollar sign in the translation entered into the PO editor:" "" msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:8049 msgid "Building a Translated Document" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:8051 msgid "" "A translated version of the original document can be created at any time. " "Any untranslated portions of the original will be included in English in the " "resulting document. Most PO editors have an indicator " "that shows how much of the translation has been completed. This makes it " "easy for the translator to see when enough strings have been translated to " "make building the final document worthwhile." msgstr "" #. (itstool) path: example/title #: book.translate.xml:8061 msgid "Building the Spanish Porter's Handbook" msgstr "" #. (itstool) path: example/para #: book.translate.xml:8063 msgid "" "Build and preview the Spanish version of the Porter's Handbook that was " "created in an earlier example." msgstr "" #. (itstool) path: step/para #: book.translate.xml:8068 msgid "" "Build the translated document. Because the original is a book, the generated " "document is book.xml." msgstr "" #. (itstool) path: step/screen #: book.translate.xml:8072 #, no-wrap msgid "" "% cd ~/doc/es_ES.ISO8859-1/books/porters-" "handbook\n" "% make tran" msgstr "" #. (itstool) path: step/para #: book.translate.xml:8077 msgid "" "Render the translated book.xml to HTML and view it with Firefox. This is the " "same procedure used with the English version of the documents, and other " "FORMATS can be used here in the same way. See ." msgstr "" #. (itstool) path: step/screen #: book.translate.xml:8084 #, no-wrap msgid "" "% make FORMATS=html\n" "% firefox book.html" msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:8092 msgid "Submitting the New Translation" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:8094 msgid "" "Prepare the new translation files for submission. This includes adding the " "files to the version control system, setting additional properties on them, " "then creating a diff for submission." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:8099 msgid "" "The diff files created by these examples can be attached to a documentation bug report or code review." msgstr "" #. (itstool) path: example/title #: book.translate.xml:8105 msgid "Spanish Translation of the NanoBSD Article" msgstr "" #. (itstool) path: step/para #: book.translate.xml:8109 book.translate.xml:8176 msgid "" "Add a FreeBSD version string comment as the first line of the PO file:" msgstr "" #. (itstool) path: step/programlisting #: book.translate.xml:8112 book.translate.xml:8179 #, no-wrap msgid "#$FreeBSD$" msgstr "" #. (itstool) path: step/para #: book.translate.xml:8116 book.translate.xml:8183 msgid "" "Add the Makefile, the PO file, and " "the generated XML translation to version control:" msgstr "" #. (itstool) path: step/screen #: book.translate.xml:8121 #, no-wrap msgid "" "% cd ~/doc/es_ES.ISO8859-1/articles/nanobsd/\n" "% ls\n" "Makefile article.xml es_ES.po\n" "% svn add Makefile article.xml es_ES.po\n" "A Makefile\n" "A article.xml\n" "A es_ES.po" msgstr "" #. (itstool) path: step/para #: book.translate.xml:8131 book.translate.xml:8198 msgid "" "Set the Subversion svn:keywords properties on these files to FreeBSD=%H so " "$FreeBSD$ strings are expanded into the path, revision, " "date, and author when committed:" msgstr "" #. (itstool) path: step/screen #: book.translate.xml:8139 #, no-wrap msgid "" "% svn propset svn:keywords FreeBSD=%H Makefile " "article.xml es_ES.po\n" "property 'svn:keywords' set on 'Makefile'\n" "property 'svn:keywords' set on 'article.xml'\n" "property 'svn:keywords' set on 'es_ES.po'" msgstr "" #. (itstool) path: step/para #: book.translate.xml:8146 msgid "" "Set the MIME types of the files. These are text/" "xml for books and articles, and text/x-gettext-" "translation for the PO file." msgstr "" #. (itstool) path: step/screen #: book.translate.xml:8152 #, no-wrap msgid "" "% svn propset svn:mime-type text/x-gettext-" "translation es_ES.po\n" "property 'svn:mime-type' set on 'es_ES.po'\n" "% svn propset svn:mime-type text/xml article." "xml\n" "property 'svn:mime-type' set on 'article.xml'" msgstr "" #. (itstool) path: step/para #: book.translate.xml:8159 msgid "" "Create a diff of the new files from the ~/doc/ base " "directory so the full path is shown with the filenames. This helps " "committers identify the target language directory." msgstr "" #. (itstool) path: step/screen #: book.translate.xml:8164 #, no-wrap msgid "" "% cd ~/doc\n" "svn diff es_ES.ISO8859-1/articles/nanobsd/ > /tmp/es_nanobsd." "diff" msgstr "" #. (itstool) path: example/title #: book.translate.xml:8171 msgid "" "Korean UTF-8 Translation of the Explaining-BSD Article" msgstr "" #. (itstool) path: step/screen #: book.translate.xml:8188 #, no-wrap msgid "" "% cd ~/doc/ko_KR.UTF-8/articles/explaining-bsd/\n" "% ls\n" "Makefile article.xml ko_KR.po\n" "% svn add Makefile article.xml ko_KR.po\n" "A Makefile\n" "A article.xml\n" "A ko_KR.po" msgstr "" #. (itstool) path: step/screen #: book.translate.xml:8205 #, no-wrap msgid "" "% svn propset svn:keywords FreeBSD=%H Makefile " "article.xml ko_KR.po\n" "property 'svn:keywords' set on 'Makefile'\n" "property 'svn:keywords' set on 'article.xml'\n" "property 'svn:keywords' set on 'ko_KR.po'" msgstr "" #. (itstool) path: step/para #: book.translate.xml:8212 msgid "" "Set the MIME types of the files. Because these files use " "the UTF-8 character set, that is also specified. To " "prevent the version control system from mistaking these files for binary " "data, the fbsd:notbinary property is also set:" msgstr "" #. (itstool) path: step/screen #: book.translate.xml:8219 #, no-wrap msgid "" "% svn propset svn:mime-type 'text/x-gettext-" "translation; charset=UTF-8' ko_KR.po\n" "property 'svn:mime-type' set on 'ko_KR.po'\n" "% svn propset fbsd:notbinary yes ko_KR.po\n" "property 'fbsd:notbinary' set on 'ko_KR.po'\n" "% svn propset svn:mime-type 'text/xml; charset=" "UTF-8' article.xml\n" "property 'svn:mime-type' set on 'article.xml'\n" "% svn propset fbsd:notbinary yes article.xml\n" "property 'fbsd:notbinary' set on 'article.xml'" msgstr "" #. (itstool) path: step/para #: book.translate.xml:8230 msgid "" "Create a diff of these new files from the ~/doc/ base " "directory:" msgstr "" #. (itstool) path: step/screen #: book.translate.xml:8233 #, no-wrap msgid "" "% cd ~/doc\n" "svn diff ko_KR.UTF-8/articles/explaining-bsd > /tmp/ko-" "explaining.diff" msgstr "" #. (itstool) path: chapter/title #: book.translate.xml:8247 msgid "Manual Pages" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:8252 msgid "" "Manual pages, commonly shortened to man " "pages, were conceived as readily-available reminders for command " "syntax, device driver details, or configuration file formats. They have " "become an extremely valuable quick-reference from the command line for " "users, system administrators, and programmers." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:8259 msgid "" "Although intended as reference material rather than tutorials, the EXAMPLES " "sections of manual pages often provide detailed use case." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:8263 msgid "" "Manual pages are generally shown interactively by the " "man1 command. When the user types man ls, a " "search is performed for a manual page matching ls. The " "first matching result is displayed." msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:8271 msgid "Sections" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:8273 msgid "" "Manual pages are grouped into sections. Each section " "contains manual pages for a specific category of documentation:" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8281 msgid "Section Number" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8282 msgid "Category" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8288 msgid "1" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8289 msgid "General Commands" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8293 msgid "2" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8294 msgid "System Calls" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8298 msgid "3" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8299 msgid "Library Functions" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8303 msgid "4" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8304 msgid "Kernel Interfaces" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8308 msgid "5" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8309 msgid "File Formats" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8313 msgid "6" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8314 msgid "Games" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8318 msgid "7" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8319 msgid "Miscellaneous" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8323 msgid "8" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8324 msgid "System Manager" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8328 msgid "9" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8329 msgid "Kernel Developer" msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:8337 msgid "Markup" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:8339 msgid "" "Various markup forms and rendering programs have been used for manual pages. " "FreeBSD has used groff7 and the newer " "mandoc1. Most existing FreeBSD manual pages, and all new ones, use the " "mdoc7 form of markup. This is a simple line-based markup that is " "reasonably expressive. It is mostly semantic: parts of text are marked up " "for what they are, rather than for how they should appear when rendered. " "There is some appearance-based markup which is usually best avoided." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:8348 msgid "" "Manual page source is usually interpreted and displayed to the screen " "interactively. The source files can be ordinary text files or compressed " "with gzip1 to save space." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:8352 msgid "" "Manual pages can also be rendered to other formats, including PostScript for " "printing or PDF generation. See " "man1." msgstr "" #. (itstool) path: tip/para #: book.translate.xml:8357 msgid "" "Testing a new manual page can be challenging when it is not located in the " "normal manual page search path. man1 also does not look in " "the current directory. If the new manual page is in the current directory, " "prefix the filename with a ./:" msgstr "" #. (itstool) path: tip/screen #: book.translate.xml:8363 #, no-wrap msgid "% man ./mynewmanpage.8" msgstr "" #. (itstool) path: tip/para #: book.translate.xml:8365 msgid "An absolute path can also be used:" msgstr "" #. (itstool) path: tip/screen #: book.translate.xml:8367 #, no-wrap msgid "" "% man /home/xsmith/mynewmanpage.8" msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:8372 msgid "Manual Page Sections" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:8374 msgid "" "Manual pages are composed of several standard sections. Each section has a " "title in upper case, and the sections for a particular type of manual page " "appear in a specific order. For a category 1 General Command manual page, " "the sections are:" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8384 msgid "Section Name" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8391 msgid "NAME" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8392 msgid "Name of the command" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8396 msgid "SYNOPSIS" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8397 msgid "Format of options and arguments" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8401 msgid "DESCRIPTION" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8402 msgid "Description of purpose and usage" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8406 msgid "ENVIRONMENT" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8407 msgid "Environment settings that affect operation" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8412 msgid "EXIT STATUS" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8413 msgid "Error codes returned on exit" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8417 msgid "EXAMPLES" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8418 msgid "Examples of usage" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8422 msgid "COMPATIBILITY" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8423 msgid "Compatibility with other implementations" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8427 msgid "SEE ALSO" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8428 msgid "Cross-reference to related manual pages" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8432 msgid "STANDARDS" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8433 msgid "Compatibility with standards like POSIX" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8437 msgid "HISTORY" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8438 msgid "History of implementation" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8442 msgid "BUGS" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8443 msgid "Known bugs" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8447 msgid "AUTHORS" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8448 msgid "People who created the command or wrote the manual page." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:8455 msgid "" "Some sections are optional, and the combination of sections for a specific " "type of manual page vary. Examples of the most common types are shown later " "in this chapter." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:8461 msgid "Macros" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:8463 msgid "" "mdoc7 markup is based on macros. Lines that " "begin with a dot contain macro commands, each two or three letters long. For " "example, consider this portion of the ls1 manual page:" msgstr "" #. (itstool) path: sect2/programlisting #. (itstool) id: book.translate.xml#manpages-markup-macros-example-ls #: book.translate.xml:8469 #, no-wrap msgid "" "\n" ".Dd December 1, 2015 \n" ".Dt LS 1\n" ".Sh NAME \n" ".Nm ls\n" ".Nd list directory contents\n" ".Sh SYNOPSIS \n" ".Nm \n" ".Op Fl -libxo \n" ".Op Fl ABCFGHILPRSTUWZabcdfghiklmnopqrstuwxy1, \n" ".Op Fl D Ar format \n" ".Op Ar \n" ".Sh DESCRIPTION \n" "For each operand that names a\n" ".Ar file\n" "of a type other than\n" "directory,\n" ".Nm\n" "displays its name as well as any requested,\n" "associated information.\n" "For each operand that names a\n" ".Ar file\n" "of type directory,\n" ".Nm\n" "displays the names of files contained\n" "within that directory, as well as any requested, associated\n" "information." msgstr "" #. (itstool) path: callout/para #: book.translate.xml:8499 msgid "" "A Document date and Document title " "are defined." msgstr "" #. (itstool) path: callout/para #: book.translate.xml:8504 msgid "" "A Section header for the NAME section is defined. Then " "the Name of the command and a one-line Name " "description are defined." msgstr "" #. (itstool) path: callout/para #: book.translate.xml:8511 msgid "" "The SYNOPSIS section begins. This section describes the command-line options " "and arguments accepted." msgstr "" #. (itstool) path: callout/para #: book.translate.xml:8516 msgid "" "Name (.Nm) has already been defined, " "and repeating it here just displays the defined value in the text." msgstr "" #. (itstool) path: callout/para #: book.translate.xml:8522 msgid "" "An Optional Flag called -" "libxo is shown. The Fl macro adds a dash to the " "beginning of flags, so this appears in the manual page as --libxo." msgstr "" #. (itstool) path: callout/para #: book.translate.xml:8530 msgid "A long list of optional single-character flags are shown." msgstr "" #. (itstool) path: callout/para #: book.translate.xml:8535 msgid "" "An optional -D flag is defined. If the -D flag is given, it must be followed by an Argument. The argument is a format, a string that " "tells ls1 what to display and how to display it. Details on " "the format string are given later in the manual page." msgstr "" #. (itstool) path: callout/para #: book.translate.xml:8545 msgid "" "A final optional argument is defined. Because no name is specified for the " "argument, the default of file ... is used." msgstr "" #. (itstool) path: callout/para #: book.translate.xml:8551 msgid "" "The Section header for the DESCRIPTION section is " "defined." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:8556 msgid "" "When rendered with the command man ls, the result " "displayed on the screen looks like this:" msgstr "" #. (itstool) path: sect2/programlisting #: book.translate.xml:8559 #, no-wrap msgid "" "LS(1) FreeBSD General Commands Manual " "LS(1)\n" "\n" "NAME\n" " ls — list directory contents\n" "\n" "SYNOPSIS\n" " ls [--libxo] [-ABCFGHILPRSTUWZabcdfghiklmnopqrstuwxy1,] [-D format]\n" " [file ...]\n" "\n" "DESCRIPTION\n" " For each operand that names a file of a type other than directory, ls\n" " displays its name as well as any requested, associated information. " "For\n" " each operand that names a file of type directory, ls displays the names\n" " of files contained within that directory, as well as any requested,\n" " associated information." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:8575 msgid "Optional values are shown inside square brackets." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:8579 msgid "Markup Guidelines" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:8581 msgid "" "The mdoc7 markup language is not very strict. For clarity " "and consistency, the FreeBSD Documentation project adds some additional " "style guidelines:" msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:8587 msgid "Only the first letter of macros is upper case" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:8590 msgid "" "Always use upper case for the first letter of a macro and lower case for the " "remaining letters." msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:8596 msgid "Begin new sentences on new lines" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:8599 msgid "" "Start a new sentence on a new line, do not begin it on the same line as an " "existing sentence." msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:8605 msgid "" "Update .Dd when making non-trivial changes to a manual " "page" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:8609 msgid "" "The Document date informs the reader about the last " "time the manual page was updated. It is important to update whenever non-" "trivial changes are made to the manual pages. Trivial changes like spelling " "or punctuation fixes that do not affect usage can be made without updating " ".Dd." msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:8620 msgid "Give examples" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:8623 msgid "" "Show the reader examples when possible. Even trivial examples are valuable, " "because what is trivial to the writer is not necessarily trivial to the " "reader. Three examples are a good goal. A trivial example shows the minimal " "requirements, a serious example shows actual use, and an in-depth example " "demonstrates unusual or non-obvious functionality." msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:8634 msgid "Include the BSD license" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:8637 msgid "" "Include the BSD license on new manual pages. The preferred license is " "available from the Committer's Guide." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:8646 msgid "Markup Tricks" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:8648 msgid "Add a space before punctuation on a line with macros. Example:" msgstr "" #. (itstool) path: sect2/programlisting #: book.translate.xml:8651 #, no-wrap msgid ".Sh SEE ALSO\n" ".Xr geom 4 ,\n" ".Xr boot0cfg 8 ,\n" ".Xr geom 8 ,\n" ".Xr gptboot 8" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:8657 msgid "" "Note how the commas at the end of the .Xr lines have been " "placed after a space. The .Xr macro expects two " "parameters to follow it, the name of an external manual page, and a section " "number. The space separates the punctuation from the section number. Without " "the space, the external links would incorrectly point to section " "4, or 8,." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:8668 msgid "Important Macros" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:8670 msgid "" "Some very common macros will be shown here. For more usage examples, see " "mdoc7, groff_mdoc7, or search for actual " "use in /usr/share/man/man* directories. For example, to " "search for examples of the .Bd Begin display macro:" msgstr "" #. (itstool) path: sect2/screen #: book.translate.xml:8677 #, no-wrap msgid "" "% find /usr/share/man/man* | xargs zgrep '.Bd'" msgstr "" #. (itstool) path: sect3/title #: book.translate.xml:8680 msgid "Organizational Macros" msgstr "" #. (itstool) path: sect3/para #: book.translate.xml:8682 msgid "Some macros are used to define logical blocks of a manual page." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8689 msgid "Organizational Macro" msgstr "" #. (itstool) path: row/entry #. (itstool) path: sect2/title #: book.translate.xml:8690 book.translate.xml:8745 book.translate.xml:9600 #: book.translate.xml:9780 msgid "Use" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8696 msgid ".Sh" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8697 msgid "" "Section header. Followed by the name of the section, traditionally all upper " "case. Think of these as chapter titles." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8703 msgid ".Ss" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8704 msgid "" "Subsection header. Followed by the name of the subsection. Used to divide a " ".Sh section into subsections." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8711 msgid ".Bl" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8712 msgid "Begin list. Start a list of items." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8716 msgid ".El" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8717 msgid "End a list." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8721 msgid ".Bd" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8722 msgid "Begin display. Begin a special area of text, like an indented area." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8727 msgid ".Ed" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8728 msgid "End display." msgstr "" #. (itstool) path: sect3/title #: book.translate.xml:8736 msgid "Inline Macros" msgstr "" #. (itstool) path: sect3/para #: book.translate.xml:8738 msgid "Many macros are used to mark up inline text." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8744 msgid "Inline Macro" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8751 msgid ".Nm" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8752 msgid "" "Name. Called with a name as a parameter on the first use, then used later " "without the parameter to display the name that has already been defined." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8759 msgid ".Pa" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8760 msgid "Path to a file. Used to mark up filenames and directory paths." msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:8771 msgid "Sample Manual Page Structures" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:8773 msgid "" "This section shows minimal desired man page contents for several common " "categories of manual pages." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:8777 msgid "Section 1 or 8 Command" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:8779 msgid "The preferred basic structure for a section 1 or 8 command:" msgstr "" #. (itstool) path: sect2/programlisting #. (itstool) id: book.translate.xml#manpages-sample-structures-section-1-8-sample #: book.translate.xml:8782 #, no-wrap msgid "" ".Dd August 25, 2017\n" ".Dt EXAMPLECMD 8\n" ".Os\n" ".Sh NAME\n" ".Nm examplecmd\n" ".Nd \"command to demonstrate section 1 and 8 man pages\"\n" ".Sh SYNOPSIS\n" ".Nm\n" ".Op Fl v\n" ".Sh DESCRIPTION\n" "The\n" ".Nm\n" "utility does nothing except demonstrate a trivial but complete\n" "manual page for a section 1 or 8 command.\n" ".Sh SEE ALSO\n" ".Xr exampleconf 5\n" ".Sh AUTHORS\n" ".An Firstname Lastname Aq Mt flastname@example.com" msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:8803 msgid "Section 4 Device Driver" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:8805 msgid "The preferred basic structure for a section 4 device driver:" msgstr "" #. (itstool) path: sect2/programlisting #. (itstool) id: book.translate.xml#manpages-sample-structures-section-4-sample #: book.translate.xml:8808 #, no-wrap msgid "" ".Dd August 25, 2017\n" ".Dt EXAMPLEDRIVER 4\n" ".Os\n" ".Sh NAME\n" ".Nm exampledriver\n" ".Nd \"driver to demonstrate section 4 man pages\"\n" ".Sh SYNOPSIS\n" "To compile this driver into the kernel, add this line to the\n" "kernel configuration file:\n" ".Bd -ragged -offset indent\n" ".Cd \"device exampledriver\"\n" ".Ed\n" ".Pp\n" "To load the driver as a module at boot, add this line to\n" ".Xr loader.conf 5 :\n" ".Bd -literal -offset indent\n" "exampledriver_load=\"YES\"\n" ".Ed\n" ".Sh DESCRIPTION\n" "The\n" ".Nm\n" "driver provides an opportunity to show a skeleton or template\n" "file for section 4 manual pages.\n" ".Sh HARDWARE\n" "The\n" ".Nm\n" "driver supports these cards from the aptly-named Nonexistent\n" "Technologies:\n" ".Pp\n" ".Bl -bullet -compact\n" ".It\n" "NT X149.2 (single and dual port)\n" ".It\n" "NT X149.8 (single port)\n" ".El\n" ".Sh DIAGNOSTICS\n" ".Bl -diag\n" ".It \"flashing green light\"\n" "Something bad happened.\n" ".It \"flashing red light\"\n" "Something really bad happened.\n" ".It \"solid black light\"\n" "Power cord is unplugged.\n" ".El\n" ".Sh SEE ALSO\n" ".Xr example 8\n" ".Sh HISTORY\n" "The\n" ".Nm\n" "device driver first appeared in\n" ".Fx 49.2 .\n" ".Sh AUTHORS\n" ".An Firstname Lastname Aq Mt flastname@example.com" msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:8864 msgid "Section 5 Configuration File" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:8866 msgid "The preferred basic structure for a section 5 configuration file:" msgstr "" #. (itstool) path: sect2/programlisting #. (itstool) id: book.translate.xml#manpages-sample-structures-section-5-sample #: book.translate.xml:8869 #, no-wrap msgid "" ".Dd August 25, 2017\n" ".Dt EXAMPLECONF 5\n" ".Os\n" ".Sh NAME\n" ".Nm example.conf\n" ".Nd \"config file to demonstrate section 5 man pages\"\n" ".Sh DESCRIPTION\n" ".Nm\n" "is an example configuration file.\n" ".Sh SEE ALSO\n" ".Xr example 8\n" ".Sh AUTHORS\n" ".An Firstname Lastname Aq Mt flastname@example.com" msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:8886 msgid "Example Manual Pages to Use as Templates" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:8888 msgid "Some manual pages are suitable as in-depth examples." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8894 msgid "Manual Page" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8895 msgid "Path to Source Location" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8902 msgid "/usr/src/bin/cp/cp.1" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8906 msgid "" "vt4" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8907 msgid "/usr/src/share/man/man4/vt.4" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8911 msgid "" "crontab5" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8912 msgid "/usr/src/usr.sbin/cron/crontab/crontab.5" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8916 msgid "" "gpart8" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:8917 msgid "/usr/src/sbin/geom/class/part/gpart.8" msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:8925 msgid "Resources" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:8927 msgid "Resources for manual page writers:" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:8931 msgid "" "man1" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:8935 msgid "" "mandoc1" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:8939 msgid "" "groff_mdoc7" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:8943 msgid "" "Practical UNIX Manuals:" " mdoc" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:8948 msgid "" "History of UNIX " "Manpages" msgstr "" #. (itstool) path: chapter/title #: book.translate.xml:8987 msgid "Writing Style" msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:8990 msgid "Tips" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:8992 msgid "" "Technical documentation can be improved by consistent use of several " "principles. Most of these can be classified into three goals: be " "clear, be complete, and be " "concise. These goals can conflict with each other. Good writing " "consists of a balance between them." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:9001 msgid "Be Clear" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:9003 msgid "" "Clarity is extremely important. The reader may be a novice, or reading the " "document in a second language. Strive for simple, uncomplicated text that " "clearly explains the concepts." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:9008 msgid "" "Avoid flowery or embellished speech, jokes, or colloquial expressions. Write " "as simply and clearly as possible. Simple text is easier to understand and " "translate." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:9012 msgid "" "Keep explanations as short, simple, and clear as possible. Avoid empty " "phrases like in order to, which usually just means to. Avoid potentially patronizing words like basically. " "Avoid Latin terms like i.e., or cf., which may " "be unknown outside of academic or scientific groups." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:9020 msgid "" "Write in a formal style. Avoid addressing the reader as you. " "For example, say copy the file to /tmp " "rather than you can copy the file to /tmp." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:9026 msgid "" "Give clear, correct, tested examples. A trivial example " "is better than no example. A good example is better yet. Do not give bad " "examples, identifiable by apologies or sentences like but really it " "should never be done that way. Bad examples are worse than no " "examples. Give good examples, because even when warned not to use " "the example as shown, the reader will usually just use the " "example as shown." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:9035 msgid "" "Avoid weasel words like should, " "might, try, or could. These " "words imply that the speaker is unsure of the facts, and create doubt in the " "reader." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:9041 msgid "" "Similarly, give instructions as imperative commands: not you should " "do this, but merely do this." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:9047 msgid "Be Complete" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:9049 msgid "" "Do not make assumptions about the reader's abilities or skill level. Tell " "them what they need to know. Give links to other documents to provide " "background information without having to recreate it. Put yourself in the " "reader's place, anticipate the questions they will ask, and answer them." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:9058 msgid "Be Concise" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:9060 msgid "" "While features should be documented completely, sometimes there is so much " "information that the reader cannot easily find the specific detail needed. " "The balance between being complete and being concise is a challenge. One " "approach is to have an introduction, then a quick start " "section that describes the most common situation, followed by an in-depth " "reference section." msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:9071 msgid "Guidelines" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:9073 msgid "" "To promote consistency between the myriad authors of the FreeBSD " "documentation, some guidelines have been drawn up for authors to follow." msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:9079 msgid "Use American English Spelling" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:9082 msgid "" "There are several variants of English, with different spellings for the same " "word. Where spellings differ, use the American English variant. " "color, not colour, rationalize, " "not rationalise, and so on." msgstr "" #. (itstool) path: note/para #: book.translate.xml:9089 msgid "" "The use of British English may be accepted in the case of a contributed " "article, however the spelling must be consistent within the whole document. " "The other documents such as books, web site, manual pages, etc. will have to " "use American English." msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:9099 msgid "Do not use contractions" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:9102 msgid "" "Do not use contractions. Always spell the phrase out in full. Don't " "use contractions is wrong." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:9106 msgid "" "Avoiding contractions makes for a more formal tone, is more precise, and is " "slightly easier for translators." msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:9113 msgid "Use the serial comma" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:9116 msgid "" "In a list of items within a paragraph, separate each item from the others " "with a comma. Separate the last item from the others with a comma and the " "word and." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:9121 msgid "For example:" msgstr "" #. (itstool) path: blockquote/para #: book.translate.xml:9124 msgid "This is a list of one, two and three items." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:9127 msgid "" "Is this a list of three items, one, two, and " "three, or a list of two items, one and " "two and three?" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:9132 msgid "It is better to be explicit and include a serial comma:" msgstr "" #. (itstool) path: blockquote/para #: book.translate.xml:9136 msgid "This is a list of one, two, and three items." msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:9142 msgid "Avoid redundant phrases" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:9145 msgid "" "Do not use redundant phrases. In particular, the command, " "the file, and man command are often redundant." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:9149 msgid "For example, commands:" msgstr "" #. (itstool) path: informalexample/para #: book.translate.xml:9152 msgid "Wrong: Use the svn command to update sources." msgstr "" #. (itstool) path: informalexample/para #: book.translate.xml:9157 msgid "Right: Use svn to update sources." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:9161 msgid "Filenames:" msgstr "" #. (itstool) path: informalexample/para #: book.translate.xml:9164 msgid "Wrong: … in the filename /etc/rc.local…" msgstr "" #. (itstool) path: informalexample/para #: book.translate.xml:9169 msgid "Right: … in /etc/rc.local…" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:9173 msgid "" "Manual page references (the second example uses citerefentry with " "the &man.csh.1; entity):." msgstr "" #. (itstool) path: informalexample/para #: book.translate.xml:9178 msgid "Wrong: See man csh for more information." msgstr "" #. (itstool) path: informalexample/para #: book.translate.xml:9183 msgid "" "Right: See csh1." msgstr "" #. (itstool) path: varlistentry/term #: book.translate.xml:9189 msgid "Two spaces between sentences" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:9192 msgid "" "Always use two spaces between sentences, as it improves readability and " "eases use of tools such as Emacs." msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:9196 msgid "" "A period and spaces followed by a capital letter does not always mark a new " "sentence, especially in names. Jordan K. Hubbard is a good " "example. It has a capital H following a period and a " "space, and is certainly not a new sentence." msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:9205 msgid "" "For more information about writing style, see Elements of Style, by William Strunk." msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:9210 msgid "Style Guide" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:9212 msgid "" "To keep the source for the documentation consistent when many different " "people are editing it, please follow these style conventions." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:9217 msgid "Letter Case" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:9219 msgid "" "Tags are entered in lower case, para, not " "PARA." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:9222 msgid "" "Text that appears in SGML contexts is generally written in upper case, " "<!ENTITY…>, and <!DOCTYPE…>, not <!entity…> and " "<!doctype…>." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:9233 msgid "" "Acronyms should be defined the first time they appear in a document, as in: " "Network Time Protocol (NTP). After the " "acronym has been defined, use the acronym alone unless it makes more sense " "contextually to use the whole term. Acronyms are usually defined only once " "per chapter or per document." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:9241 msgid "All acronyms should be enclosed in acronym tags." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:9246 msgid "Indentation" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:9248 msgid "" "The first line in each file starts with no indentation, " "regardless of the indentation level of the file which " "might contain the current file." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:9252 msgid "" "Opening tags increase the indentation level by two spaces. Closing tags " "decrease the indentation level by two spaces. Blocks of eight spaces at the " "start of a line should be replaced with a tab. Do not use spaces in front of " "tabs, and do not add extraneous whitespace at the end of a line. Content " "within elements should be indented by two spaces if the content runs over " "more than one line." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:9260 msgid "For example, the source for this section looks like this:" msgstr "" #. (itstool) path: sect2/programlisting #: book.translate.xml:9263 #, no-wrap msgid "" "chapter\n" " title...title\n" "\n" " sect1\n" " title...title\n" "\n" " sect2\n" " titleIndentationtitle\n" "\n" " paraThe first line in each file starts " "with no indentation,\n" " emphasisregardlessemphasis of the indentation level of\n" " the file which might contain the current file.para\n" "\n" " ...\n" " sect2\n" " sect1\n" "chapter" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:9281 msgid "" "Tags containing long attributes follow the same rules. Following the " "indentation rules in this case helps editors and writers see which content " "is inside the tags:" msgstr "" #. (itstool) path: sect2/programlisting #: book.translate.xml:9286 #, no-wrap msgid "" "paraSee the link\n" " linkend=\"gmirror-troubleshooting\"Troubleshootinglink\n" " section if there are problems booting. Powering down and\n" " disconnecting the original filenameada0filename disk\n" " will allow it to be kept as an offline backup.para\n" "\n" "paraIt is also possible to journal the boot " "disk of a &os;\n" " system. Refer to the article link\n" " xlink:href=\"&url.articles.gjournal-desktop;\"Implementing UFS\n" " Journaling on a Desktop PClink for detailed\n" " instructions.para" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:9298 msgid "" "When an element is too long to fit on the remainder of a line without " "wrapping, moving the start tag to the next line can make the source easier " "to read. In this example, the systemitem element has been " "moved to the next line to avoid wrapping and indenting:" msgstr "" #. (itstool) path: sect2/programlisting #: book.translate.xml:9304 #, no-wrap msgid "" "paraWith file flags, even\n" " systemitem class=\"username\"rootsystemitem can be\n" " prevented from removing or altering files.para" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:9308 msgid "" "Configurations to help various text editors conform to these guidelines can " "be found in ." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:9314 msgid "Tag Style" msgstr "" #. (itstool) path: sect3/title #: book.translate.xml:9317 msgid "Tag Spacing" msgstr "" #. (itstool) path: sect3/para #: book.translate.xml:9319 msgid "" "Tags that start at the same indent as a previous tag should be separated by " "a blank line, and those that are not at the same indent as a previous tag " "should not:" msgstr "" #. (itstool) path: informalexample/programlisting #: book.translate.xml:9324 #, no-wrap msgid "" "article lang='en'\n" " articleinfo\n" " titleNIStitle\n" "\n" " pubdateOctober 1999pubdate\n" "\n" " abstract\n" " para...\n" " ...\n" " ...para\n" " abstract\n" " articleinfo\n" "\n" " sect1\n" " title...title\n" "\n" " para...para\n" " sect1\n" "\n" " sect1\n" " title...title\n" "\n" " para...para\n" " sect1\n" "article" msgstr "" #. (itstool) path: sect3/title #: book.translate.xml:9353 msgid "Separating Tags" msgstr "" #. (itstool) path: sect3/para #: book.translate.xml:9355 msgid "" "Tags like itemizedlist which will always have further tags inside " "them, and in fact do not take character data themselves, are always on a " "line by themselves." msgstr "" #. (itstool) path: sect3/para #: book.translate.xml:9360 msgid "" "Tags like para and term do not need other tags to " "contain normal character data, and their contents begin immediately after " "the tag, on the same line." msgstr "" #. (itstool) path: sect3/para #: book.translate.xml:9365 msgid "The same applies to when these two types of tags close." msgstr "" #. (itstool) path: sect3/para #: book.translate.xml:9368 msgid "This leads to an obvious problem when mixing these tags." msgstr "" #. (itstool) path: sect3/para #: book.translate.xml:9371 msgid "" "When a starting tag which cannot contain character data directly follows a " "tag of the type that requires other tags within it to use character data, " "they are on separate lines. The second tag should be properly indented." msgstr "" #. (itstool) path: sect3/para #: book.translate.xml:9376 msgid "" "When a tag which can contain character data closes directly after a tag " "which cannot contain character data closes, they co-exist on the same line." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:9383 msgid "Whitespace Changes" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:9385 msgid "" "Do not commit changes to content at the same time as changes to " "formatting." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:9389 msgid "" "When content and whitespace changes are kept separate, translation teams can " "easily see whether a change was content that must be translated or only " "whitespace." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:9393 msgid "" "For example, if two sentences have been added to a paragraph so that the " "line lengths now go over 80 columns, first commit the change with the too-" "long lines. Then fix the line wrapping, and commit this second change. In " "the commit message for the second change, indicate that this is a whitespace-" "only change that can be ignored by translators." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:9403 msgid "Non-Breaking Space" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:9405 msgid "" "Avoid line breaks in places where they look ugly or make it difficult to " "follow a sentence. Line breaks depend on the width of the chosen output " "medium. In particular, viewing the HTML documentation with a text browser " "can lead to badly formatted paragraphs like the next one:" msgstr "" #. (itstool) path: sect2/literallayout #: book.translate.xml:9411 #, no-wrap msgid "Data capacity ranges from 40 MB to 15\n" "GB. Hardware compression …" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:9414 msgid "" "The general entity &nbsp; prohibits line breaks " "between parts belonging together. Use non-breaking spaces in the following " "places:" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:9420 msgid "between numbers and units:" msgstr "" #. (itstool) path: listitem/programlisting #: book.translate.xml:9421 #, no-wrap msgid "57600&nbsp;bps" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:9425 msgid "between program names and version numbers:" msgstr "" #. (itstool) path: listitem/programlisting #: book.translate.xml:9426 #, no-wrap msgid "&os;&nbsp;9.2" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:9430 msgid "" "between multiword names (use with caution when applying this to more than 3-" "4 word names like The FreeBSD Brazilian Portuguese Documentation " "Project):" msgstr "" #. (itstool) path: listitem/programlisting #: book.translate.xml:9434 #, no-wrap msgid "Sun&nbsp;Microsystems" msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:9441 msgid "Word List" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:9443 msgid "" "This list of words shows the correct spelling and capitalization when used " "in FreeBSD documentation. If a word is not on this list, ask about it on the " "FreeBSD documentation project mailing list." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:9451 msgid "Word" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:9452 msgid "XML Code" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:9453 msgid "Notes" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:9459 msgid "CD-ROM" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:9461 msgid "" "acronymCD-ROMacronym" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:9465 msgid "DoS (Denial of Service)" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:9466 msgid "" "acronymDoSacronym" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:9470 msgid "email" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:9474 msgid "file system" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:9478 msgid "IPsec" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:9482 msgid "Internet" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:9486 msgid "manual page" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:9490 msgid "mail server" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:9494 msgid "name server" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:9498 msgid "Ports Collection" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:9502 msgid "read-only" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:9506 msgid "Soft Updates" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:9510 msgid "stdin" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:9511 msgid "" "varnamestdinvarname" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:9515 msgid "stdout" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:9516 msgid "" "varnamestdoutvarname" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:9520 msgid "stderr" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:9521 msgid "" "varnamestderrvarname" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:9525 msgid "Subversion" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:9527 msgid "" "applicationSubversionapplication" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:9528 msgid "" "Do not refer to the Subversion application as SVN in " "upper case. To refer to the command, use commandsvncommand." msgstr "" #. (itstool) path: row/entry #: book.translate.xml:9539 msgid "userland" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:9541 msgid "things that apply to user space, not the kernel" msgstr "" #. (itstool) path: row/entry #: book.translate.xml:9546 msgid "web server" msgstr "" #. (itstool) path: chapter/title #: book.translate.xml:9584 msgid "Editor Configuration" msgstr "" #. (itstool) path: chapter/para #: book.translate.xml:9586 msgid "" "Adjusting text editor configuration can make working on document files " "quicker and easier, and help documents conform to FDP " "guidelines." msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:9591 msgid "Vim" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:9593 msgid "" "Install from editors/vim, editors/vim-console, or editors/vim-tiny then follow the " "configuration instructions in ." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:9602 msgid "" "Press P to reformat paragraphs or text that has been " "selected in Visual mode. Press T to replace groups of eight " "spaces with a tab." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:9609 book.translate.xml:9750 msgid "Configuration" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:9611 msgid "" "Edit ~/.vimrc, adding these lines to the end of the " "file:" msgstr "" #. (itstool) path: sect2/programlisting #: book.translate.xml:9614 #, no-wrap msgid "" "if has(\"autocmd\")\n" " au BufNewFile,BufRead *.sgml,*.ent,*.xsl,*.xml call Set_SGML()\n" " au BufNewFile,BufRead *.[1-9] call ShowSpecial()\n" "endif \" has(autocmd)\n" "\n" "function Set_Highlights()\n" " \"match ExtraWhitespace /^\\s* \\s*\\|\\s\\+$/\n" " highlight default link OverLength ErrorMsg\n" " match OverLength /\\%71v.\\+/\n" " return 0\n" "endfunction\n" "\n" "function ShowSpecial()\n" " setlocal list listchars=tab:>>,trail:*,eol:$\n" " hi def link nontext ErrorMsg\n" " return 0\n" "endfunction \" ShowSpecial()\n" "\n" "function Set_SGML()\n" " setlocal number\n" " syn match sgmlSpecial \"&[^;]*;\"\n" " setlocal syntax=sgml\n" " setlocal filetype=xml\n" " setlocal shiftwidth=2\n" " setlocal textwidth=70\n" " setlocal tabstop=8\n" " setlocal softtabstop=2\n" " setlocal formatprg=\"fmt -p\"\n" " setlocal autoindent\n" " setlocal smartindent\n" " \" Rewrap paragraphs\n" " noremap P gqj\n" " \" Replace spaces with tabs\n" " noremap T :s/ /\\t/<CR>\n" " call ShowSpecial()\n" " call Set_Highlights()\n" " return 0\n" "endfunction \" Set_SGML()" msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:9656 msgid "Emacs" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:9658 msgid "" "Install from editors/emacs or editors/emacs-" "devel." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:9662 msgid "Validation" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:9664 msgid "" "Emacs's nxml-mode uses compact relax NG schemas for validating XML. A " "compact relax NG schema for FreeBSD's extension to DocBook 5.0 is included " "in the documentation repository. To configure nxml-mode to validate using " "this schema, create ~/.emacs.d/schema/schemas.xml and " "add these lines to the file:" msgstr "" #. (itstool) path: sect2/programlisting #: book.translate.xml:9672 #, no-wrap msgid "" "locatingRules xmlns=\"http://thaiopensource.com/ns/" "locating-rules/1.0\"\n" " documentElement localName=\"section\" typeId=" "\"DocBook\"\n" " documentElement localName=\"chapter\" typeId=" "\"DocBook\"\n" " documentElement localName=\"article\" typeId=" "\"DocBook\"\n" " documentElement localName=\"book\" typeId=" "\"DocBook\"\n" " typeId id=\"DocBook\" uri=\"/usr/local/share/xml/" "docbook/5.0/rng/docbook.rnc\"\n" "locatingRules" msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:9683 msgid "Automated Proofreading with Flycheck and Igor" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:9685 msgid "" "The Flycheck package is available from Milkypostman's Emacs Lisp Package " "Archive (MELPA). If MELPA is not " "already in Emacs's packages-archives, it can be added by evaluating" msgstr "" #. (itstool) path: sect2/programlisting #: book.translate.xml:9690 #, no-wrap msgid "" "(add-to-list 'package-archives '(\"melpa\" . \"http://stable.melpa.org/" "packages/\") t)" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:9692 msgid "" "Add the line to Emacs's initialization file (one of ~/.emacs, ~/.emacs.el, or ~.emacs.d/init.el) to make this change permanent." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:9698 msgid "To install Flycheck, evaluate" msgstr "" #. (itstool) path: sect2/programlisting #: book.translate.xml:9700 #, no-wrap msgid "(package-install 'flycheck)" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:9702 msgid "" "Create a Flycheck checker for textproc/igor by evaluating" msgstr "" #. (itstool) path: sect2/programlisting #: book.translate.xml:9705 #, no-wrap msgid "" "(flycheck-define-checker igor\n" " \"FreeBSD Documentation Project sanity checker.\n" "\n" "See URLs https://www.freebsd.org/docproj/ and\n" "http://www.freshports.org/textproc/igor/.\"\n" " :command (\"igor\" \"-X\" source-inplace)\n" " :error-parser flycheck-parse-checkstyle\n" " :modes (nxml-mode)\n" " :standard-input t)\n" "\n" " (add-to-list 'flycheck-checkers 'igor 'append)" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:9717 msgid "" "Again, add these lines to Emacs's initialization file to make the changes " "permanent." msgstr "" #. (itstool) path: sect2/title #: book.translate.xml:9722 msgid "FreeBSD Documentation Specific Settings" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:9724 msgid "" "To apply settings specific to the FreeBSD documentation project, create " ".dir-locals.el in the root directory of the " "documentation repository and add these lines to the file:" msgstr "" #. (itstool) path: sect2/programlisting #: book.translate.xml:9729 #, no-wrap msgid "" ";;; Directory Local Variables\n" ";;; For more information see (info \"(emacs) Directory Variables\")\n" "\n" "((nxml-mode\n" " (eval . (turn-on-auto-fill))\n" " (fill-column . 70)\n" " (eval . (require 'flycheck))\n" " (eval . (flycheck-mode 1))\n" " (flycheck-checker . igor)\n" " (eval . (add-to-list 'rng-schema-locating-files \"~/.emacs.d/schema/" "schemas.xml\"))))" msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:9743 msgid "nano" msgstr "" #. (itstool) path: sect1/para #: book.translate.xml:9745 msgid "" "Install from editors/nano or editors/nano-devel." msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:9752 msgid "" "Copy the sample XML syntax highlight file to the user's " "home directory:" msgstr "" #. (itstool) path: sect2/screen #: book.translate.xml:9755 #, no-wrap msgid "" "% cp /usr/local/share/nano/xml.nanorc ~/.nanorc" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:9757 msgid "" "Use an editor to replace the lines in the ~/.nanorc " "syntax \"xml\" block with these rules:" msgstr "" #. (itstool) path: sect2/programlisting #: book.translate.xml:9761 #, no-wrap msgid "" "syntax \"xml\" \"\\.([jrs]html?|xml|xslt?)$\"\n" "# trailing whitespace\n" "color ,blue \"[[:space:]]+$\"\n" "# multiples of eight spaces at the start a line\n" "# (after zero or more tabs) should be a tab\n" "color ,blue \"^([TAB]*[ ]{8})+\"\n" "# tabs after spaces\n" "color ,yellow \"( )+TAB\"\n" "# highlight indents that have an odd number of spaces\n" "color ,red \"^(([ ]{2})+|(TAB+))*[ ]{1}[^ ]{1}\"\n" "# lines longer than 70 characters\n" "color ,yellow \"^(.{71})|(TAB.{63})|(TAB{2}.{55})|(TAB{3}.{47}).+$\"" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:9774 msgid "Process the file to create embedded tabs:" msgstr "" #. (itstool) path: sect2/screen #: book.translate.xml:9776 #, no-wrap msgid "" "% perl -i'' -pe 's/TAB/\\t/g' ~/.nanorc" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:9782 msgid "Specify additional helpful options when running the editor:" msgstr "" #. (itstool) path: sect2/screen #: book.translate.xml:9785 #, no-wrap msgid "" "% nano -AKipwz -r 70 -T8 chapter." "xml" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:9787 msgid "" "Users of csh1 can define an alias in ~/.cshrc to automate these options:" msgstr "" #. (itstool) path: sect2/programlisting #: book.translate.xml:9791 #, no-wrap msgid "alias nano \"nano -AKipwz -r 70 -T8\"" msgstr "" #. (itstool) path: sect2/para #: book.translate.xml:9793 msgid "After the alias is defined, the options will be added automatically:" msgstr "" #. (itstool) path: sect2/screen #: book.translate.xml:9796 #, no-wrap msgid "" "% nano chapter.xml" msgstr "" #. (itstool) path: chapter/title #: book.translate.xml:9833 msgid "See Also" msgstr "" #. (itstool) path: chapter/para #: book.translate.xml:9835 msgid "" "This document is deliberately not an exhaustive discussion of XML, the DTDs " "listed, and the FreeBSD Documentation Project. For more information about " "these, you are encouraged to see the following web sites." msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:9841 msgid "The FreeBSD Documentation Project" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:9845 msgid "" "The FreeBSD " "Documentation Project web pages" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:9850 msgid "" "The FreeBSD Handbook" msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:9857 msgid "XML" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:9861 msgid "" "W3C's XML page SGML/XML web " "page" msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:9868 msgid "HTML" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:9872 msgid "" "The World Wide Web Consortium" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:9877 msgid "" "The HTML 4.0 " "specification" msgstr "" #. (itstool) path: sect1/title #: book.translate.xml:9884 msgid "DocBook" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:9888 msgid "" "The DocBook " "Technical Committee, maintainers of the DocBook DTD" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:9894 msgid "" "DocBook: The Definitive Guide, the online documentation for the DocBook DTD" msgstr "" #. (itstool) path: listitem/para #: book.translate.xml:9900 msgid "" "The DocBook Open " "Repository contains DSSSL stylesheets and other resources for people " "using DocBook" msgstr "" #. (itstool) path: appendix/para #: book.translate.xml:9945 msgid "" "These examples are not exhaustive—they do not contain all the elements that " "might be desirable to use, particularly in a document's front matter. For " "more examples of DocBook markup, examine the XML source " "for this and other documents available in the Subversion doc repository, or available online starting " "at http://svnweb.FreeBSD." "org/doc/." msgstr "" #. (itstool) path: sect1/title #. (itstool) path: example/title #: book.translate.xml:9954 book.translate.xml:9957 msgid "DocBook book" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:9959 #, no-wrap msgid "" "<!DOCTYPE book PUBLIC \"-//FreeBSD//DTD DocBook XML V5.0-Based Extension//" "EN\"\n" " \"http://www.FreeBSD.org/XML/share/xml/freebsd50.dtd\">\n" "\n" "book xmlns=\"http://docbook.org/ns/docbook\"\n" " xmlns:xlink=\"http://www.w3.org/1999/xlink\" version=\"5.0\"\n" " xml:lang=\"en\"\n" "\n" " info\n" " titleAn Example Booktitle\n" "\n" " author\n" " personname\n" " firstnameYour first namefirstname\n" " surnameYour surnamesurname\n" " personname\n" "\n" " affiliation\n" " address\n" " emailfoo@example.comemail\n" " address\n" " affiliation\n" " author\n" "\n" " copyright\n" " year2000year\n" " holderCopyright string hereholder\n" " copyright\n" "\n" " abstract\n" " paraIf your book has an abstract then it " "should go here.para\n" " abstract\n" " info\n" "\n" " preface\n" " titlePrefacetitle\n" "\n" " paraYour book may have a preface, in which " "case it should be placed\n" " here.para\n" " preface\n" "\n" " chapter\n" " titleMy First Chaptertitle\n" "\n" " paraThis is the first chapter in my book." "para\n" "\n" " sect1\n" " titleMy First Sectiontitle\n" "\n" " paraThis is the first section in my book." "para\n" " sect1\n" " chapter\n" "book" msgstr "" #. (itstool) path: sect1/title #. (itstool) path: example/title #: book.translate.xml:10015 book.translate.xml:10018 msgid "DocBook article" msgstr "" #. (itstool) path: example/programlisting #: book.translate.xml:10020 #, no-wrap msgid "" "<!DOCTYPE article PUBLIC \"-//FreeBSD//DTD DocBook XML V5.0-Based " "Extension//EN\"\n" " \"http://www.FreeBSD.org/XML/share/xml/freebsd50.dtd\">\n" "\n" "article xmlns=\"http://docbook.org/ns/docbook\"\n" " xmlns:xlink=\"http://www.w3.org/1999/xlink\" version=\"5.0\"\n" " xml:lang=\"en\"\n" "\n" " info\n" " titleAn Example Articletitle\n" "\n" " author\n" " personname\n" " firstnameYour first namefirstname\n" " surnameYour surnamesurname\n" " personname\n" "\n" " affiliation\n" " address\n" " emailfoo@example.comemail\n" " address\n" " affiliation\n" " author\n" "\n" " copyright\n" " year2000year\n" " holderCopyright string hereholder\n" " copyright\n" "\n" " abstract\n" " paraIf your article has an abstract then " "it should go here.para\n" " abstract\n" " info\n" "\n" " sect1\n" " titleMy First Sectiontitle\n" "\n" " paraThis is the first section in my " "article.para\n" "\n" " sect2\n" " titleMy First Sub-Sectiontitle\n" "\n" " paraThis is the first sub-section in my " "article.para\n" " sect2\n" " sect1\n" "article" msgstr ""