RFR: A Pack of Patches for Chapter "SGML Markup" in FDP Primer

Gabor PALI pgj at FreeBSD.org
Sat Nov 29 01:44:58 UTC 2008


Hello,

I encountered some interesting parts in the SGML Markup chapter [1]
during translation of the FDP Primer [2], so I decided to fix them up
and send the corresponding patch in small pieces to this list.  I would
like you to check and comment these patches before I commit them.

My proposed changes are as follows:

http://people.freebsd.org/~pgj/patches/2008/11/29/doc.en.books.fdp-primer.sgml-markup.patch/1.diff

I think there is no need for this "baroque" <URL: link> notation, since
I could not find any other instances in the document.


http://people.freebsd.org/~pgj/patches/2008/11/29/doc.en.books.fdp-primer.sgml-markup.patch/2.diff

Oh, yeah.  Ports Collection should be capitalized.


http://people.freebsd.org/~pgj/patches/2008/11/29/doc.en.books.fdp-primer.sgml-markup.patch/3.diff

I think word "of" should be "or" because we are talking about "rowspan
and/or colspan attributes", so it would rhyme with "number of rows or
columns" or "number of rows and/or columns".


http://people.freebsd.org/~pgj/patches/2008/11/29/doc.en.books.fdp-primer.sgml-markup.patch/4.diff

In my opinion, some literals and attributes want a <literal> element.


http://people.freebsd.org/~pgj/patches/2008/11/29/doc.en.books.fdp-primer.sgml-markup.patch/5.diff

Remove leftovers of the first-person narration, add more generalization
to the text, refer to the Handbook just as an example.  Update path and
names of the Handbook sources.


http://people.freebsd.org/~pgj/patches/2008/11/29/doc.en.books.fdp-primer.sgml-markup.patch/6.diff

Add some missing text to the <blockquote> example.


http://people.freebsd.org/~pgj/patches/2008/11/29/doc.en.books.fdp-primer.sgml-markup.patch/7.diff

I think there is no example of tables with borders, however the text
mentions it.  Perhaps it would be a better idea to show a table with
borders and a table without borders.


http://people.freebsd.org/~pgj/patches/2008/11/29/doc.en.books.fdp-primer.sgml-markup.patch/8.diff

Simplify some parts of the manual page markup example, and fix all
sendmail-related manual page sections from 8 to 1 (Whoops).


http://people.freebsd.org/~pgj/patches/2008/11/29/doc.en.books.fdp-primer.sgml-markup.patch/9.diff

Host bento.FreeBSD.org does not exist.  Replace it with pointyhat.  Let
us have a working example.


http://people.freebsd.org/~pgj/patches/2008/11/29/doc.en.books.fdp-primer.sgml-markup.patch/10.diff

I think the example for <screen> elements includes some unnecessary
<informalexample> tags :)


http://people.freebsd.org/~pgj/patches/2008/11/29/doc.en.books.fdp-primer.sgml-markup.patch/11.diff

Add missing parentheses.


Thanks for the replies.

Regards,
:g


[1] http://www.freebsd.org/doc/en/books/fdp-primer/sgml-markup.html
[2] http://www.freebsd.org/doc/en/books/fdp-primer/




More information about the freebsd-doc mailing list