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

44 commits

Author SHA1 Message Date
Xin LI
e140896ec8 Escape <, >, &'s, plus some cleanups against the SGML. There should not 
be any content changes involved in this commit, however, localization
teams are encouraged to catch up with this change.

Requested by:	intron at intron ac
Reviewed by:	Niclas Zeising <lothrandil at n00b apagnu se>
Glanced by:	simon
 2006-01-05 20:03:39 +00:00
Yaroslav Tykhiy
bb532247a5 Mark up some literal text as such in order to make it easier 
to tell the literal text from the surrounding body text.
 2005-09-12 17:06:07 +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
Ceri Davies
eb2cd84505 Internet Explorer fails to render some tables generated by the 
informaltable element properly, unless the pgwide attribute is
explicitly set to 1.  Use this consistently within the (en) tree, and
update the FDP accordingly.  This should finally silence the demons in:

PR:		docs/73095
Submitted by:	Hilko Meyer <Hilko dot Meyer at gmx dot de>
 2004-11-29 21:43:38 +00:00
Murray Stokely
c0d2231745 More UK -> US spelling changes. Translators can ignore. 
PR:		docs/54999
 2004-08-02 06:01:20 +00:00
Murray Stokely
19ca5b971f Follow the rule set down in this book and use American English 
spelling.  Translators can ignore.

PR:		docs/54999
Submitted by:	Steven James Huwig <sjh13@cwru.edu>
 2004-08-02 05:43:34 +00:00
Kirill Ponomarev
882cb83f8c - Since nsgmls(1) and sgmlnorm(1) don't exist, use <command> 
tag

Approved by:	josef (mentor)
 2004-05-27 21:54:21 +00:00
Martin Heinen
0dde961ae5 Add a missing ";". 2004-04-11 09:40:52 +00:00
Ceri Davies
d385af32a6 Correct instances of "try and ...". 2004-02-25 20:07:18 +00:00
Marc Fonvieille
803f927625 - Remove an useless </dd> in one example. 
- Use of .cshrc as "startup" file for csh(1) and tcsh(1) instead of
  .login
- Some British English -> American English
  organise(d) -> organize(d)
  organisation -> organization
  generalised -> generalized

PR:		docs/54456
Submitted by:	Ken Smith <kensmith@cse.Buffalo.EDU>
 2003-07-20 20:55:18 +00:00
Peter Pentchev
1f359cbbab /tmp/msg 2003-01-12 18:20:55 +00:00
Ceri Davies
900e71c276 Bring the FDP Primer in line with the FDP Primer :) 
[s/colour/color/]
 2002-05-22 14:17:37 +00:00
Ceri Davies
1f37332cae s/in to/into/ where it makes sense. 
This commit can very likely be ignored by translators.
 2002-05-22 08:36:43 +00:00
Giorgos Keramidas
67a1702cec Remove almost all instances of "try and <verb>" from the docs. 
There is one remaining place in the fdp-primer, but that needs
a bit more work.

Inspired by:	docs/36462 (Gary W. Swearingen <swear@blarg.net>)
Reviewed by:	ceri, trhodes
 2002-04-07 23:52:37 +00:00
Giorgos Keramidas
6ddd2cc0dc Fix &entities; that lacked an ending ';' character, 
as reported by the following:

	% cd doc/en_US.ISO8859-1
	% find . -type f -name '*.sgml' |\
	  xargs grep '&[^[:space:];&][^[:space:];]*$' | grep -v '&$'
	% find . -type f -name '*.sgml' |\
	  xargs grep '&[^[:space:];&][^[:space:];]*[[:space:]<]' |\
	  grep -v '&[[: space:]]' | grep -v '[[:space:]]&&[[:space:]]'
 2002-03-27 01:16:55 +00:00
Giorgos Keramidas
c52282a36f Fix a few typos. 
PR:		docs/36334
Submitted by:	Martin Karlsson <martin.karlsson@visit.se>
 2002-03-26 22:31:57 +00:00
Michael Lucas
5ce4b99796 Correct examples of setting environment variables. 
politely pointed out by:  pirat <pirat@access.inet.co.th>
copious abuse to: mwlucas
 2002-03-06 16:47:57 +00:00
Dima Dorfman
fcfccd4a32 <port>fish</port> -> <filename role="package">fish</filename> 
Generated with:	s:<port>(.*?)</port>:<filename role="package">\1</filename>:g
 2002-02-27 05:08:13 +00:00
Michael Lucas
8c54a4e432 Mention what catalog files are. Also suggest that people set the 
FreeBSD-specific catalog files are set during this tutorial; this will
answer a common FreeBSD docproj complaint on complaints generated by
emacs.

"if it's wrong, fix it" by: nik
 2002-02-14 19:31:09 +00:00
Peter Pentchev
0837dba788 Change <filename> tags to <port> when the documentation is referring 
to ports as in the FreeBSD Ports Collection.

