Commit graph

234 commits

Author SHA1 Message Date
Daniel Gerzo
db6a75d08a - Spell "whereas" correctly.
PR:		docs/119138
Submitted by:	gregory delfly <gregoryd.freebsd@free.fr>
2007-12-30 02:40:32 +00:00
Pav Lucistnik
f5a0529523 Update locations of recently moved ports, like portupgrade, portaudit or
portlint.  I have retained their historical locations in papers which got
written, but are not constantly updated like the rest of our documentation.
2007-02-05 01:33:20 +00:00
Giorgos Keramidas
d2ba0531b4 The web site actually *does* use CSS for quite a while now.
PR:		docs/107426
Submitted by:	Tomas Mozes, hydrapolic.at.gmail.com
2007-01-15 23:29:57 +00:00
Giorgos Keramidas
49041de2ea The docbook/4.1 `dbcent.mod' module contains references to public entities
first defined in ${SGMLROOT}/html/catalog and ${SGML_ROOT}/iso8879/catalog.
By setting the SGML_CATALOG_FILES in the order suggested until now, we end
up with a value of SGML_CATALOG_FILES like (wrapped to keep the length of
the lines reasonable):

  /usr/doc/en_US.ISO8859-1/share/sgml/catalog:/usr/doc/share/sgml/catalog:\
  /usr/local/share/sgml/docbook/4.1/catalog:/usr/local/share/sgml/html/catalog:\
  /usr/local/share/sgml/iso8879/catalog:/usr/local/share/sgml/jade/catalog

This means that when `dbcent.mod' refers to entities like %ISOamsa; they
are not known already (because they are defined in catalog files later in
the search path, not loaded by nsgmls yet).  This results in errors like:

  nsgmls:/usr/local/share/sgml/docbook/4.1/dbcent.mod:54:0:E: \
  cannot open "/usr/local/share/sgml/docbook/4.1/iso-amsa.gml" \
  (No such file or directory)

By rearranging the order of the catalog files a bit, we can convince nsgmls
to load the `html' and `iso8879' public entities first, and make it
possible to use nsgmls to validate DocBook SGML documents too (instead of
HTML only).

PR:		docs/48980
Submitted by:	Martin Karlsson <mk-freebsd@bredband.net>
2006-11-05 18:32:05 +00:00
Remko Lodder
4439291abe Correct an incomplete command. The instructions should have used the
entire language directory instead of the short version (the latter
is not available in /usr/doc).

PR:			docs/100364
Submitted by:		chinsan <chinsan dot tw at gmail dot com>
2006-07-16 09:01:43 +00:00
Marc Fonvieille
abe7360553 Update copyright year to reflect last changes. 2006-05-28 17:08:45 +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
Giorgos Keramidas
296305a256 Split the typographic convention examples for commands, files and
screen output in three separate entries, to avoid confusing the
reader.

PR:		docs/93017
Submitted by:	Ben Kaduk <minimarmot@gmail.com>
2006-02-10 15:15:49 +00:00
Ceri Davies
972321e5fb Change an instance of "try and" to "try to". 2006-02-07 21:46:33 +00:00
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
Giorgos Keramidas
33bcff02e3 Add a tip about ``C-c /'' and a new way to add local stuff to the
psgml-mode-hook that works better with the current version of
editors/psgml in GNU Emacs 21.3

Submitted by:	Leonidas Tsampros <ltsampros@upnet.gr>
2005-09-24 23:15:42 +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
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
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
Simon L. B. Nielsen
4f09d6756f Remove textproc/sp from the list of required tools - it is not
installed by the current docproj port, and in fact it conflicts with
jade so one cannot install it along side the normal docproj port.

Reported by:	Alejandro Pulver
2005-08-31 20:21:28 +00:00
Murray Stokely
5ea3988ddd Fix typo.
Submitted by:	Michal Kalkowski <noir18@o2.pl>
2005-08-31 20:20:38 +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
Ceri Davies
7939e1f9d8 More nitpicking. 2005-06-01 21:38:01 +00:00
Ceri Davies
ab923c2eea Correct a pathname, and insert the role="directory" attribute while
here.
2005-06-01 21:34:42 +00:00
Ceri Davies
adde7bd2dd Remove a grammar issue. 2005-06-01 21:32:42 +00:00
Simon L. B. Nielsen
81306c2b6f Remove "make links" step since this has not been needed for the last 4
years.
2005-03-01 23:17:02 +00:00
Marc Fonvieille
044fd4aef6 - Use of double-quotation marks instead of single ones
- Remove useless quotation marks

Nice reference:
http://webster.commnet.edu/grammar/marks/quotation.htm
2005-03-01 17:51:26 +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
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
Simon L. B. Nielsen
ad76c7f369 - endeavours -> endeavor (US English spelling)
- Bump copyright year

PR:		docs/77576
Submitted by:	Jesus R. Camou <jcamou@cox.net>
2005-02-20 16:46:26 +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
Ceri Davies
41e9bbc4f4 Use "cp -R" in an example over the
stated-to-be-undesirable-in-the-manual "cp -r".

PR:		docs/74533
Submitted by:	Joel Dahl <joel at automatvapen dot se>
2004-11-29 19:54:10 +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
Marc Fonvieille
837793f692 Punctuation fix. 2004-08-11 20:01:35 +00:00
Hiroki Sato
5fa082b1f8 Simplify parameter entities in doctype declaration.
Currently we have articles.ent and books.ent, and
for example, articles.ent can be used by putting the
following lines in the doctype declaration:

 <!ENTITY % articles.ent PUBLIC
            "-//FreeBSD//ENTITIES DocBook FreeBSD Articles Entity Set//EN">
 %articles.ent;

This pulls all of the necessary entities via share/sgml/articles.ent.

The translation teams can customize these entities by redefining
the articles.ent file in <langcode>/share/sgml.  See
ja_JP.eucJP/share/sgml for example.
2004-08-08 13:44:01 +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
a1756b63ec Consistently use &tex; macro. 2004-08-02 05:50:38 +00:00
Murray Stokely
e209720c96 spelling. 2004-08-02 05:48:04 +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
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
Murray Stokely
f50407f8fc Use &tex; macro so that it can be rendered properly for print output. 2004-07-12 03:12:30 +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
Nik Clayton
1d4b67d832 Remove references to the freebsd-translate mailing list. This list receives
nothing but spam, and the reference confuses new translators.  Point readers
at the mailing lists run by the individual translation projects instead.
2004-06-23 08:50:25 +00:00
Tom Rhodes
dd2a9fa4fc The MAINTAINER lines on these files should have been set to doc a long
time ago.
2004-06-03 06:31:51 +00:00