Commit graph

515 commits

Author SHA1 Message Date
Giorgos Keramidas
dd3676854b Terminate <para> elements before starting a new <screen> and
clarify a bit the part that describes the type of patches we
like sending upstream for ports.
2009-05-13 02:05:11 +00:00
Giorgos Keramidas
4aaa526087 Reword a bit the 'compress your patches' suggestion, making it a bit
more clear about what to compress and what to uuencode.

Obtained from:	FreeBSD Greek doc team
2009-04-30 18:26:32 +00:00
Giorgos Keramidas
2060b208f8 Mark directory <filename> elements with class="directory".
Obtained from:	FreeBSD Greek doc project
2009-04-30 15:27:54 +00:00
Jesus R. Camou
bee4f94f25 Fix typo.
Noticed by:	ceri
Approved by:	trhodes (mentor)
2006-03-06 21:52:11 +00:00
Jesus R. Camou
2e3b33787d Add link to the `Ideas' page
maintained by joel@.

PR:		docs/92745
Submitted by:	Daniel Gerzo <danger@rulez.sk>
Approved by:	trhodes (mentor)
2006-03-06 19:33:34 +00:00
Ceri Davies
a61e967d40 Links to our CGI scripts should always be absolute ones pointing to the
copies on www.FreeBSD.org.
2005-09-25 23:38:22 +00:00
Remko Lodder
30e46046f2 Make the PR followup address easier to maintain by adding an entity to
the mailing-lists.ent file (though it's not really an mailinglist).
Also replace the current follow up addresses by it's entity name.

Submitted by:		ceri
2005-08-13 21:17:05 +00:00
Remko Lodder
92bcc862e7 Be more consistent with the PR follow up email address.
(s/freebsd-gnats-submit/bug-followup/)

PR:			docs/84809
Submitted by:		Julien Gabel <jpeg at thilelli dot net>
2005-08-13 09:08:03 +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
7ced776295 Use &url.*; instead of http://www.FreeBSD.org/*. 2004-08-09 17:19: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
Denis Peplin
c12c11040e Use url entities for links between docs 2004-08-05 10:04:31 +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
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
Alexey Zelkin
6d048e2320 Sync these Makefiles to have one style of declarations and comments. 2004-04-06 16:10:08 +00:00
Josef El-Rayes
42f5ceb715 Remove majordomo address as mailman interface is prefered
way of subscribing FreeBSD Mailinglists.
While I am here, replace bug-followup@ with FreeBSD-gnats-submit@.

Approved by:    simon(mentor)
Submitted by:   Andrew M <andymorritt@rogers.com>
PR:             docs/61508
2004-01-18 22:03:08 +00:00
Simon L. B. Nielsen
5421dc303f Add trademark symbols and attributions:
- Add trademark tags as needed, generally on first use in each
   article.
 - Add an attribution to the legal section mentioning all trademarks
   referenced.
 - Always use correct case for trademarks.
 - Don't join trademarks with other words, e.g. using hyphens.

trademark.ent:
 - Commonly used trademarks are defined as entities for ease of use.
 - All trademark attributions are defined as entities for ease of use.

Approved by:	ceri (mentor)
2003-08-06 21:48:40 +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
Hiroki Sato
ee5bf07c5d Replace ${JADEFLAGS} with the corresponding variables. 2003-02-16 14:59:48 +00:00
Giorgos Keramidas
f7f0d4f360 Avoid capitalizing a program name at the start of a sentence,
by rewording a bit.  Use &man.shar.1; for the program name too.
2003-02-01 17:41:49 +00:00
Tom Hukins
e425fbbac8 s/freebsd.org/FreeBSD.org/ 2003-01-21 19:28:27 +00:00
Ceri Davies
6888441d55 Spelling fixes, courtesy of ispell. 2002-12-15 22:19:02 +00:00
Tom Rhodes
86b1de55db Do not advise users to upload patches to ftp.FreeBSD.org &&
Link to the hubs article before advising users to contact them about
setting up a mirror.

PR:	46084
2002-12-12 05:52:53 +00:00
Michael Lucas
515ed60e40 Take dg@ and core@ off the hook for hardware donations, referring
people instead to the donations team web page.
2002-10-23 13:57:08 +00:00
Marc Fonvieille
a3a6aa326d Mailing lists entities addition.
Some punctuation and style corrections.
Use of manual pages entities.
Fix an old remain when that article was part of the Handbook and talked
about "FreeBSD Inc.", it's "FreeBSD Foundation" now.
2002-08-03 18:59:36 +00:00
Chern Lee
a6a041f2af Fix example of using diff, mention when to use unified vs. context
formats.

Submitted by:	jhb
2002-07-31 09:28:17 +00:00
Chern Lee
a2b64e362e We prefer unified diffs.
Change 'context diff' -> 'unified diff'

PR:		docs/38728
Submitted by:	Pete Zaitcev <zaitcev@yahoo.com>
2002-07-29 11:39:04 +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
Michael Lucas
64b72dc1f7 Add information about contributing to the C99/Posix compliance project.
Suggested by: wollman
2002-05-08 18:29:01 +00:00
Michael Lucas
1ead757eb4 Whitespace diff. No content changes.
This includes a re-justification of the whole document, as many lines
were far too long, not just the ones I touched in the last commit.
2002-05-07 12:51:37 +00:00
Michael Lucas
db46fb6953 Reorganization and partial rewrite of this article.
Suggestions for to-do activities are now broken out into "coder" and
"non-coder" tasks.

Remove implications that the Core team makes all TODO lists.
2002-05-07 12:34:27 +00:00
Michael Lucas
5774e384cf Whitespace cleanup from previous commit.
No content changes.
2002-05-06 12:26:46 +00:00
Michael Lucas
f9aae66a41 Update translations entry to reflect existence of translations FAQ,
and general changes in the translation process since this document was
written way back when.
2002-05-06 12:25:19 +00:00
Giorgos Keramidas
67a1702cec Remove almost all instances of "try and <verb>" from the docs.
There is one remaining place in the fdp-primer, but that needs
a bit more work.

Inspired by:	docs/36462 (Gary W. Swearingen <swear@blarg.net>)
Reviewed by:	ceri, trhodes
2002-04-07 23:52:37 +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
Murray Stokely
c3bb7acba0 Note that the FreeBSD Foundation can now accept donations through the
web with PayPal.
2002-03-18 05:47:15 +00:00
Peter Pentchev
6e99166b51 Whitespace-only fixups from the e-mail to SGML entities conversion. 2002-03-15 08:28:14 +00:00
Peter Pentchev
81f0937cee Convert names, descriptions and e-mail addresses of FreeBSD committers
and mailing lists to SGML entities.

Reviewed by:	keramida
Approved by:	keramida, silence on -doc
2002-03-15 08:10:48 +00:00
Michael Lucas
ee920c1278 Whitespace cleanup from previous commit.
No content changes.
2002-03-11 14:46:50 +00:00
Michael Lucas
025392780c Rewrite first three paragraphs of this article to eliminate run-on
sentences, poor grammar, excess verbiage, etc., etc.
2002-03-11 14:44:58 +00:00
Giorgos Keramidas
9f02cb487b Fix logical bug. "Ongoign tasks" is the first subsection about tasks.
Substitute "previous sections" -> "next sections".
2002-02-18 03:06:39 +00:00
Dag-Erling Smørgrav
298d29102b Mention the problem report article. 2001-11-23 18:31:04 +00:00
Murray Stokely
720d4d69c8 * s/freebsd.org/FreeBSD.org/
* Correct some broken links
* Use relative links for freebsd.org documents

PR:		docs/31447
Submitted by:	Cyrille Lefevre <clefevre@citeweb.net>
Found by:	linbot
2001-10-23 21:31:20 +00:00
Giorgos Keramidas
b9de1f4470 Replace the last &quot; entities of this articles with <quote> elements.
Approved by:	nik
2001-10-15 13:28:21 +00:00
Murray Stokely
d66d104587 Add <filename> and <function> tags as appropriate. 2001-10-08 06:26:16 +00:00
Murray Stokely
ee836b0855 Add "Contributing to FreeBSD" article. This has been repo-copied from
the FreeBSD Handbook contrib/chapter.sgml.
2001-10-08 06:18:45 +00:00
Dima Dorfman
5629b58727 Mention that [PATCH] in the synopsis of a PR could indicate that the
PR includes a patch suitable for committing.  I don't think this is
the best place to put something like this, but it's better than
nothing.

Submitted by:	pavalos@theshell.com
2001-08-11 20:15:56 +00:00
Chern Lee
205cf1b49a Standardize capitalization of titles:
* First and last word uppercase
* Prepositions, articles, and short conjunctions lowercase
* The word 'to' lowercase
* Preserved capitalization for program/command names

Reviewed by:	murray
2001-08-10 22:58:17 +00:00
Chern Lee
2b61014302 Properly markup contributions in <chapterinfo>/<sect1info>/<sect2info> tags
according to recent changes for entire Handbook.

Reviewed by:	murray
2001-08-09 23:42:35 +00:00