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

49 commits

Author SHA1 Message Date
Giorgos Keramidas
9d95fe07bf Don't suggest that people add both a $Date$ and $Id$ RCS keyword 
to their documents.  Also change $Id$ to $FreeBSD$ in the output.

Submitted by:	Christian Brueffer <chris@unixpages.org>
 2002-10-08 01:27:37 +00:00
Marc Fonvieille
7a7cfccc15 Add missing parentheses and a missing slash for a markup example. 
While I'm there: expand OS to operating system.

PR:		docs/41724
Submitted by:	Christian Brueffer <chris@unixpages.org>
 2002-08-17 15:23:49 +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
Peter Pentchev
767c635e20 Whitespace-only fixups for the committers and lists entities conversion. 2002-03-15 07:57:16 +00:00
Peter Pentchev
eed41e97e6 Convert the names, descriptions and e-mail addresses of FreeBSD 
committers and mailing lists to &a.xxx; entities.

Reviewed by:	keramida
Approved by:	keramida, silence on -doc
 2002-03-15 07:46:22 +00:00
Dima Dorfman
60c2283e72 Change the <filename role="package"> example to make it clear in the 
rendered version that "net/ethereal" (the example port) is a port.
I.e., change "Install net/ethereal" to "Install the net/ethereal
port".  I think this is how it should be done.  Nothing about
"net/ethereal" (or any other port described in this way) makes it
clear that this is indeed a port.  We can see that from the source,
but to a new user reading the rendered version it's a mystery.
 2002-03-03 02:30:13 +00:00
Dima Dorfman
e3035101be Replace mention of the <port> tag with the new <filename>-based syntax. 2002-03-03 01:39:24 +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
Peter Pentchev
a3d3aeaf0b Add a description of the <quote> tag. 
Reported by:	Tom Rhodes <darklogik@pittgoth.com>
Reviewed by:	dd
Approved by:	dd
 2002-02-26 07:23:41 +00:00
Giorgos Keramidas
c1ffcd271e Change <portname> to <port> to make example caption match sgml sample. 
PR:		docs/34662
Submitted by:	Hiten Pandya <hiten@uk.FreeBSD.org>
 2002-02-11 01:58:44 +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
Bruce A. Mah
7abba1b857 Document "port" tag. From the PR, but with the text moved to a more 
suitable section (DocBook vs. HTML section) and with an explanatory
note that this element is a FreeBSD extension to DocBook.

PR:		31934
Submitted by:	mwlucas@blackhelicopters.org
 2001-11-13 18:07:39 +00:00
Bruce A. Mah
edf26dccd4 Document the "errorname" tag. 
PR:		31776
Submitted by:	Michael Lucas <mwlucas@blackhelicopters.org>
 2001-11-13 08:14:49 +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
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
Murray Stokely
ec23fd4f46 Fix a couple of links. 
PR:		docs/30976
Submitted by:	Giorgos Keramidas <charon@labs.gr>
 2001-10-02 05:24:37 +00:00
Dima Dorfman
7e74e35582 Remove extra word. 
Submitted by:	Vladimir Tchoukharev <chu@gpi.ru>
 2001-08-12 19:41:44 +00:00
Chern Lee
3e8d98b70a Standardize: 
TCL -> Tcl
ethernet -> Ethernet
ftp (noun) -> FTP

Approved by:	murray
 2001-07-17 22:20:51 +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
ee67001995 Show how to mark up keys, mouse buttons, and combinations (chords). 2001-07-15 11:17:05 +00:00
Nik Clayton
35548e2f83 Remove out of date info about Linuxdoc. 2001-07-13 20:49:09 +00:00
Jens Schweikhardt
e097e09cb4 Fixed word doubling typo. 2001-07-08 15:40:29 +00:00
Dima Dorfman
7523715ba7 Spelling police: seperate -> separate. 2001-07-05 08:47:55 +00:00
Dima Dorfman
b0c3cb4fcc Remove duplicate words where appropriate. 
Inspired by:    PRs 28356, 28359; tyler spivey <tspivey8@home.com>
 2001-06-23 06:57:06 +00:00
