Commit graph

78 commits

Author SHA1 Message Date
Gabor Pali
320234e680 Fix a typo
Submitted by:	wxs
2010-03-14 22:26:02 +00:00
Marc Fonvieille
4e25eebf62 Fix a broken link.
Found by:	Anton Shterenlikht <mexas@bristol.ac.uk>
2009-07-08 12:16:32 +00:00
Gabor Pali
7c39370311 - Fix title capitalization style 2008-12-07 22:03:48 +00:00
Gabor Pali
97a6f5b924 - Simplify <URL: link> notation
- Capitalize and add non-breakable spaces to "Ports Collection"
- s/of/or in "number of rows of columns"
- Mark up some attributes and literals with <literal> elements
- Eliminate first-person narration
- Add more generalization to the text, refer to the Handbook as an
  example
- Update path names of the Handbook sources
- Add missing text to the <blockquote> example
- Add a table with borders to the examples
- Simplify some parts of the manual page markup example
- Fix all sendmail-related manual page sections
- Fix example of <hostid>
- Remove <informalexample> tags from the <screen> example
- Add missing parentheses

Reviewed by:	gabor, manolis, rene
Obtained from:	The FreeBSD Hungarian Documentation Project
2008-12-06 22:09:01 +00:00
Gabor Pali
4bd036779d - Fix capitalization according to the "headline style" of Chicago Manual
of Style (15th Edition), paragraph 8.167

Reviewed by:	gabor, manolis, rene
2008-12-06 21:54:40 +00:00
Marc Fonvieille
7afd9e8652 Add class="directory" attribute in the code example for a directory
name.
2006-04-28 12:39:55 +00:00
Yaroslav Tykhiy
49ef810ece Don't set an example of ignoring the recommended style:
spell it "email", not "e-mail".
2005-09-12 17:14:28 +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
Yaroslav Tykhiy
1a445039a6 Don't give a poor advice of omitting <p> tags in HTML.
In the presence of CSS, wrapping text in <p></p>
can make it render quite differently.

PR:	docs/85928 (in the audit trail)
2005-09-12 16:09:11 +00:00
Yaroslav Tykhiy
a08f137b33 Don't give a poor example of letting special characters slip
into text cut'n'pasted to a <pre> HTML element.  Warn readers
that such characters are likely to appear in plain-text sources
often used to copy pre-formatted text from.
2005-09-12 16:01:07 +00:00
Tom Rhodes
197a2b3bc3 Quick grammar fix.
PR:		77288
Inspired by:	Jesus R. Camou <jcamou@cox.net>
2005-02-24 04:04:15 +00:00
Giorgos Keramidas
36560f933a "To render" or "to be rendered" is ok. "To rendered" is not. 2005-01-06 05:07:25 +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
Marc Fonvieille
837793f692 Punctuation fix. 2004-08-11 20:01:35 +00:00
Denis Peplin
c12c11040e Use url entities for links between docs 2004-08-05 10:04:31 +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
Murray Stokely
d05594021a Add 'frame="none"' attribute to <informaltable>s. 2004-07-09 09:50:34 +00:00
Hiroki Sato
84f8ee0a15 Use relative URLs when URL_RELPREFIX is defined and URLS_ABSOLUTE
is not defined.

- URL_RELPREFIX must always point the top page's URL
  (http://www.FreeBSD.org) in relative form, defined in Makefile.

- &url.base; can be used in doc/<langcode>/*.  It will be
  replaced with the real URL which points the top page.

For translators: Please make sure to define URL_RELPREFIX to
point the top page.  The localized docs have different directory
hierarchy in its URL from the English version.

Tested by:	den
2004-07-06 15:09:55 +00:00
Nik Clayton
3d68db2b1d Disentangle myself from the Primer.
Prompted by: http://www.oreillynet.com/pub/wlg/5091
2004-06-23 09:16:46 +00:00
Denis Peplin
bf2a771582 Use &url.main; for references to main FreeBSD website
Ihis entity auto-replaced with ../../../.. by default
and with http://www.FreeBSD.org/ when URLS_ABSOLUTE is set
(used for mirrors and for release building accordingly)
2004-05-11 13:29:48 +00:00
Marc Fonvieille
fe4878a69d Add missing closing tags not found by nsgmls, and fix the case of some
tags.

PR:		docs/56231
Submitted by:	Denis Peplin <den@freebsd-doc.org.ru>
2003-08-31 16:41:36 +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
Giorgos Keramidas
6f32c21feb Minor grammar nit. Translators please ignore. 2003-05-21 21:05:04 +00:00
Ceri Davies
cef067ad2a s/information version/informal version/ 2003-05-21 18:34:58 +00:00
Ceri Davies
1ce60fc6d2 Add a description of when to use a manual page reference and when to
use <command> to markup commands in SGML docbook.

PR:		docs/52467
Submitted by:	Simon L.Nielsen <simon@nitro.dk>
Discussed on:	-doc
2003-05-20 21:18:38 +00:00
Murray Stokely
dc4773d579 Clarify history of DocBook.
PR:		docs/50824
Submitted by:	Oliver Fischer <plexus@snafu.de>
2003-04-26 07:40:04 +00:00
Giorgos Keramidas
6dd95937d9 Put my flame resistant suit on, and remove all unnecessary duplication
of URL text in <ulink> attributes, reducing the probability of typos
in future changes to the docs.
2003-04-11 01:11:39 +00:00
Peter Pentchev
1f359cbbab /tmp/msg 2003-01-12 18:20:55 +00:00
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