Starting to get crowded in common/, needed a little explanation of the assets.release-notes-FC4-2

1 files changed, 63 insertions, 0 deletions

diff --git a/common/README b/common/README
new file mode 100644
index 0000000..b135088
--- /dev/null
+++ b/common/README
@@ -0,0 +1,63 @@
+<!-- $Id: -->
+This README explains the relationship of the files in
+/cvs/docs/common/.  This is specific to the Fedora Documentation
+Project (FDP).
+
+cvs-en.xml
+
+  Generic chapter explaining what CVS is and how to use it.  Used in
+  Developer Guide.
+
+draftnotice-en.xml
+
+  Used when a document is in draft/beta stage.  This is usually put at
+  the very top of the parent XML file so that it is the first thing
+  read.  Calls to this entity are removed when the document is moved
+  to a live status.  This prevents confusion in thinking a beta
+  document is the genuine document.  
+
+fedora-entities-en.ent
+
+  DocBook entities are declared in this file.  All entities that are
+  even remotely common across FDP should have an entity in this file.
+
+fedora-entities-en.xml - DEPRECATED
+
+  This file served the same as fedora-entities-en.xml but is
+  deprecated due to an inaccurate file extension.
+
+legacynotice-en.xml
+
+  This entity is called from a document that relates to a specific
+  version of Fedora Core that is moving from the Fedora Project to the
+  Fedora Legacy Project for management and maintenance.
+
+legalnotice-content-en.xml
+
+  This is the actual content of the legalnotice.  Change content here
+  to propagate to all systems.
+
+legalnotice-en.xml
+
+  This is the common call of the legalnotice material, used in the
+  <articleinfo> and appearing as a link above the ToC, or directly
+  inline if the XSL linking is disabled.  The release notes use inline
+  legalnotice, so have a different common file.
+
+legalnotice-relnotes-en.xml
+
+  This is called by only the release notes.  It contains a single
+  reference to the GFDL, and an <xref> to the <appendix> that has a
+  call to the actual content from legalnotice-content-en.xml.  This
+  keeps the inline usage of the legalnotice from overwhelming the
+  layout.
+
+  NOTE: this is a sematic hack and should be fixed by changes to the
+  XSL.
+
+obsoletenotice-en.xml
+
+  Used for documents that are for a version of Fedora Core that is no
+  longer supported by the Fedora Project and is not being maintained
+  by the Fedora Legacy Project.  Documents with this notice are no
+  longer being maintained.