Commit graph

42 commits

Author SHA1 Message Date
Gabor Kovesdan
5df509eaa2 - Remove standalone="no" statements from XML declarations since it did not
always work and is no use anyway
2013-01-30 19:12:36 +00:00
Gabor Kovesdan
36cdb51546 - Migrate the documentation set to DocBook 4.5 2013-01-30 14:00:53 +00:00
Gabor Kovesdan
77d737ee88 - Rename the share/sgml directories to share/xml
- Fix build errors from the next change

Approved by:	doceng (implicit)
2012-10-01 11:56:00 +00:00
Gabor Kovesdan
b4346b9b2d - Rename .sgml files to .xml
- Reflect the rename in referencing files

Approved by:	doceng (implicit)
2012-10-01 09:53:01 +00:00
Gabor Kovesdan
9c243757ef - XML declarations should use IANA encoding names
Pointed out by:	hrs
2012-09-14 17:47:48 +00:00
Gabor Kovesdan
2e51ec7022 - Strip unnecessary trailing spaces
Approved by:	doceng (implicit)
2012-08-21 19:16:02 +00:00
Gabor Kovesdan
e6b69c3357 - XMLify English articles
Approved by:	doceng (implicit)
2012-06-21 16:01:00 +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
Hiroki Sato
c4cb2201ad Use lower-case characters for attribute name (s/URL=/url=/).
No content change.
2004-08-09 19:49:18 +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
Alexey Zelkin
6d048e2320 Sync these Makefiles to have one style of declarations and comments. 2004-04-06 16:10:08 +00:00
Ceri Davies
297060bbd0 Grammar police: "setup" is not a verb. 2003-11-05 10:59:35 +00:00
Simon L. B. Nielsen
9a9ef91ab4 Whitespace cleanup for last commit, and a few other areas with very long
lines.  No content change.
2003-10-18 18:22:23 +00:00
Simon L. B. Nielsen
f8e2c388ef - Add missing application tags to "MH".
- Add missing ")" to %(formataddr) function.
- Add missing literal tags to "To:" and "Subject:".
- Add missing filename tag to "inbox".

PR:		docs/57209
Submitted by:	Josef El-Rayes <j.el-rayes@daemon.li>
2003-10-18 16:12:25 +00:00
Simon L. B. Nielsen
2993ccd69a *.sgml:
- Use trademark entities
 - Add trademark attributions.
 - Always use correct case for trademarks.
 - Don't join trademarks with other words, e.g. using hyphens.

trademark.ent:
 - Add entities for more trademarks / companies.
 - Sort the Sun trademark attribution entity.
