[ANN] Creation of the "docs-common" subdirectory tree
Karsten Wade
kwade at redhat.com
Wed Jun 15 17:32:53 UTC 2005
On Tue, 2005-06-14 at 16:34 -0500, Tommy Reynolds wrote:
> Ahoy, Doc'ers!
>
> Earlier on this list, Paul Frields began a discussion about moving
> all the overhead directories ("common", "css", "stylesheet-images",
> and "xsl") into a single object. That way, the root directory of
> everyone's working tree would not be cluttered with boilerplate
> cruft.
>
> The ensuing discussion has led to the creation of the "docs-common"
> top-level directory. This now holds the four older directories
> mentioned above. The old "doc-setup" object is no more.
I've updated the anonymous CVS checkout instructions on
f.r.c/projects/docs to reflect this. Changes should be live within the
hour.
- Karsten
>
> The "docs-common" is intended to be a peer directory for the
> individual document directories. To check out a document for local
> editing or building, two steps are needed:
>
> $ cvs checkout docs-common
> $ cvs checkout the-doc-I-want
>
> Note that checking out "docs-common" is a one-time operation; all
> documents will share that one instance.
>
> At least two changes need be made to each document's "Makefile":
>
> 1) Change the relative paths for the "XSLPDF" and "XSLHTML" macros
> from "../xsl" to "../docs-common/xsl".
>
> 2) Change the relative path of the "cp ../stylesheet-images" line to
> "cp ../docs-common/stylesheet-images"
>
> Then, in the parent file of each document, change the relative paths
> of the "FEDORA-ENTITIES-EN" entity from "../common" to
> "../docs-common/common". Yeah, I know, it looks redundant, doesn't
> it? Also change the relative path of the "LEGALNOTICE" entity from
> "../common" to "../docs-common/common".
>
> With these changes, you document should build.
>
> Now, go back to your top-level directory, the one that now holds
> "docs-common" and *stale* copies of "common", "css",
> "stylesheet-images", and "xsl" directories. Take a deep breath and
> type:
>
> $ rm -rf README common css stylesheet-images xsl
>
> to get rid of the files that are now part of "docs-common".
>
> If you have any questions about this process, look at the
> "example-tutorial/" document: it has the necesssary changes.
>
> Cheers
> --
> fedora-docs-list mailing list
> fedora-docs-list at redhat.com
> To unsubscribe:
> http://www.redhat.com/mailman/listinfo/fedora-docs-list
--
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/
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 189 bytes
Desc: This is a digitally signed message part
URL: <http://listman.redhat.com/archives/fedora-docs-list/attachments/20050615/52d082ea/attachment.sig>
More information about the fedora-docs-list
mailing list