aboutsummaryrefslogtreecommitdiff
path: root/en_US.ISO8859-1/books/fdp-primer/writing-style
Commit message (Collapse)AuthorAgeFilesLines
* Wrap long lines, properly indent tags, capitalizations, and other fixes forBenedict Reuschling2018-08-171-6/+15
| | | | | | | issues that textproc/igor reported. Notes: svn path=/head/; revision=52151
* Add missing xml:id to sectx elements.Mathieu Arnold2018-04-171-1/+1
| | | | | | | Sponsored by: Absolight Notes: svn path=/head/; revision=51563
* This experimental commit removes all $FreeBSD$ strings from the FDPWarren Block2017-06-071-1/+0
| | | | | | | | | | | | | | Primer because these continually-changing strings interfere with PO translations. They text version in the file is also potentially inaccurate. The FreeBSD=%H property has also been removed from these files, although without $FreeBSD$ strings, it has no effect. The fbsd:nokeywords property has been set to "yes" to allow the commit. NO INFORMATION HAS BEEN LOST. The version control information is stored in the metadata and can be retrieved with 'svn info [file]'. Notes: svn path=/head/; revision=50331
* Add "userland" to the word list.Warren Block2016-03-281-0/+7
| | | | Notes: svn path=/head/; revision=48493
* Swap two words transposed.Warren Block2015-10-011-1/+1
| | | | Notes: svn path=/head/; revision=47469
* - remove extraneous markupJason Helfman2014-11-131-1/+1
| | | | | | | | Differential Revision: https://reviews.freebsd.org/D1153 Approved by: bcr (mentor) Notes: svn path=/head/; revision=45974
* Add non-trivial indentation examples and an example of moving an elementWarren Block2014-03-081-0/+27
| | | | | | | to the next line to improve readability. Notes: svn path=/head/; revision=44192
* Add sample markup for stdin, stdout, and stderr.Warren Block2014-02-031-0/+15
| | | | Notes: svn path=/head/; revision=43734
* - Definitively upgrade to DocBook 5.0Gabor Kovesdan2013-11-071-68/+58
| | | | Notes: svn path=/projects/db5/; revision=43125
* Add id tags to writing style sections to make them easier to refer toWarren Block2013-08-071-7/+7
| | | | | | | directly as HTML links with anchors. Notes: svn path=/head/; revision=42520
* Whitespace-only fixes. Translators, please ignore.Warren Block2013-07-231-15/+22
| | | | Notes: svn path=/head/; revision=42392
* More simplification and cleanups, replacement of CDATA sections withWarren Block2013-07-231-61/+55
| | | | | | | sgmltags. Notes: svn path=/head/; revision=42391
* Whitespace-only fixes. Translators, please ignore.Warren Block2013-07-231-13/+12
| | | | Notes: svn path=/head/; revision=42390
* Fix a spelling error and simplify the acronym definition paragraph.Warren Block2013-07-221-5/+3
| | | | | | | Submitted by: bjk Notes: svn path=/head/; revision=42389
* Clarify the indentation section, replace the Emacs and Vim configurationWarren Block2013-07-221-34/+17
| | | | | | | mentions with an xref to the new editor config chapter. Notes: svn path=/head/; revision=42382
* Spelling correction. Explain that two spaces come between sentences, notWarren Block2013-07-221-24/+20
| | | | | | | at the beginning or end of a sentence. Modernize the acronym guidelines. Notes: svn path=/head/; revision=42368
* Add a third column to the word list for notes about usage. Remove theWarren Block2013-07-031-2/+15
| | | | | | | |   from the "Ports Collection" usage, that was unnecessary. Add an entry for Subversion and a note about which form to use. Notes: svn path=/head/; revision=42121
* Whitespace-only changes. Translators, please ignore.Warren Block2013-06-261-8/+8
| | | | Notes: svn path=/head/; revision=42059
* Point out that examples must be tested.Warren Block2013-06-261-2/+2
| | | | Notes: svn path=/head/; revision=42058
* Use <sgmltag> instead of faking it.Warren Block2013-06-241-2/+2
| | | | | | | Submitted by: Hiroki Sato Notes: svn path=/head/; revision=42019
* Add a tip about examples.Warren Block2013-06-231-1/+11
| | | | Notes: svn path=/head/; revision=42006
* Improve the word list markup with brackets instead of CDATA, and add aWarren Block2013-06-221-3/+4
| | | | | | | non-breaking space to the Ports Collection example. Notes: svn path=/head/; revision=41999
* Whitespace-only fixes. Translators, please ignore.Warren Block2013-06-201-129/+132
| | | | Notes: svn path=/head/; revision=41971
* Rearrange the Writing Style chapter. Move new tips to a new section,Warren Block2013-06-201-60/+80
| | | | | | | and organize them into clear, complete, and concise categories. Notes: svn path=/head/; revision=41970
* Update ancient word list in FDP.Warren Block2013-06-171-84/+75
| | | | | | | Reviewed by: dru Notes: svn path=/head/; revision=41940
* Add some suggestions on writing style to the FDP.Warren Block2013-06-171-1/+56
| | | | | | | Reviewed by: dru,trhodes Notes: svn path=/head/; revision=41937
* - MFHGabor Kovesdan2013-05-171-0/+4
| | | | Notes: svn path=/projects/xml-tools/; revision=41643
* - MFHGabor Kovesdan2013-02-051-2/+2
|\ | | | | | | Notes: svn path=/projects/xml-tools/; revision=40889
| * Update writing style examples, replacing cvsup with svn.Glen Barber2013-01-051-2/+2
| | | | | | | | Notes: svn path=/head/; revision=40542
* | - Make the English documentation valid XMLGabor Kovesdan2013-01-211-2/+2
|/ | | | Notes: svn path=/projects/xml-tools/; revision=40699
* - Rename .sgml files to .xmlGabor Kovesdan2012-10-011-0/+0
| | | | | | | | | - Reflect the rename in referencing files Approved by: doceng (implicit) Notes: svn path=/head/; revision=39631
* - XML declarations should use IANA encoding namesGabor Kovesdan2012-09-141-1/+1
| | | | | | | Pointed out by: hrs Notes: svn path=/head/; revision=39544
* - Strip unnecessary trailing spacesGabor Kovesdan2012-08-211-1/+1
| | | | | | | Approved by: doceng (implicit) Notes: svn path=/projects/sgml2xml/; revision=39416
* - Remove PSGML comments since they are not very useful after the XMLGabor Kovesdan2012-08-071-12/+0
| | | | | | | | | | migration Approved by: doceng (implicit) No objection from: doc@, www@ Notes: svn path=/projects/sgml2xml/; revision=39335
* - XMLify English booksGabor Kovesdan2012-06-211-5/+6
| | | | | | | Approved by: doceng (implicit) Notes: svn path=/projects/sgml2xml/; revision=39087
* Whitespace-only fixes. Translators, please ignore.Warren Block2012-05-211-116/+125
| | | | Notes: svn path=/head/; revision=38872
* - Fix capitalizationGabor Pali2009-01-211-19/+19
| | | | | | | | | | - Eliminate reference to books for generalization ("document") - Use <sgmltag> where applicable - Mark up quotes with <quote> - Fix spelling of "non-breaking" Notes: svn path=/head/; revision=33733
* Except for some rare cases, always use punctuation to finish aYaroslav Tykhiy2005-09-121-3/+3
| | | | | | | | | | sentence at the end of a paragraph so that the readers don't think that some text is missing. Consistently use colons to finish sentences introductory to examples. Notes: svn path=/head/; revision=25615
* Add null-modem to the word list since it's the spelling used in ourMarc Fonvieille2005-07-301-0/+4
| | | | | | | docs. Notes: svn path=/head/; revision=25277
* Add a note about the possible use of British English in a contributedMarc Fonvieille2005-02-231-0/+8
| | | | | | | | | | article. Requested by: simon Some inspiration from: murray Notes: svn path=/head/; revision=23861
* Remove Ports Collection entry, it's useless to say the things twice.Marc Fonvieille2005-02-231-5/+1
| | | | Notes: svn path=/head/; revision=23860
* When using a proper noun, capitalize it.Tom Rhodes2005-02-231-1/+1
| | | | | | | | PR: 77926 Submitted by: Jesus R. Camou <jcamou@COX.net> Notes: svn path=/head/; revision=23859
* Change CDROM to CD-ROM in the word list, since the later seems to beSimon L. B. Nielsen2005-02-201-1/+1
| | | | | | | | | | | | | | | | | | | | | most widely used. This is not really a change of policy, just documenting the current de facto policy. Quoting blackend (but don't blame this commit on him): CD-ROM seems to be the more widely used spelling, most of new additions use CD-ROM, "legacy" docs use CDROM. Since CD-ROM may be seen as the right solution, let's keep the old spelling for the moment and just use CD-ROM in every new additions. Semi-intresting google statistics: 9,950,000 hits for CDROM, 28,800,000 hits for "CD-ROM". PR: docs/77535 Submitted by: Jesus R. Camou <jcamou@cox.net> Notes: svn path=/head/; revision=23838
* Revert last change. Adding mispelled or missing words is not tooGiorgos Keramidas2004-11-111-1/+1
| | | | | | | | uncommon and 78 columns will easily grow beyond 80 when such changes are made. Notes: svn path=/head/; revision=22921
* Change the recommended line length limit from 70 characters to 78.Giorgos Keramidas2004-11-111-1/+1
| | | | | | | | | This still fits under 80 columns and is not too narrow. Noticed by: Tillman Hodgson Notes: svn path=/head/; revision=22919
* Consistently pluralise entries in the word list (i.e. don't).Ceri Davies2004-09-221-1/+1
| | | | Notes: svn path=/head/; revision=22434
* Add a section about acronyms to our style guide; based on what weMurray Stokely2004-07-221-0/+19
| | | | | | | hashed out on doc@ and from the O'Reilly Style Guide. Notes: svn path=/head/; revision=21613
* Add "disk label" to the word list, this will prevent people toMarc Fonvieille2003-06-081-0/+4
| | | | | | | | be confused with the (old) command name disklabel(8) when they will write some docs. Notes: svn path=/head/; revision=17201
* Add 'IPsec' to the word listChristian Brueffer2003-04-171-0/+4
| | | | | | | Requested by: murray Notes: svn path=/head/; revision=16580
* Clarify the use of tabs in documentation and add a Vim configurationTom Hukins2003-04-101-8/+17
| | | | | | | example. Notes: svn path=/head/; revision=16527
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-13 18:06:11 +0000