os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
44905 commits 1 branch 79 tags 298 MiB
Commit graph

78 commits

Author SHA1 Message Date
Warren Block
b59cbd5364 Add non-trivial indentation examples and an example of moving an element 
to the next line to improve readability.
 2014-03-08 00:15:43 +00:00
Warren Block
9490073d04 Add sample markup for stdin, stdout, and stderr. 2014-02-03 16:17:35 +00:00
Gabor Kovesdan
24d129e8d1 - Definitively upgrade to DocBook 5.0 2013-11-07 15:39:28 +00:00
Warren Block
786e4a13df Add id tags to writing style sections to make them easier to refer to 
directly as HTML links with anchors.
 2013-08-07 18:43:35 +00:00
Warren Block
14c6006e2f Whitespace-only fixes. Translators, please ignore. 2013-07-23 00:45:09 +00:00
Warren Block
f59f0aae7b More simplification and cleanups, replacement of CDATA sections with 
sgmltags.
 2013-07-23 00:40:25 +00:00
Warren Block
354974911a Whitespace-only fixes. Translators, please ignore. 2013-07-23 00:00:21 +00:00
Warren Block
89d89ebbca Fix a spelling error and simplify the acronym definition paragraph. 
Submitted by:	bjk
 2013-07-22 23:56:53 +00:00
Warren Block
0af71ffe4f Clarify the indentation section, replace the Emacs and Vim configuration 
mentions with an xref to the new editor config chapter.
 2013-07-22 20:27:54 +00:00
Warren Block
58d6e8e361 Spelling correction. Explain that two spaces come between sentences, not 
at the beginning or end of a sentence.  Modernize the acronym guidelines.
 2013-07-22 03:57:40 +00:00
Warren Block
e0d40d0885 Add a third column to the word list for notes about usage. Remove the 
  from the "Ports Collection" usage, that was unnecessary.  Add
an entry for Subversion and a note about which form to use.
 2013-07-03 00:00:54 +00:00
Warren Block
181fb984e1 Whitespace-only changes. Translators, please ignore. 2013-06-26 04:24:45 +00:00
Warren Block
7f2a4285e5 Point out that examples must be tested. 2013-06-26 04:23:10 +00:00
Warren Block
73e452b5d7 Use <sgmltag> instead of faking it. 
Submitted by:	Hiroki Sato
 2013-06-24 01:09:01 +00:00
Warren Block
3a6e0abebd Add a tip about examples. 2013-06-23 20:14:59 +00:00
Warren Block
a6e2657fd1 Improve the word list markup with brackets instead of CDATA, and add a 
non-breaking space to the Ports Collection example.
 2013-06-22 02:27:34 +00:00
Warren Block
da1e22a104 Whitespace-only fixes. Translators, please ignore. 2013-06-20 16:46:55 +00:00
Warren Block
0bd302297a Rearrange the Writing Style chapter. Move new tips to a new section, 
and organize them into clear, complete, and concise categories.
 2013-06-20 16:40:42 +00:00
Warren Block
ed146b7542 Update ancient word list in FDP. 
Reviewed by:	dru
 2013-06-17 21:17:51 +00:00
Warren Block
9592140393 Add some suggestions on writing style to the FDP. 
Reviewed by:	dru,trhodes
 2013-06-17 20:16:00 +00:00
Gabor Kovesdan
e8f02ce7e1 - MFH 2013-05-17 18:05:43 +00:00
Gabor Kovesdan
a06603e1e8 - MFH 2013-02-05 09:14:34 +00:00
Gabor Kovesdan
d95165dc16 - Make the English documentation valid XML 2013-01-21 17:37:33 +00:00
Glen Barber
6b4f60d71c Update writing style examples, replacing cvsup with svn. 2013-01-05 01:19:09 +00:00
Gabor Kovesdan
b4346b9b2d - Rename .sgml files to .xml 
- Reflect the rename in referencing files

Approved by:	doceng (implicit)
 2012-10-01 09:53:01 +00:00
Gabor Kovesdan
9c243757ef - XML declarations should use IANA encoding names 
Pointed out by:	hrs
 2012-09-14 17:47:48 +00:00
Gabor Kovesdan
2e51ec7022 - Strip unnecessary trailing spaces 
Approved by:	doceng (implicit)
 2012-08-21 19:16:02 +00:00
