release-notes/FC-5/xmlbeats README, NONE, 1.1 beatlist, NONE, 1.1 steps-to-convert-v-1.txt, NONE, 1.1 to-do-fc5-errata-notes.txt, NONE, 1.1 to-do-fc5-gold-notes.txt, NONE, 1.1 wikixml2fdpxml, NONE, 1.1 xmlbeats, NONE, 1.1

Tue Jun 27 21:36:07 UTC 2006

Author: pfrields

Update of /cvs/docs/release-notes/FC-5/xmlbeats
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv7471/xmlbeats

Added Files:
	README beatlist steps-to-convert-v-1.txt 
	to-do-fc5-errata-notes.txt to-do-fc5-gold-notes.txt 
	wikixml2fdpxml xmlbeats 
Log Message:
Add stylesheets and supporting XML beats information as well

--- NEW FILE README ---
Edit 'beatlist' to specify which wiki file names to convert to XML, then run './xmlbeats'.

--- NEW FILE beatlist ---
Welcome
OverView
Feedback
Installer
ArchSpecific
ArchSpecific/PPC
ArchSpecific/x86
ArchSpecific/x86_64
PackageNotes
Kernel
Desktop
Printing
ServerTools
FileSystems
FileServers
WebServers
DevelTools
DevelTools/GCC
Security
Security/SELinux
Java
Samba
SystemDaemons
Multimedia
Entertainment
Networking
Virtualization
Xorg
DatabaseServers
I18n
BackwardsCompatibility
PackageChanges
Extras
Legacy
ProjectOverview
Colophon

--- NEW FILE steps-to-convert-v-1.txt ---

1. Use xmlbeats to get the content local

2. Convert filenames that need it to match the WikiName
   GCC.xml => DevelopmentToolsGCC.xml
   ...

3. Run xmlformat on all the Beats
   cd release-notes/xmlbeats/Beats
   for i in *.xml; 
     do 
     # Run xmlformat with the nifty config file
     xmlformat -f /path/to/xmlformat-fdp.conf $i > tmpfile; 
     mv tmpfile $i; done

4. Remove the <?xml>, <DOCTYPE>, <article />, and <articleinfo />
   contents from each file.

5. Run xmldiff to get a diff; do not use -p (default) as the colored
   output is icky when piped to a file.

   cd release-notes/xmlbeats/Beats
   mkdir ../diffs
   for i in *.xml; 
     do 
     # Get a mirror of the file name without extension
     echo $i | sed 's/\.xml//' > tmpname;
     # Format "oldfile newfile"
     #   oldfile == XML in CVS
     #   newfile == XML from Wiki
     xmldiff -u ../../`cat tmpname`-en.xml $i > ../diffs/`cat tmpname`.diff;
   done

--- NEW FILE to-do-fc5-errata-notes.txt ---

1. Update parent XML to call all beats in a flat namespace to match
   the wiki Docs/Beats page.  DONE

2. Add top-level sn-BeatName ID attributes for each file. 

3. Fix all admonition tables
   - fix table, or
   - make a proper admonition  

4. Fix missing version number:  

   http://fedoraproject.org/wiki/Docs/Beats?action=fullsearch&context=180&value=GetVal&fullsearch=Text#preview

   grep "Core  " *xml
   grep "Core ." *xml

5. Search all <screen> tags and fix the line breaks; may require
   injection of fresh content  
   - look for solo-list elements surrounding <screen>
     grep -B2 "<screen>" *.xml | grep listitem  

6. Look for unnecessary linebreaks around <code/>, it is being
  treated as a block.  Is this from xmlformat or the wiki output?

7. Watch for over sub-sectioning
   - have to build to notice?

8. When done, grep all XML files for:
   grep "code> ," *xml
   grep "code> ." *xml
   grep "Core  " *xml
   grep "Core ." *xml
   grep "Core ," *xml

## non-essential

8. Figure out how to have a @@RELNAME@@ variable.

9. Add in the release name?

?. Add call to every file to ../locale-entities.xml - scriptable NOT
   NEEDED 

X. Update .pot file? AUTOMATIC

## to-do -- Clean-up for the Wiki

1. Change all titles to not follow format of Docs/Beats/BeatName

2. Flatten the sub-sections a bit, where needed, avoiding orphaned
   sections

--- NEW FILE to-do-fc5-gold-notes.txt ---

1. Update parent XML to call all beats in a flat namespace to match
   the wiki Docs/Beats page.  DONE

2. Add top-level sn-BeatName ID attributes for each file. DONE

3. Fix all admonition tables
   - fix table, or
   - make a proper admonition  DONE

4. Fix missing version number:  DONE

   http://fedoraproject.org/wiki/Docs/Beats?action=fullsearch&context=180&value=GetVal&fullsearch=Text#preview

   grep "Core  " *xml
   grep "Core ." *xml