As pointed out by Nik and others, the <port> tag is not the best way
to mark up Ports Collection ports.  However, for the present it is
the best we have, and the least we can do is be consistent in its
usage :)

Approved as a temp "best current practice" measure by:	bmah, -doc
 2002-01-18 07:57:33 +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
Giorgos Keramidas
6f5417d33e Add aparagraph that notes CDATA and RCDATA is not validated, and 
suggest that SGML examples are validated externally.

Approved by:	   nik
Original idea by:  Michael Lucas <mwlucas@blackhelicopters.org>
 2001-11-14 01:16:34 +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
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
Murray Stokely
c0425835ca Whitespace change only. Translators please ignore. 
PR:		docs/30977
Submitted by:	Giorgos Keramidas <charon@labs.gr>
 2001-10-02 05:28:57 +00:00
Chern Lee
6dbf07d805 Fix/Standardize: 
internet -> Internet
can not -> cannot
CD-ROM -> CDROM
cdrom -> CDROM
UNIX -> Unix

To be standardized with the rest of the doc tree.

Approved by:	murray
 2001-07-17 20:51:52 +00:00
Nik Clayton
ab06efc7f1 Update a few paths. 2001-07-13 20:49:35 +00:00
Nik Clayton
0825dcbd59 Switch to the 4.1 based DTD. 
Include some initial experiments in indexing, turned off by default.
 2001-04-17 16:16:19 +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
Jim Mock
54691fd18d Remove the paragraph about the Kinder, Gentler HTML Validator FAQ since it 
(the FAQ) no longer exists, and validator.w3.org isn't really relevant in
this situation.  Also removed the %not.published; bits around it.

PR:		22419
Submitted by:	Paul Fardy <pdf+fdp@mun.ca>
 2000-11-01 22:38:35 +00:00
Nik Clayton
5e0002d7f0 <command> -> <userinput> in an example, to be consistent with how we tell 
people it should be done.  Noticed this when browsing the KDE DocBook
documentation, which makes exactly the same mistake.
 2000-10-31 19:36:16 +00:00
Nik Clayton
0b2a4d0ef9 Fix an example to reflect real life. Pointed out by 'marko'. 2000-08-08 18:25:31 +00:00
Daniel Harris
6fd8dbb265 Fixed lots of typos, thinkos and grammar errors. I ran this by Nik a while 
back, since he's the only one who's touched most of the fdp-primer.

Reviewed by:	nik
 2000-07-07 18:38:38 +00:00
Alexander Langer
2b4119f699 Since the author of the "Gentler HTML Validator" page has removed his 
page due to the new W3C validator service, temporarily do not publish
the "more info about nsgmls error codes can be found ..." paragraph,
until a similar page is available.

PR:		18343
Submitted by:	Paul Southworth <pauls@etext.org>
Reviewed by:	jim
 2000-06-14 19:01:53 +00:00
Nik Clayton
fc7dbfdd09 Fix an incorrectly broken line in an example. 2000-04-30 23:00:03 +00:00
Peter Wemm
5ff728b8ca $Id$ -> $FreeBSD$ 1999-09-06 06:53:43 +00:00
Nik Clayton
f4ca19b7a8 Miscellaneous small changes. 
Note:  includes whitespace changes.  No active translations of this
document exist, so this doesn't matter.
 1999-09-03 17:14:12 +00:00
Nik Clayton
4c8ac2ce81 Add a link to a page which goes in to much more detail about possible 
errors from nsgmls(1).
 1999-07-30 21:25:50 +00:00
Nik Clayton
6c26cf33ae Whitespace changes, to pretty the formatting after the previous commit. 
Translation teams can ignore this.
 1999-07-30 20:51:01 +00:00
Nik Clayton
91e1bb6c80 * Prepend "sgml-primer-" to id attributes which did not already have it. 
*  Add 'id="sgml-primer-marked-sections"' to the "Marked Sections"
    section.
 1999-07-28 20:04:30 +00:00
Nik Clayton
53b2194d39 Added $Id$. 1999-07-14 19:27:15 +00:00
Nik Clayton
c8e143d7f6 Update the DocBook version numbers used in examples. 1999-06-03 19:51:26 +00:00
Nik Clayton
2e9532f588 Fix typos, rewrite a couple of paragraphs, add some new paragraphs to be 
a bit cleaer on some things.
 1999-04-29 20:07:56 +00:00
Nik Clayton
c4ab126805 My primer for people new to the Doc. Proj. Incomplete, but should be 
enough for most people, and gets it into the repository, making it
easier for others to add to as necessary.

This has not (yet) been turned on in the upper level Makefile or
listed on the web site yet, I want to get some more feedback
from readers first.  It should be "made visible" later this week.
 1999-04-20 20:59:59 +00:00