Title goes here

$FreeBSD$ =20 The title =20 Comments? We probably need some additional classes. "security-advisories", that sort of thing. Any suggestions? I also thought we might want to and align=3D"right= ", if we wanted to let authors choose which of the left/right nav bar the content goes in. But I think for consistency it might be better to just insist on sidebars only appearing on the right. Building the web site --------------------- The majority of files on the web site will be XML, marked up in the schema outlined above (or whatever schema we eventually decide on). For those fil= es, we will need a stylesheet that can convert them to XHTML. However, some of the files will need an intermediate step first. For examp= le, the current www/en/news/news.xml is a completely different schema. We will need two stylesheets; one to convert news.xml in to the schema outli= ned above, and then the 'global' stylesheet that can convert s in to HTML. This suggests to me that naming everything with .xml extension might not be the best way to do it. If everything has a .xml extension, irrespective of its schema, then we can't write Makefiles that use SUFFIX rules to=20 automatically convert documents to HTML. For example, consider the top level index file (the site's home page), which we'll call www/en/index.xml. The make(1) rule for this would be something like index.html: index.xml xsltproc stylesheet.xsl index.xml > index.html Which we could turn in to a generic XML -> HTML suffix rule easily. However, this breaks down when you need to pre-process the files through multiple stylesheets. To use the news example, where news.xml has to be pre-processed, the Makefile fragment looks something like this: # news-page.xsl is the stylesheet that converts news.xml in to the # schema. news.html: news-page.xsl news.xml xsltproc news-page.xsl news.xml | \ xsltproc stylesheet.xsl - > news.html Perhaps, instead, we should say that pages have a .page suffix, and that generic XML data has the .xml suffix. Further, we mandate that for every foo.xml there must also be a foo.xsl that can convert foo.xml in to foo.pag= e. The news example above then becomes news.html: news.page xsltproc stylesheet.xsl news.page > news.html news.page: news.xsl news.xml xsltproc news.xsl news.xml > news.page This can easily be encapsulated in make's SUFFIX rules SUFFIXES: .xml .page .html .html.page: xsltproc stylesheet.xsl ${.IMPSRC} > ${.TARGET} .page.xml: xsltproc ${.IMPSRC:R}.xsl ${.IMPSRC} > ${.TARGET} Of course, this assumes that we can go from .xml to .page in one go, without needing any more intermediate translations. I think that's probably the ca= se, but if you can think of a counter example then please say so. There will still be a few oddities. For example, news.rdf is generated from news-rdf.xsl and news.xml, but I think they'll be so rare that we can speci= al case them in the Makefiles as necessary. Dependencies are going to be another interesting challenge. The HTML output file does not (necessarily) only depend on the input .page file. For examp= le, anything that has a=20 in it has a dependency on en/news/news.xml. I think this means: (a) We will need a "make depend" step in the build process. (b) We will need to write a tool that can process a .page file, chase=20 down all its dependencies, and write that out in a format that make(= 1) can understand. Link checking ------------- For internal links, I'm thinking about introducing a new element. It would have all the same attributes and functionality as the existing element in HTML. But, if the content was local, and the had no content, the stylesheet would parse the target document to extract its titl= e. Similar to 's processing expectations for DocBook. Comments? N --=20 FreeBSD: The Power to Serve http://www.freebsd.org/ FreeBSD Documentation Project http://www.freebsd.org/docproj/ --- 15B8 3FFC DDB4 34B0 AA5F 94B7 93A8 0764 2C37 E375 --- --TU+u6i6jrDPzmlWF Content-Type: application/pgp-signature Content-Disposition: inline -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.0.6 (FreeBSD) Comment: For info see http://www.gnupg.org iEYEARECAAYFAjuwsacACgkQk6gHZCw343WgtQCdFPR/NvViBx1w4f9RwAiq//1V tWkAn2122vKw6xGtDZrZHW2Rp+ioni1t =PhLt -----END PGP SIGNATURE----- --TU+u6i6jrDPzmlWF-- To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-www" in the body of the message