Commit graph

257 commits

Author SHA1 Message Date
Gabor Pali
f93f00e7a3 - Replace software installed by textproc/jade with software installed by
textproc/opensp since that is the one which comes with
  textproc/docproj by default

PR:		docs/149007
Submitted by:	Anton Shterenlikht <mexas@bristol.ac.uk>
2010-08-10 11:48:17 +00:00
Johann Kois
9024e5e4a5 PR: docs/149315
Fix a couple of typos/misspellings in:

- doc/en_US.ISO8859-1/books/corp-net-guide/book.sgml
- doc/en_US.ISO8859-1/books/dev-model/book.sgml
- doc/en_US.ISO8859-1/books/developers-handbook/l10n/chapter.sgml
- doc/en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml
- doc/en_US.ISO8859-1/books/porters-handbook/book.sgml

Contributed by: Jimmy Olgeni (olgeni@)
2010-08-08 13:54:36 +00:00
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
cf02c18009 Fix a mistyped link 2009-01-22 12:08:03 +00:00
Gabor Pali
302d0ecbc3 Bump copyright year due to recent content changes 2009-01-21 23:52:53 +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
Gabor Pali
9979e08d14 - Fix capitalization
- Mark up directories with <filename class="directory">
- Add a description about WEB_LANG

Reviewed by:	manolis
2009-01-21 23:46:32 +00:00
Gabor Pali
075f65eaa9 - Rewrite the sentences about the Handbook images to provide more
up-to-date information instead of mentioning the possibility of
  including images in a book
- Add some note on the localization of those images

Reviewed by:	manolis
2009-01-21 23:44:40 +00:00
Gabor Pali
0a2150cd27 - Fix broken links
- Add missing full stops

Reviewed by:	manolis
2009-01-21 23:43:08 +00:00
Gabor Pali
241b4f1100 - Mark up Emacs functions with <function> rather than <literal>
- Add port reference for editors/psgml
- Mark up keys (but not keycombos) with <keycap>

Reviewed by:	manolis
2009-01-21 23:41:25 +00:00
Gabor Pali
e84c225de8 - Fix capitalization
- Mark up arguments for Jade in the examples with <replaceable> (to be
  consistent)
- Mark up Jade, pdfTeX with <application>
- Mark up pdfjadetex with <literal>
- Unfold <abbrev>STDOUT</abbrev> to "standard output"
- Mark up Jade error message with <errorname>
2009-01-21 23:38:07 +00:00
Gabor Pali
7c39370311 - Fix title capitalization style 2008-12-07 22:03:48 +00:00
Gabor Pali
e9ad945766 - Fix style of ordered list
- s/kernelconfiguration/kernelconfig
- Fix capitalization of a sentence
- Fix title capitalization style
2008-12-07 02:05:09 +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
Gabor Pali
0428f20356 Update the SGML Primer chapter in FDP Primer:
- Eliminate a <blockquote> inside <para> (split <para> around <blockquote>)
- Use <sgmltag> markup where possible
- nsgmls does not always give error messages, just messages (those might
  contain information on errors)
- Eliminate first person narration
- Add missing full stops
- Add a missing <literal> markup for CDATA

Reviewed by:	blackend, danger, gabor, hrs, manolis, remko, trhodes
2008-10-31 12:23:35 +00:00
Gabor Pali
3571250d35 Add missing <application> elements for JadeTeX 2008-10-13 06:57:53 +00:00
Gabor Pali
badca18c49 Bump copyright year to reflect changes in years 2007 (e.g. [1]) and 2008
(e.g. [2])

[1] http://www.freebsd.org/cgi/cvsweb.cgi/doc/en_US.ISO8859-1/books/fdp-primer/stylesheets/chapter.sgml
[2] http://www.freebsd.org/cgi/cvsweb.cgi/doc/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.sgml

Approved by:	gabor (mentor)
2008-10-02 12:14:31 +00:00
Gabor Pali
9a18e97cc5 Simplify markup of su(1)
Approved by:	gabor (mentor)
2008-10-02 12:08:01 +00:00
Gabor Pali
edafad6a69 Eliminate erroneous role="directory" attributes from <filename> elements
and replace them with class="directory" [1][2]

[1] http://docbook.org/tdg/en/html/filename.html
[2] http://www.freebsd.org/doc/en/books/fdp-primer/sgml-markup-docbook.html#AEN1799
    (4.2.5.5)

Approved by:	trhodes, gabor (mentor)
2008-08-06 22:03:50 +00:00
Gabor Pali
002b4edbbe Change role="port" to role="package" so that package links are properly
generated

Approved by:	trhodes, gabor (mentor)
2008-08-06 20:44:12 +00:00
Manolis Kiagias
a3e2b9875f A major revamp of the website build procedure in fdp-primer:
- Added a simple method using csup instead of keeping a local CVS repo
- Introduce working examples of supfiles for use with both csup and CVSup
- Fixed the command line options in 'cvs co' to avoid problems with the build
- Updated the free disk space requirements for a website build
- Clear up use of DESTDIR to avoid problems when installing the build

Reviewed by:    pgj
Approved by:    gabor (mentor)
2008-06-21 07:56:08 +00:00
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