In order to make it easier to move content to and from the Wiki, I have
reworked the release-notes module to match filenames 1:1 with Wiki beat
names.
Below are my notes from refactoring-notes.txt in CVS. Translators need
to follow the directions to get the new files and carry over previous
translations. One reasons to do this conversion is to allow us to use
xmldiff (in cvs.fedora:/cvs/docs/docs-common/bin) more effectively. You
can use this tool to check the differences of the content between the
XML tags, which should be more useful than line-based diff for detecting
content changes.
There will be a one-time PITA for the translators, but following this it
should be *much easier* for translation (due to using xmldiff.)
Note that the DocBook parent XML and sub-XML files do *not* follow the
same layout of content as the pages at
http://fedoraproject.org/wiki/Docs/Beats . This is because the
gathering of information and the display of information are two separate
needs. The Docs/Beats pages are laid out to support writers focused on
specific content. The release notes are laid out for readers.
I would like to rework the layout of the release notes themselves for
test3. This refactoring of files is a step in that direction.
## begin refactoring-notes.txt
Questions? Email to fedora-docs-list(a)redhat.com.
0. Make a back-up of the *-en.xml files, if you need them for
reference. The content is all present in the new files, but it may
be easier for you to have the old files for reference.
1. Be sure to have newest files in the release-notes and docs-common
module. 'cvs up -d' can help to make sure you get new files.
2. All languages except en have been removed from the Makefile target:
LANGUAGES = en #it ja_JP ru zh_CN
# uncomment languages when you have all the same
# fies localized as are listed in XMLEXTRAFILES
As the comments say, when you are ready to test the build for your
language, move the language code to the left of the #comment mark
and run 'make html'.
3. Old files are left in place for you to use. You can take the
existing translation and move it to the new location. When you are
done, or let us know on fedora-docs-list(a)redhat.com and the old
files will get cleaned up.
4. Some of the old language specific files have been renamed. In the
cases where content has been split into multiple files or the file
is new, a blank file has been created. You need to move content
from the old file into the new file, as per the table below.
5. This table shows the name of the old file and the name of the new
file. This conversion has been done for -en only. Three old files
on the left have been split into two or more files on the right.
They are development-tools*xml, security*xml, and splash*xml.
Old filename New filename
=============================================================
[New File] ArchSpecific-en.xml
[New File] ArchSpecificPPC-en.xml
[New File] ArchSpecificx86-en.xml
[New File] ArchSpecificx86_64-en.xml
[New File] BackwardsCompatibility-en.xml
colophon-relnotes-en.xml Colophon-en.xml
daemons-en.xml SystemDaemons-en.xml
database-servers-en.xml DatabaseServers-en.xml
desktop-en.xml Desktop-en.xml
development-tools-en.xml DevelopmentTools-en.xml
DevelopmentToolsGCC-en.xml
DevelopmentToolsJava-en.xml
entertainment-en.xml Entertainment-en.xml
file-servers-en.xml FileServers-en.xml
file-systems-en.xml FileSystems-en.xml
hardware-reqs-en.xml [Deleted]
i18n-en.xml I18n-en.xml
install-notes-en.xml Installer-en.xml
intro-en.xml Introduction-en.xml
java-package-en.xml PackageNotesJava-en.xml
kernel-en.xm Kernel-en.xml
legacy-en.xml Legacy-en.xml
misc-server-en.xml [Deleted]
multimedia-en.xml Multimedia-en.xml
networking-en.xml Networking-en.xml
overview-en.xml OverView-en.xml
package-movement-en.xml PackageChanges-en.xml
package-notes-en.xml PackageNotes-en.xml
printing-en.xml Printing-en.xml
project-overview-en.xml ProjectOverview-en.xml
README-en.xml [Ignore]
RELEASE-NOTES-en.xml [Same]
RELEASE-NOTES-master-en.xml [Deleted]
samba-en.xml Samba-en.xml
security-en.xml Security-en.xml
SecuritySELinux-en.xml
server-tools-en.xml ServerTools-en.xml
splash-en.xml Welcome-en.xml
(content split into:) OverView-en.xml
web-servers-en.xml WebServers-en.xml
xorg-en.xml Xorg-en.xml
--
Karsten Wade, RHCE * Sr. Tech Writer *
http://people.redhat.com/kwade/
gpg fingerprint: 2680 DBFD D968 3141 0115 5F1B D992 0E06 AD0E 0C41
Content Services Fedora Documentation Project
http://www.redhat.com/docs http://fedoraproject.org/wiki/DocsProject