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

57 commits

Author SHA1 Message Date
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
Bruce A. Mah
da3df16f33 Unbreak doc/web build. 2002-08-18 00:56:58 +00:00
Marc Fonvieille
24a0a68339 More consistency in capitalization of applications name. 2002-08-17 19:59:21 +00:00
Giorgos Keramidas
96e9fe2ad3 Expand contractions in the fdp-primer. 
Also replace a few erroneous "it's" with the possessive "its".
 2001-12-08 12:12:47 +00:00
Nik Clayton
19b04dea07 Damn. "rationalize" -> "rationalise". 2001-11-30 09:50:48 +00:00
Nik Clayton
bb399b1df9 Note that American English is the preferred variant for spelling. 2001-11-29 23:20:56 +00:00
Chern Lee
efda86a986 Spelling Fixes: 
* overridable -> overridden
 * documention -> documentation
 * preceeding -> preceding
 * preceeded -> preceded
 * harddisk -> hard disk
 * analagous -> analogous
 * togther -> together
 * timelines -> time lines
 * philisophy-> philosophy
 * differentation -> differentiation
 * knowledgable -> knowledgeable
 * occurence -> occurrence
 * occured -> occurred
 * greek -> Greek
 * aready -> already
 * commandline -> command line
 * latin -> Latin
 * seperate -> separate
 2001-10-31 23:47:32 +00:00
Murray Stokely
bc83273cff * Correct some links 
* Use ftp.hostname.com/directory rather than
  ftp.hostname.com:directory.
* s/freebsd.org/FreeBSD.org/
* Use relative links for FreeBSD.org documents

PR:		31447
Submitted by:	Cyrille Lefevre
Found by:	linbot
 2001-10-23 21:54:19 +00:00
Giorgos Keramidas
4593fd98a7 Sweep through english docs and replace &ldquot; and friends with <quote>. 
Approved by:	nik
 2001-10-10 11:47:30 +00:00
Jim Mock
91144d52bc Add "name server", "web server", and "mail server" to the word list. 2001-08-11 21:45:32 +00:00
Jim Mock
69fe2fd10d Add "manual page(s)" to the word list. 2001-08-11 21:42:06 +00:00
Jim Mock
df1201d01a Whitespace changes only -- translators can ignore this commit. 
Since the word list is in the doc project primer, it should follow the
style that's talked about throughout the primer :-)
 2001-08-05 18:59:48 +00:00
Jim Mock
f264b96d44 Add "email" to the word list. 
Submitted by:	murray
 2001-08-05 18:54:51 +00:00
Chern Lee
55d17b252c Add: 
DoS (Denial of Service)
FreeBSD Ports Collection
ports collection
to word list.

Reviewed by:	murray
 2001-07-27 01:17:35 +00:00
Dima Dorfman
fb12aad004 Remove ``cannot'' from the word list. We aren't building a 
dictionary, so it doesn't make sense to list common, every-day words
with well-known spellings.  Besides, "can not" is a proper, albeit
confusing, construct.  For example:

	The quick brown fox can not jump over the lazy dog.

The above isn't saying that the fox isn't capable of jumping over the
dog, but rather that the fox is capable of *not* jumping over it
(e.g., it can walk around it).  It is confusing (and should be
avoided), but nonetheless valid, English.
 2001-07-19 14:08:57 +00:00
Chern Lee
24f820a21d Add Internet, MHz, and Unix to official word list. 
Approved by:	murray
 2001-07-17 01:24:58 +00:00
Murray Stokely
cb5cb5afc9 Add the beginnings of a small word list and link to the O'Reilly word 
list for more comprehensive coverage.
 2001-07-15 00:16:23 +00:00
Nik Clayton
65eeebe181 <artheader> -> <articleinfo> in some examples. 
Submitted by:	bmah
 2001-04-19 15:23:20 +00:00
Dima Dorfman
caa6994914 DocBook police: open and close tags for <programlisting> should cuddle 
up to the contents within.

Approved by:	nik
 2001-04-09 00:33:58 +00:00
Dima Dorfman
7330e75047 Mention that tabs should be used in the beginning of a line where more 
than 8 spaces would have been used.

Reviewed by:	nik, jim
 2001-04-05 01:47:13 +00:00
Mark Ovens
345926cba7 Nuke "Special tags" in the Writing Sytle section 
Approved by:	nik
 2000-08-08 23:39:14 +00:00
Kevin Lo
dc8797c2c1 Fix spelling and nits. 
PR: 19267
Submitted by: Daniel Harris <dannyboy@subdimension.com>
 2000-06-15 01:00:01 +00:00