- 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
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.
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.
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>
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
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)
- 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>
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.
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
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
* 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