Andrey A. Chernov
f749b200c1 ISO_* -> ISO* rename 2001-06-11 01:20:40 +00:00
Nik Clayton
65eeebe181 <artheader> -> <articleinfo> in some examples. 
Submitted by:	bmah
 2001-04-19 15:23:20 +00:00
Nik Clayton
61bdf41454 Update to 4.1 based DTD. 2001-04-17 16:02:54 +00:00
Nik Clayton
c733231fdb Document <hostid role="ip6addr">. 2001-01-03 11:12:41 +00:00
Nik Clayton
ba824a5525 Link to the cvsweb location of the freebsd.dtd file. 2000-10-29 21:18:42 +00:00
Nik Clayton
4736b10acc Describe how to go about adding images to the documentation. A little 
rushed, but it should be enough to get people using it, and, more
importantly, improving on it.
 2000-10-29 20:20:25 +00:00
Ben Smithurst
5e68ff95c6 Fix some example SGML source so it matches the text which shows what the 
output of that source looks like.
 2000-07-17 19:01:58 +00:00
Nik Clayton
112fe8d108 Remove the text saying "I don't know how to do callouts", because now I 
do.  Replace it with some examples showing how to do callouts.

Replace "&amp;man.sendmail.8;" with "&man.sendmail.8;".
 2000-07-16 16:40:09 +00:00
Alexander Langer
7ea95b9737 Fix typo: "Linking to a named part of another document" 
-> "... of the same document"

PR:		19941
Submitted by:	John <jpapalia@wondermutt.net>
 2000-07-15 07:47:55 +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
Peter Wemm
af1a8b8612 Change www.freebsd.org/~user to people.FreeBSD.org/~user - the days of 
the former are numbered.  There are still plenty of days left, but don't
add more.
 2000-02-08 19:39:12 +00:00
Jeroen Ruigrok van der Werven
9b88077cb2 Fix a erroneous bookinfo into an artheader. 
PR:		16135
Submitted by:	Karlheinz Eckmeier <Karlheinz.Eckmeier@t-online.de>
 2000-01-16 22:05:58 +00:00
Peter Wemm
5ff728b8ca $Id$ -> $FreeBSD$ 1999-09-06 06:53:43 +00:00
Nik Clayton
97fe3901a9 Miscellaneous small changes. Includes reformatting white space in some 
of the example HTML and DocBook fragments, which are significant.

Explain where to find the FreeBSD DTD that extends DocBook.

Add a section explaining about books and articles, and the differences
between them.

Added an example of <procedure>.

Be consistent with the white space inside <programlisting>.  Make sure
that content starts immediately after the opening tag.  Shouldn't make
a great deal of difference, but we should practice what we preach.

Remove the information about <informalexample>, as it seems to be
redundant, and we don't use it anymore.

Correct an error ("]]", should be "]") in the example of including the manual
page reference entities.
 1999-09-03 17:16:06 +00:00
John Baldwin
6c26ae8336 Fix a broken tag. </para> -> </title> 
PR:		docs/13465
Submitted by:	Mark Ovens <mark@ukug.uk.freebsd.org>
 1999-08-30 11:53:03 +00:00
John Baldwin
cd08f5c92f Lots of [fF]ree(bsd|BSD).(org|ORG) -> FreeBSD.org fixups. 
A few doc@FreeBSD.org -> freebsd-doc@FreeBSD.org fixes.

One freebsd -> FreeBSD name fix.

Reviewed by:	nik
 1999-08-29 16:08:47 +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
efb2ef57fc Prepend "sgml-primer-" to some <xref> targets. 1999-07-28 20:06:03 +00:00
Nik Clayton
3897793a51 Stop documenting the non-existent <listentry> element, and start 
documenting the <listitem> element instead.  D'oh.

Also, add an $Id$ string while I'm here.

Submitted by:	Tim Vanderhoek <vanderh@ecf.utoronto.ca>
 1999-07-14 19:06:23 +00:00
Nik Clayton
74a2787fa0 List v3.1 of the DTD in the examples. 1999-06-03 19:48:57 +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