2003-09-14 11:29:06 +00:00
Giorgos Keramidas
b70baee7f2 Wrap the `Cc: ' message header examples in <literal>. 2003-05-21 20:54:14 +00:00
Hiroki Sato
f6cd99b654 Back out WITH_DOCFORMAT_NAVI_LINK?=YES in Makefile. The navi-link
is generated when ${WITH_DOCFORMAT_NAVI_LINK} is defined or
${FORMATS} includes "html" and "html-split."
2003-04-22 18:35:44 +00:00
Hiroki Sato
4f8b26641c - Add WITH_DOCFORMAT_NAVI_LINK to mk/doc.docbook.mk and
enable it in en_US.ISO8859-1/ and ja_JP.eucJP/.

- Add PUBLIC "-//FreeBSD//ENTITIES DocBook Language Specific Entities//EN"
  and l10n.ent for entity localization.

- Use share/misc/docbook.css for indentiation of <programlisting>
  and <screen>.

- Add some missing $FreeBSD$.
2003-04-19 11:39:30 +00:00
Tom Hukins
d53073372f The O'Reilly and Associates book mentioned is now out of print. The
book's author, Jerry Peek, now maintains an online version of this book,
so refer people to that instead.  [See the message 'Suggestion: add a
link to your document "An MH Primer"' posted to freebsd-doc on 6th
August 2002]

While I'm here, update a broken link to the MH FAQ.
2002-10-28 16:32:12 +00:00
Tom Rhodes
d4b003e30a FreeBSD documentation project prefers to use manual pages over man pages,
hence some documents should reflect this.

Tossed around on: -doc -developers
2002-07-11 19:08:31 +00:00
Giorgos Keramidas
b1733ff0d6 + Add tags to filename/command instances.
+ Add a comma to separate parts of existing sentences more clearly.
+ Change "Also you might want" to "You might also want".
+ Remove a duplicate <command>edit</command>.
+ Reword and split sentences, minor other grammar fixes.
2002-05-13 10:40:26 +00:00
Giorgos Keramidas
6ddd2cc0dc Fix &entities; that lacked an ending ';' character,
as reported by the following:

	% cd doc/en_US.ISO8859-1
	% find . -type f -name '*.sgml' |\
	  xargs grep '&[^[:space:];&][^[:space:];]*$' | grep -v '&$'
	% find . -type f -name '*.sgml' |\
	  xargs grep '&[^[:space:];&][^[:space:];]*[[:space:]<]' |\
	  grep -v '&[[: space:]]' | grep -v '[[:space:]]&&[[:space:]]'
2002-03-27 01:16:55 +00:00
Giorgos Keramidas
0b824da1aa Remove all contractions from most of the articles. This solves the
problems with the usage of "its" vs "it's" among other things

Approved by:	nik
2001-10-16 11:53:01 +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
6b66b69b59 <screen> placement fixes.
PR:		docs/28783
Submitted by:	Giorgos Keramidas <keramida@ceid.upatras.gr>
2001-07-11 13:13:41 +00:00
Daniel Harris
2db70a2d84 Clarify a confused sentence and remove a couple extra slashes.
PR:		28784
Submitted by:	Giorgos Keramidas <keramida@ceid.upatras.gr>
2001-07-08 19:15:05 +00:00
Dima Dorfman
a5f6f984b8 Correct logic bug in an example.
PR:		28696
Submitted by:	Giorgos Keramidas <keramida@ceid.upatras.gr>
2001-07-04 22:37:38 +00:00
Nik Clayton
0feceebdf2 Switch to using the DocBook 4.1 based DTD. 2001-04-17 15:53:40 +00:00
Jim Mock
82d7459043 Close tags with </foo> instead of </>.
PR:		20183
Submitted by:	Udo Erdelhoff <ue@nathan.ruhr.de>
2000-07-26 18:24:50 +00:00
John Baldwin
e93df17b5d Indent the MH tutorial according to the current house style.
This commit contains only whitespace changes, so translators may ignore
it.

PR:		docs/14216
Submitted by:	Neil Blakey-Milner <nbm@rucus.ru.ac.za>
1999-10-10 20:20:38 +00:00
John Baldwin
6f98565226 Make use of &prompt.user entity for consistency.
De-<para> examples, if possible, to ease indenting.

PR:		docs/14212
Submitted by:	Neil Blakey-Milner <nbm@rucus.ru.ac.za>
1999-10-10 19:29:59 +00:00
Jesus Rodriguez Cuesta
692bd453d0 mh article wasn't. Fixed, but whitespace/indentation not.
PR:		docs/14115
Submitted by:	nbm@rucus.ru.ac.za
1999-10-04 21:45:05 +00:00
Peter Wemm
5ff728b8ca $Id$ -> $FreeBSD$ 1999-09-06 06:53:43 +00:00
Nik Clayton
cecc348da3 Use the new doc.project.mk file, and ${.CURDIR}. 1999-09-03 17:40:13 +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
John Baldwin
9c6e695ef1 Make the doc/en_* makefiles repect ${DOC_PREFIX} when they include
${DOC_PREFIX}/share/mk/docproj.docbook.mk instead of using hard-coded
paths.

Reviewed partially by:	nik, billf
1999-08-29 00:02:23 +00:00
Nik Clayton
7fc8947ce8 The new Makefile framework. Does the right thing (pretty much) except
in the case of */FAQ/Makefile, because the FAQs are all in the wrong
place.  Things still install properly, but some of the directory paths
are hardcoded.  This will be going away ASAP.
1999-08-16 22:09:20 +00:00
Masafumi Max NAKANE
451112f9b4 $FreeBSD$ -> $Id$. 1997-07-01 21:38:45 +00:00
Masafumi Max NAKANE
a0125fd74b Add $Id$. 1997-07-01 05:38:16 +00:00
John Fieber
e7838ea273 Another tutorial goes Docbook.
Add the standard header and footer graphics/links to HTML generated
from Docbook.
1997-01-19 21:30:25 +00:00
John Fieber
31b246f88d Wire up the new sgmlfmt options. 1996-10-06 00:08:28 +00:00
John Fieber
f285ed5bf8 Web pages, may I introduce you to CVS. CVS, these are the web pages.
Yes, this is supposed to be a new top level in the repository.

For the moment any changes to this area must be cleared by myself
or Jordan.  Once the kinks are worked out, the policy will probably
be relaxed.
1996-09-24 17:46:04 +00:00