common/Makefile.common
by James Laska
Hello folks,
I've been maintaining a mirror of the
fedora-docs/{common,css,stylesheet-images,xsl} for internal Red Hat
pubs. I've found that it can be somewhat annoying to maintain pretty
much the same Makefile across all the documents. I therefore created
"common/Makefile.common" which does all the hard work. All that is
required at this point is that a document include the common makefile
and establish 2 mandatory variables:
===================================
NAME := install-guide
LANG := en
include ../common/Makefile.common
===================================
There are optional arguments for those wishing to override or add
xsltproc parameters. Those optional variables are: XSLTPROC_HTMLARGS,
XSLTPROC_NOCHUNKARGS, XSLTPROC_PDFARGS, XSLTPROC_ARGS.
I have attached Makefile.common to this email for review as well. I
have not yet filed a bugzilla for this, because I first wanted to
solicit fedora-docs-list feedback.
Thoughts/concerns/feedback?
Thanks,
James Laska
--
==========================================
James Laska -- jlaska(a)redhat.com
Quality Engineering -- Red Hat, Inc.
==========================================
18 years, 10 months
Regression alert for redhat.xsl (was Re: xsl redhat.xsl,1.1,1.2)
by Karsten Wade
For those not on the commits list ... or overwhelmed by the entries this
week ...
I checked in a change to redhat.xsl that caused a build error in the
install-guide module. This change to the XSL had been to support the
no-chunking (single HTML file output from DocBook) that James Laska
patched. The no-chunking is working great, but this particular change
isn't. This is me checking my local 1.2 against the 1.3 version that
caused the regression:
[kwade@erato xsl]$ diff -u redhat.xsl.~1.2.~ redhat.xsl
--- redhat.xsl.~1.2.~ 2003-10-01 12:02:56.000000000 -0700
+++ redhat.xsl 2005-05-30 12:05:47.000000000 -0700
@@ -7,7 +7,6 @@
version="1.0"
exclude-result-prefixes="exsl">
-<xsl:import href="/usr/share/sgml/docbook/xsl-stylesheets/html/docbook.xsl"/>
<!-- This sets the extension for HTML files to ".html". -->
<!-- (The stylesheet's default for XHTML files is ".xhtm".) -->
I reverted the XSL to 1.2 and tried it out locally. Both the
Installation Guide (chunking) and the Release Notes (no-chunking) built
ok. For the FC4 release, those are the only two we care about.
James, what problems did you have with the docbook.xsl being imported at
that point in redhat.xsl?
- Karsten
On Wed, 2005-06-01 at 19:58 -0400, Karsten Wade wrote:
> Author: kwade
>
> Update of /cvs/docs/xsl
> In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv14057
>
> Modified Files:
> redhat.xsl
> Log Message:
> This is probably the wrong way to do this, I reverted to 1.1 when I
> meant to rever to 1.2, so I am now recommitting 1.2. The version in
> 1.3 caused a regression in the Installation Guide and I'm sure all
> other guides. Ver. 1.3 had removed the import of docbook.xsl, which
> caused the build to fail. I tested this version 1.2 on release-
> notes/FC4/ and the install-guide/ and it seems to work with chunking
> and non-chunking. I will talk with jlaska and find out why he removed
> this call ... I know it broke something for them. Further regressions
> are a possibility, just hopefully not in the only two documents that
> we *must* have build for FC4.
>
>
> Index: redhat.xsl
> ===================================================================
> RCS file: /cvs/docs/xsl/redhat.xsl,v
> retrieving revision 1.1
> retrieving revision 1.2
> diff -u -r1.1 -r1.2
> --- redhat.xsl 17 Jul 2003 19:48:07 -0000 1.1
> +++ redhat.xsl 1 Jun 2005 23:58:27 -0000 1.2
> @@ -1,4 +1,4 @@
> -<!-- created by Tammy Fox tfox(a)redhat.com for the RHL Project -->
> +<!-- created by Tammy Fox tfox(a)redhat.com for the Fedora Project -->
> <!-- License: GPL -->
> <!-- Copyright 2003 Tammy Fox, Red Hat, Inc. -->
--
Karsten Wade, RHCE * Sr. Tech Writer * http://people.redhat.com/kwade/
gpg fingerprint: 2680 DBFD D968 3141 0115 5F1B D992 0E06 AD0E 0C41
Red Hat SELinux Guide
http://www.redhat.com/docs/manuals/enterprise/RHEL-4-Manual/selinux-guide/
18 years, 10 months
Fedora HCL guide writers?
by Chida
Hello,
I have been resorting to "googling" for Fedora HCL due to the lack of
such a guide. I have a crude list of hardware list built from
experience. This is in no means a official HCL and has very few
hardware.
However, looking at https://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=129784
I realise i might as well start off an official one. Are there any
writiers understaking such a task?
How do I go about starting one? I could do the SelfIntroduction stuff
(although i'm not too comfortable reveling my residence address to a
mailing list :).
Any comments are appreciated.
Chida
18 years, 10 months
Fedora Docuumentation Guide as PDF?
by Chida
Hello all,
Is there a PDF version of Fedora Documentation Guide available for download?
This would make it easier to print a hardcopy for reference.
Source for the document is fine too.
Thanks in advance,
Chida
18 years, 10 months
fedora-entities-en.xml deprecated
by Karsten Wade
We need to use the new file in common/fedora-entities-en.ent. This
should be a single line change in your parent XML file:
<!ENTITY % FEDORA-ENTITIES-EN SYSTEM "../../common/fedora-entities-en.xml">
becomes
<!ENTITY % FEDORA-ENTITIES-EN SYSTEM "../../common/fedora-entities-en.ent">
I forgot who mentioned this or even if there is a bug report for it.
It's just one of those small Right Way To Do Things we can fix easily.
The deprecated file will remain for a short while, but ALL DEVELOPMENT
WORK WILL STOP. I don't want to port over changes made to the *.ent
file. We have such a small documentation set this is the easy, painless
time to make this change.
cheers - Karsten
--
Karsten Wade, RHCE * Sr. Tech Writer * http://people.redhat.com/kwade/
gpg fingerprint: 2680 DBFD D968 3141 0115 5F1B D992 0E06 AD0E 0C41
Red Hat SELinux Guide
http://www.redhat.com/docs/manuals/enterprise/RHEL-4-Manual/selinux-guide/
18 years, 10 months
Re: common legalnotice-en.xml,1.7,1.8
by Karsten Wade
On Mon, 2005-05-30 at 16:30 -0400, Tommy Reynolds wrote:
> Modified Files:
> legalnotice-en.xml
> Log Message:
> Added explicit FC usage notice about the callout graphics I've added.
Just a note to all writers, make sure you do 'cvs up' in the common
directories:
css/
common/
xsl/
stylesheet-images/
There is some new XSL that supports no-chunks HTML (main-html-
nochunks.xsl) and an updated legalnotice.
For these common directories, it is worth replying to your own commit
message so that fedora-docs-list gets notice of the change. Everyone
who writes and edits is supposed to be on the fedora-docs-commits list,
but you can't expect them to read _all_ the messages. :)
I included this practice in the (currently canonical) Wiki notes, which
will get into the Documentation Guide RSN.
>
>
> Index: legalnotice-en.xml
> ===================================================================
> RCS file: /cvs/docs/common/legalnotice-en.xml,v
> retrieving revision 1.7
> retrieving revision 1.8
> diff -u -r1.7 -r1.8
> --- legalnotice-en.xml 21 Dec 2003 21:01:51 -0000 1.7
> +++ legalnotice-en.xml 30 May 2005 20:30:27 -0000 1.8
> @@ -1,3 +1,12 @@
> +<!-- $Id: -->
> +<!--
> +<!DOCTYPE legalnotice PUBLIC "-//OASIS//DTD DocBook V4.2//EN"
> + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
> +
> + <!ENTITY BOILERPLATE "This header makes editing XML easier" >
> +
> +]>
> +-->
> <legalnotice id="legalnotice">
>
> <para>
> @@ -19,7 +28,9 @@
>
> <para>
> Garrett LeSage created the admonition graphics (note, tip, important,
> - caution, and warning). They may be freely redistributed with documentation
> + caution, and warning).
> + Tommy Reynolds <email>Tommy.Reynolds(a)MegaCoder.com</email> created the callout graphics.
> + They all may be freely redistributed with documentation
> produced for the &PROJECT;.
> </para>
>
>
> --
> Fedora-docs-commits mailing list
> Fedora-docs-commits(a)redhat.com
> https://www.redhat.com/mailman/listinfo/fedora-docs-commits
--
Karsten Wade, RHCE * Sr. Tech Writer * http://people.redhat.com/kwade/
gpg fingerprint: 2680 DBFD D968 3141 0115 5F1B D992 0E06 AD0E 0C41
Red Hat SELinux Guide
http://www.redhat.com/docs/manuals/enterprise/RHEL-4-Manual/selinux-guide/
18 years, 10 months
