changes in legalnotice entity (was Re: common legalnotice-content-en.xml, NONE, 1.1 legalnotice-relnotes-en.xml, NONE, 1.1 fedora-entities-en.ent, 1.2, 1.3 legalnotice-en.xml, 1.8, 1.9)

Karsten Wade kwade at redhat.com
Fri Jun 3 04:01:36 UTC 2005


The below check-in supports a different style of doing the legalnotice
for the release notes.

We need the full relnotes in one page (no chunks), but pulling the
legalnotice in at the top above the ToC is ugly.  It defeats our new
What's New section (from Rahul) that makes this a more useful default
homepage for Firefox.

You shouldn't have to change anything, even after doing a 'cvs up' in
common/.  Your document's call to &LEGALNOTICE; will continue to do the
right thing.

Changes to the legalnotice now need to happen in common/legalnotice-
content-en.xml.

The changes below do the following:

* Pull the actual content of the legalnotice into a file
common/legalnotice-content-en.xml

* Have legalnotice-en.xml call in the entity &LEGALNOTICE-CONTENT;

* Have legalnotice-relnotes-en.xml give a one line reference to the GFDL
and link to an <appendix>

* Within the relnotes, the new <appendix> has a call to &LEGALNOTICE-
CONTENT;

* fedora-entities-en.ent now has ENTITY declarations for LEGALNOTICE-
CONTENT and LEGALNOTICE-RELNOTES

If you get this update and have *not* changed your document to call
fedora-entities-en.ent (instead of fedora-entities-en.xml), this update
will break your build.  The entities file declares the special
legalnotice content file, and this change is *not* in the deprecated
fedora-entities-en.xml file.

Final note:  this is a hackish trick.  It is not semantically correct,
having the content of the legalnotice _outside_ of the <legalnotice />
container.  At least, it feels wrong to me. 

I'll look into solving this in the XSL later.  Even moving the
legalnotice to appear below the ToC will be good enough.

cheers - Karsten



