Skip site navigation (1)Skip section navigation (2)
Date:      Fri, 14 Sep 2012 14:14:21 +0200
From:      Gabor Kovesdan <gabor@FreeBSD.org>
To:        FBSD Doc project <doc@freebsd.org>
Cc:        doc-committers@FreeBSD.org, www@freebsd.org
Subject:   [HEADSUP] We are now using XML
Message-ID:  <50531F9D.6060602@FreeBSD.org>

next in thread | raw e-mail | index | archive | help
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hello Folks,

as announced before, the doc/www repository has been migrated to XML.
The fdp-primer is partly updated but it will need a deeper rework. Files
are not yet renamed to .xml and we are still using Jade but those will
be changed in future phases.

The most important things you should now to continue committing:

- - As discussed, character entities have been converted to native text
since they are not too useful nowadays. We can suppose document authors
can properly display what they edit so character entities just make it
more difficult to edit text. One exception is when you have to type
foreign names or terms that contain characters not available in the
context language. Apart from this, their use is discouraged.
(If someone needs help with the conversion of uncommitted work, I can
provide some scripts.)

- - XML is a subset of SGML so in general, things look the same as they
used to be but the syntax is stricter (and cleaner): always close your
tags and quote your attributes.

- - Use lowe cases id names.

- - Do not include PSGML comments in files. With XML these are not useful
any more and not everyone uses emacs. If you want some editor-specific
configuration, please do it in a separate config file, not in XML
comments.

- - Parameter entities can only be used with XML in DTD context so they
had to be moved to the .ent files.

- - XSLT files are now based on share/sgml/xhtml.xsl. Please import and
customize this instead of reproducing the whole set of header divs if
you need dynamic pages. This will help us change the design if we
organize a design contest that has recently been discussed.

Regards,
Gabor
(on behalf of doceng@)
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.9 (MingW32)
Comment: Using GnuPG with Mozilla - http://www.enigmail.net/

iEYEARECAAYFAlBTH50ACgkQkC3QTyNzprE+hACgpBu243yGT9trhmE4pAmkNYyn
4FQAn3yDc74EG6wbmnh3peO90aaim0ra
=7myy
-----END PGP SIGNATURE-----



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?50531F9D.6060602>