Gabor Kovesdan
74586f38c6 - Remove PSGML comments since they are not very useful after the XML 
migration

Approved by:		doceng (implicit)
No objection from:	doc@, www@
 2012-08-07 23:31:39 +00:00
Gabor Kovesdan
3cdf4e4922 - XMLify English books 
Approved by:	doceng (implicit)
 2012-06-21 16:04:40 +00:00
Warren Block
fe83da9b8f Whitespace-only fixes. Translators, please ignore. 2012-05-21 14:54:44 +00:00
Gabor Pali
cf43250f83 - Fix capitalization 
- Eliminate reference to books for generalization ("document")
- Use <sgmltag> where applicable
- Mark up quotes with <quote>
- Fix spelling of "non-breaking"
 2009-01-21 23:49:33 +00:00
Yaroslav Tykhiy
9e1d1c1566 Except for some rare cases, always use punctuation to finish a 
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.
 2005-09-12 16:47:36 +00:00
Marc Fonvieille
2b001b23e3 Add null-modem to the word list since it's the spelling used in our 
docs.
 2005-07-30 19:44:30 +00:00
Marc Fonvieille
f62721db3f Add a note about the possible use of British English in a contributed 
article.

Requested by:		simon
Some inspiration from:	murray
 2005-02-23 14:25:16 +00:00
Marc Fonvieille
6b6e503484 Remove Ports Collection entry, it's useless to say the things twice. 2005-02-23 13:48:19 +00:00
Tom Rhodes
8cafb9e453 When using a proper noun, capitalize it. 
PR:		77926
Submitted by:	Jesus R. Camou <jcamou@COX.net>
 2005-02-23 07:35:16 +00:00
Simon L. B. Nielsen
ca6b13e867 Change CDROM to CD-ROM in the word list, since the later seems to be 
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>
 2005-02-20 16:57:00 +00:00
Giorgos Keramidas
7b7c4e8c0d Revert last change. Adding mispelled or missing words is not too 
uncommon and 78 columns will easily grow beyond 80 when such changes
are made.
 2004-11-11 14:41:59 +00:00
Giorgos Keramidas
75fc038d53 Change the recommended line length limit from 70 characters to 78. 
This still fits under 80 columns and is not too narrow.

Noticed by:	Tillman Hodgson
 2004-11-11 08:25:26 +00:00
Ceri Davies
4dff5475f7 Consistently pluralise entries in the word list (i.e. don't). 2004-09-22 18:04:52 +00:00
Murray Stokely
727e63bc87 Add a section about acronyms to our style guide; based on what we 
hashed out on doc@ and from the O'Reilly Style Guide.
 2004-07-22 03:35:38 +00:00
Marc Fonvieille
ad4c8eed12 Add "disk label" to the word list, this will prevent people to 
be confused with the (old) command name disklabel(8) when they
will write some docs.
 2003-06-08 16:41:03 +00:00
Christian Brueffer
7aa6b25f4a Add 'IPsec' to the word list 
Requested by:	murray
 2003-04-17 02:09:32 +00:00
Tom Hukins
825301e946 Clarify the use of tabs in documentation and add a Vim configuration 
example.
 2003-04-10 21:13:09 +00:00
Ceri Davies
be816809c0 Correct a broken tag within an example: s/pubdata/pubdate/ 
PR:		docs/48817
Submitted by:	Martin Karlsson <martin.karlsson@visit.se>
 2003-03-01 18:53:38 +00:00
Christian Brueffer
a157b39ac4 Add 'Soft Updates' to the wordlist 
Approved by: ceri (mentor)
 2003-01-13 18:20:59 +00:00
Peter Pentchev
1f359cbbab /tmp/msg 2003-01-12 18:20:55 +00:00
Martin Heinen
2bfcee3890 Add a section explaining &nbsp; 
Reviewed by:	Lukasz Bojarski <ni@merkury.pol.lublin.pl>
Approved by:	murray, alex (mentor)
 2002-10-10 08:40:52 +00:00
Giorgos Keramidas
89e96b7a6b Sort wordlist. 2002-08-31 20:14:13 +00:00
Giorgos Keramidas
4a85c1d9ac Add "file system" to the wordlist. 
PR:		docs/42256
Submitted by:	Christian Brueffer <chris@unixpages.org>
 2002-08-31 20:11:25 +00:00