diff --git a/en_US.ISO8859-1/books/fdp-primer/Makefile b/en_US.ISO8859-1/books/fdp-primer/Makefile index 96a61ec00c..a1be3e53f1 100644 --- a/en_US.ISO8859-1/books/fdp-primer/Makefile +++ b/en_US.ISO8859-1/books/fdp-primer/Makefile @@ -1,54 +1,53 @@ # # $FreeBSD$ # # Build the FreeBSD Documentation Project Primer. # MAINTAINER=doc@FreeBSD.org DOC?= book FORMATS?= html-split html INSTALL_COMPRESSED?= gz INSTALL_ONLY_COMPRESSED?= # # SRCS lists the individual XML files that make up the document. Changes # to any of these files will force a rebuild # # XML content SRCS= book.xml SRCS+= overview/chapter.xml SRCS+= tools/chapter.xml SRCS+= working-copy/chapter.xml SRCS+= structure/chapter.xml SRCS+= doc-build/chapter.xml SRCS+= the-website/chapter.xml SRCS+= xml-primer/chapter.xml SRCS+= xhtml-markup/chapter.xml SRCS+= docbook-markup/chapter.xml SRCS+= stylesheets/chapter.xml SRCS+= translations/chapter.xml SRCS+= writing-style/chapter.xml -SRCS+= psgml-mode/chapter.xml SRCS+= editor-config/chapter.xml SRCS+= see-also/chapter.xml SRCS+= examples/appendix.xml # Images from the cross-document image library IMAGES_LIB= callouts/1.png IMAGES_LIB+= callouts/2.png IMAGES_LIB+= callouts/3.png IMAGES_LIB+= callouts/4.png IMAGES_LIB+= callouts/5.png # Entities SRCS+= chapters.ent URL_RELPREFIX?= ../../../.. DOC_PREFIX?= ${.CURDIR}/../../.. .include "${DOC_PREFIX}/share/mk/doc.project.mk" diff --git a/en_US.ISO8859-1/books/fdp-primer/book.xml b/en_US.ISO8859-1/books/fdp-primer/book.xml index e1b42f5a90..c1e16f1040 100644 --- a/en_US.ISO8859-1/books/fdp-primer/book.xml +++ b/en_US.ISO8859-1/books/fdp-primer/book.xml @@ -1,272 +1,271 @@ %chapters; ]> FreeBSD Documentation Project Primer for New Contributors The FreeBSD Documentation Project 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 DocEng $FreeBSD$ $FreeBSD$ &legalnotice; Thank you for becoming a part of the FreeBSD Documentation Project. Your contribution is extremely valuable, and we appreciate it. 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. This is a work in progress. Corrections and additions are always welcome. Preface Shell Prompts 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. User Prompt Normal user &prompt.user; root &prompt.root; Typographic Conventions This table describes the typographic conventions used in this book. Meaning Examples The names of commands. Use ls -l to list all files. The names of files. Edit .login. On-screen computer output. You have mail. What the user types, contrasted with on-screen computer output. &prompt.user; date +"The time is %H:%M" The time is 09:18 Manual page references. Use &man.su.1; to change user identity. User and group names. Only root can do this. Emphasis. The user must do this. Text that the user is expected to replace with the actual text. To search for a keyword in the manual pages, type man -k keyword Environment variables. $HOME is set to the user's home directory. Notes, Tips, Important Information, Warnings, and Examples Notes, warnings, and examples appear within the text. Notes are represented like this, and contain information to take note of, as it may affect what the user does. Tips are represented like this, and contain information helpful to the user, like showing an easier way to do something. Important information is represented like this. Typically, these show extra steps the user may need to take. 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. A Sample Example Examples are represented like this, and typically contain examples showing a walkthrough, or the results of a particular action. Acknowledgments 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. &chap.overview; &chap.tools; &chap.working-copy; &chap.structure; &chap.doc-build; &chap.the-website; &chap.xml-primer; &chap.xhtml-markup; &chap.docbook-markup; &chap.stylesheets; &chap.translations; &chap.writing-style; - &chap.psgml-mode; &chap.editor-config; &chap.see-also; &app.examples; diff --git a/en_US.ISO8859-1/books/fdp-primer/chapters.ent b/en_US.ISO8859-1/books/fdp-primer/chapters.ent index 8005f12f13..81278d507e 100644 --- a/en_US.ISO8859-1/books/fdp-primer/chapters.ent +++ b/en_US.ISO8859-1/books/fdp-primer/chapters.ent @@ -1,29 +1,28 @@ - diff --git a/en_US.ISO8859-1/books/fdp-primer/psgml-mode/chapter.xml b/en_US.ISO8859-1/books/fdp-primer/psgml-mode/chapter.xml deleted file mode 100644 index 6e8dd4ef35..0000000000 --- a/en_US.ISO8859-1/books/fdp-primer/psgml-mode/chapter.xml +++ /dev/null @@ -1,172 +0,0 @@ - - - - - Using <literal>sgml-mode</literal> with - <application>Emacs</application> - - Recent versions of Emacs or - XEmacs (available from the Ports - Collection) contain a very useful package called PSGML (can be - installed from editors/psgml). - Automatically invoked when a file with the - .xml extension is loaded, or by typing - M-x sgml-mode, it is a major mode for dealing - with SGML files, elements and attributes. - - An understanding of some of the commands provided by this mode - can make working with SGML documents such as the Handbook much - easier. - - - - C-c C-e - - - Runs sgml-insert-element. You will - be prompted for the name of the element to insert at the - current point. You can use the Tab key to - complete the element. Elements that are not valid at the - current point will be disallowed. - - The start and end tags for the element will be inserted. - If the element contains other, mandatory, elements then - these will be inserted as well. - - - - - C-c = - - - Runs sgml-change-element-name. - Place the point within an element and run this command. You - will be prompted for the name of the element to change to. - Both the start and end tags of the current element will be - changed to the new element. - - - - - C-c C-r - - - Runs sgml-tag-region. Select some - text (move to start of text, C-space, - move to end of text, C-space) and then - run this command. You will be prompted for the element to - use. This element will then be inserted immediately before - and after your marked region. - - - - - C-c - - - - Runs sgml-untag-element. Place the - point within the start or end tag of an element you want to - remove, and run this command. The element's start and end - tags will be removed. - - - - - C-c C-q - - - Runs sgml-fill-element. Will - recursively fill (i.e., reformat) content from the current - element in. The filling will affect - content in which whitespace is significant, such as within - programlisting elements, so run this - command with care. - - - - - C-c C-a - - - Runs sgml-edit-attributes. Opens a - second buffer containing a list of all the attributes for - the closest enclosing element, and their current values. - Use Tab to navigate between attributes, - C-k to remove an existing value and - replace it with a new one, C-c C-c to - close this buffer and return to the main document. - - - - - C-c C-v - - - Runs sgml-validate. Prompts you to - save the current document (if necessary) and then runs an - SGML validator. The output from the validator is captured - into a new buffer, and you can then navigate from one - troublespot to the next, fixing markup errors as you - go. - - - - - C-c / - - - Runs sgml-insert-end-tag. Inserts - the end tag for the current open element. - - - - - Doubtless there are other useful functions of this mode, but - those are the ones I use most often. - - You can also use the following entries in - .emacs to set proper spacing, indentation, - and column width for working with the Documentation - Project. - - (defun local-sgml-mode-hook - (setq fill-column 70 - indent-tabs-mode nil - next-line-add-newlines nil - standard-indent 4 - sgml-indent-data t) - (auto-fill-mode t) - (setq sgml-catalog-files '("/usr/local/share/xml/catalog"))) - (add-hook 'psgml-mode-hook - '(lambda () (local-psgml-mode-hook))) -