5. Search all <screen> tags and fix the line breaks; may require
   injection of fresh content  DONE
   - look for solo-list elements surrounding <screen>
     grep -B2 "<screen>" *.xml | grep listitem  

6. Watch for over sub-sectioning
   - have to build to notice?

7. Figure out how to have a @@RELNAME@@ variable.

8. Add in in the release name.

?. Add call to every file to ../locale-entities.xml - scriptable NOT
   NEEDED 

X. Update .pot file? AUTOMATIC

Clean-up for the Wiki

1. Change all titles to not follow format of Docs/Beats/BeatName

2. Flatten the sub-sections a bit, where needed, avoiding orphandd
   sections

--- NEW FILE wikixml2fdpxml ---
#!/bin/bash
#
# This file can be completely replaced with a better tool written in 
# $LANGUAGE of someone's choice
#
# Original shell script - 29-Jan-2005
# kwade at redhat.com

# Manually rename some files to include their wiki namespace
#echo "Renaming Wiki files."
#mv Beats/PPC.xml Beats/ArchSpecificPPC.xml
#mv Beats/x86_64.xml Beats/ArchSpecificx86_64.xml
#mv Beats/x86.xml Beats/ArchSpecificx86.xml
#mv Beats/GCC.xml Beats/DevelToolsGCC.xml
#mv Beats/SELinux.xml Beats/SecuritySELinux.xml
#echo "Finished renaming files."

# Fix the DocType header from bad Wiki output
#ls Beats/ > xmlfiles
#for i in `cat xmlfiles`;
#do
#  sed s'/DocBook V4\.4/DocBook XML V4\.4/g' Beats/$i > tmpfile;
#  mv tmpfile Beats/$i;
#  echo "DOCTYPE header fixed for" $i
#done
#rm xmlfiles
#echo "Done"

# Add the base language extension to the files
#ls Beats/ > xmlfiles
#for i in `cat xmlfiles`;
#  do
#  echo $i | sed 's/.xml/-en.xml/g' > newfilename;
#  mv Beats/$i Beats/`cat newfilename`;
#done
#rm xmlfiles newfilename
#echo "done"

# Right here is where we want to call perl-fu or python-fu
# to follow this pseudo-code
# 
# for each(<section>); 
#  do
#    get(contents of <title></title>) == $title;
#    replace(" " with "-") == $idattrib;
#    insert($idattrib) -> <section id="$idattrib">;
#  done

# We need to convert the targets of XREFs somehow

# This script uses the FDP implementation of xmldiff
# found in cvs.fedora:/cvs/docs/docs-common/bin/
#
# This script expects to be run in-place in
# the release-notes/xmlbeats module, as the paths
# are relative to that point
#
# $Id:
#
# First version kwade at redhat.com 2006-01-04 -- 0.1

# Variables
#XMLDIFF="../../docs-common/bin/xmldiff"
#XMLDIFF_OPTIONS="-p" # colored unified diff
#BEATPATH="./Beats"
#DBPATH=".."
#FILEEXT="*xml"

# Actions
# Run xmldiff against the beat and canonical XML

#for i in $BEATPATH/$FILEEXT;
#  do $XMLDIFF $XMLDIFF_OPTIONS $i

# Move the XML to the build directory
# mv Beats/*.xml ../

# Fix section names for the top-level
for i in `ls *.xml`;
  do
  echo $i | sed 's/\.xml//' > snID;
  echo "Section name sn-"`cat snID`" for "`echo $i`;
  sed 's/  <\/articleinfo>\n
  <section>/  <\/articleinfo>
  <section id="`cat snID`">/' $i > tmpfile;
  mv tmpfile $i;
  echo $i" has a new section id";
done

--- NEW FILE xmlbeats ---
#!/bin/sh

WIKIURL="http://fedoraproject.org/wiki/"
CONVERTERURL="http://www.n-man.com/moin2docbook.htm"
PAGES="`cat beatlist`"

rm -rf Beats
mkdir -p Beats

for PAGEBASE in $PAGES; do
	PAGENAME="Docs/Beats/${PAGEBASE}"
	PAGEENCODED="`echo "$PAGENAME" | sed 's/\//%2F/g' | sed 's/:/%3A/g'`"
	PAGEOUT="Beats/`echo "${PAGEBASE}" | sed "s/\///g"`.xml"
	echo -en "\"${PAGENAME}\" => \"${PAGEOUT}\"..."
	wget -q "${CONVERTERURL}?submit=submit&url=${WIKIURL}${PAGEENCODED}%3Faction=raw" -O "${PAGEOUT}"
	sed -i 's/DocBook V4\.4/DocBook XML V4\.4/g' "${PAGEOUT}"
        xmlformat -f ../../docs-common/bin/xmlformat-fdp.conf $i > tmpfile
        mv tmpfile $i
	echo -en " done.\n"
done