On Thu, 2005-06-02 at 23:43 -0400, Karsten Wade wrote:
> Author: kwade
> 
> Update of /cvs/docs/common
> In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv17035
> 
> Modified Files:
> 	fedora-entities-en.ent legalnotice-en.xml 
> Added Files:
> 	legalnotice-content-en.xml legalnotice-relnotes-en.xml 
> Log Message:
> This is just a little hackish. With the legalnotice inline, it ruined the effect of the new release notes style and what's new content.  These changes, plus changes to the relnotes parent, pull a special relnotes legalnotice in that has a single sentence and links to an appendix with the full legalnotice content.  This is not semantically correct, there must be a way to handle this in the XSL so that the legalnotice content is properly contained throughout.  This hack can stand until I find the XSL fix, because sometimes Pretty is more important than Right.
> 
> 
> --- NEW FILE legalnotice-content-en.xml ---
> 
>   <para>
>     Permission is granted to copy, distribute, and/or modify this document under
>     the terms of the GNU Free Documentation License, Version 1.2 or any later
>     version published by the Free Software Foundation; with no Invariant
>     Sections, no Front-Cover Texts, and no Back-Cover Texts.  A copy of the
>     license is available at <ulink
>     url="http://www.gnu.org/licenses/fdl.html">http://www.gnu.org/licenses/fdl.html</ulink>.
>   </para>
> 
>   <para>
>     This document may be copied and distributed in any medium, either
>     commercially or noncommercially, provided that the GNU Free Documentation
>     License (FDL), the copyright notices, and the license notice saying the GNU
>     FDL applies to the document are reproduced in all copies, and that you add
>     no other conditions whatsoever to those of the GNU FDL.
>   </para>
> 
>   <para>
>     Garrett LeSage created the admonition graphics (note, tip, important,
>     caution, and warning).
>     Tommy Reynolds <email>Tommy.Reynolds at MegaCoder.com</email> created the callout graphics.
>     They all may be freely redistributed with documentation
>     produced for the &PROJECT;.
>     </para>
> 
>   <para>
>     &BOOKID;
>   </para>
> 
>   <para>
>     &RH;, &RH; Network, the &RH; "Shadow Man" logo, RPM, Maximum RPM, the RPM logo, Linux
>     Library, PowerTools, Linux Undercover, RHmember, RHmember More, Rough Cuts,
>     Rawhide and all &RH;-based trademarks and logos are trademarks or registered
>     trademarks of &FORMAL-RHI; in the United States and other countries.
>   </para>
> 
>   <para>
>     Linux is a registered trademark of Linus Torvalds.
>   </para>
> 
>   <para>
>     Motif and UNIX are registered trademarks of The Open Group.
>   </para>
> 
>   <para>
>     Intel and Pentium are registered trademarks of Intel Corporation. Itanium
>     and Celeron are trademarks of Intel Corporation.
>   </para>
> 
>   <para>
>     AMD, AMD Athlon, AMD Duron, and AMD K6 are trademarks of Advanced Micro
>     Devices, Inc.
>   </para>
> 
>   <para>
>     Windows is a registered trademark of Microsoft Corporation.
>   </para>
> 
>   <para>
>     SSH and Secure Shell are trademarks of SSH Communications Security, Inc.
>   </para>
> 
>   <para>
>     FireWire is a trademark of Apple Computer Corporation.
>   </para>
> 
>   <para>
>     All other trademarks and copyrights referred to are the property of their
>     respective owners.
>   </para>
> 
> 
> --- NEW FILE legalnotice-relnotes-en.xml ---
> <!-- $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> This document is released under the terms of the GNU Free Documentation
>     License.  For more details, read the full legalnotice in <xref
>       linkend="ax-legalnotice" />.
>   </para>
> </legalnotice>
> 
> 
> Index: fedora-entities-en.ent
> ===================================================================
> RCS file: /cvs/docs/common/fedora-entities-en.ent,v
> retrieving revision 1.2
> retrieving revision 1.3
> diff -u -r1.2 -r1.3
> --- fedora-entities-en.ent	31 May 2005 23:49:51 -0000	1.2
> +++ fedora-entities-en.ent	3 Jun 2005 03:43:08 -0000	1.3
> @@ -45,6 +45,8 @@
>  
>  <!-- ************** common doc files *********** -->
>  <!ENTITY LEGALNOTICE SYSTEM "./legalnotice-en.xml">
> +<!ENTITY LEGALNOTICE-CONTENT SYSTEM "./legalnotice-content-en.xml">
> +<!ENTITY LEGALNOTICE-RELNOTES SYSTEM "./legalnotice-relnotes-en.xml">
>  
>  <!-- ************** common applications? *********** -->
>  
> 
> 
> Index: legalnotice-en.xml
> ===================================================================
> RCS file: /cvs/docs/common/legalnotice-en.xml,v
> retrieving revision 1.8
> retrieving revision 1.9
> diff -u -r1.8 -r1.9
> --- legalnotice-en.xml	30 May 2005 20:30:27 -0000	1.8
> +++ legalnotice-en.xml	3 Jun 2005 03:43:08 -0000	1.9
> @@ -8,76 +8,5 @@
>  ]>
>  -->
>  <legalnotice id="legalnotice">
> -
> -  <para>
> -    Permission is granted to copy, distribute, and/or modify this document under
> -    the terms of the GNU Free Documentation License, Version 1.2 or any later
> -    version published by the Free Software Foundation; with no Invariant
> -    Sections, no Front-Cover Texts, and no Back-Cover Texts.  A copy of the
> -    license is available at <ulink
> -    url="http://www.gnu.org/licenses/fdl.html">http://www.gnu.org/licenses/fdl.html</ulink>.
> -  </para>
> -
> -  <para>
> -    This document may be copied and distributed in any medium, either
> -    commercially or noncommercially, provided that the GNU Free Documentation
> -    License (FDL), the copyright notices, and the license notice saying the GNU
> -    FDL applies to the document are reproduced in all copies, and that you add
> -    no other conditions whatsoever to those of the GNU FDL.
> -  </para>
> -
> -  <para>
> -    Garrett LeSage created the admonition graphics (note, tip, important,
> -    caution, and warning).
> -    Tommy Reynolds <email>Tommy.Reynolds at MegaCoder.com</email> created the callout graphics.
> -    They all may be freely redistributed with documentation
> -    produced for the &PROJECT;.
> -    </para>
> -
> -  <para>
> -    &BOOKID;
> -  </para>
> -
> -  <para>
> -    &RH;, &RH; Network, the &RH; "Shadow Man" logo, RPM, Maximum RPM, the RPM logo, Linux
> -    Library, PowerTools, Linux Undercover, RHmember, RHmember More, Rough Cuts,
> -    Rawhide and all &RH;-based trademarks and logos are trademarks or registered
> -    trademarks of &FORMAL-RHI; in the United States and other countries.
> -  </para>
> -
> -  <para>
> -    Linux is a registered trademark of Linus Torvalds.
> -  </para>
> -
> -  <para>
> -    Motif and UNIX are registered trademarks of The Open Group.
> -  </para>
> -
> -  <para>
> -    Intel and Pentium are registered trademarks of Intel Corporation. Itanium
> -    and Celeron are trademarks of Intel Corporation.
> -  </para>
> -
> -  <para>
> -    AMD, AMD Athlon, AMD Duron, and AMD K6 are trademarks of Advanced Micro
> -    Devices, Inc.
> -  </para>
> -
> -  <para>
> -    Windows is a registered trademark of Microsoft Corporation.
> -  </para>
> -
> -  <para>
> -    SSH and Secure Shell are trademarks of SSH Communications Security, Inc.
> -  </para>
> -
> -  <para>
> -    FireWire is a trademark of Apple Computer Corporation.
> -  </para>
> -
> -  <para>
> -    All other trademarks and copyrights referred to are the property of their
> -    respective owners.
> -  </para>
> -
> +&LEGALNOTICE-CONTENT;
>  </legalnotice>
> 
> --
> Fedora-docs-commits mailing list
> Fedora-docs-commits at 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/
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: This is a digitally signed message part
Url : http://lists.fedoraproject.org/pipermail/docs/attachments/20050602/c668ce38/attachment.bin 


More information about the docs mailing list