Use of asterisk "*" in distro name
by Paul W. Frields
As cute as I think it is, I think we should be standardizing on the
following usage for the distribution in official documentation
materials:
Full name: Fedora 7
Abbreviated name: F7
As opposed to "F*7" or "Fedora*7." The asterisk is not l10n friendly,
conceivably could affect searches, and I don't think the Board decided
to use it officially. Let's please standardize the usage in the Release
Notes and anywhere else under our watch.
--
Paul W. Frields, RHCE http://paul.frields.org/
gpg fingerprint: 3DA6 A0AC 6D58 FEC4 0233 5906 ACDB C937 BD11 3717
Fedora Project: http://fedoraproject.org/wiki/PaulWFrields
irc.freenode.net: stickster @ #fedora-docs, #fedora-devel, #fredlug
17 years, 2 months
clean-up for DUG XML
by Karsten Wade
I just committed some changes to the desktop-user-guide XML, removing
some cruft from the conversion. The diff should be sane when viewed
through fedora-docs-commits because I did this:
1. ran xmlformat on the files
2. committed those formatted files
3. made changes
4. ran xmlformat again
5. committed those changes
We may want to turn on the xmlformat for all files now, so we aren't
having to think about this. IIRC, we have a hook to allow us to have
xmlformat run on files as they are checked in, before the commit lands
in CVS.
I have a small list of other changes that need to be worked on. There
are two sections -- changes that have to be made to make it build and
work right, and changes that need to be made if we are doing a complete
conversion.
With the release notes, we sometimes opt not to change the XML to the
correct tags, because XML is an interim format. With a full conversion,
we want to convert e.g. <emphasis role="bold"> into one of the tags that
is supposed to correspond to:
http://fedoraproject.org/wiki/WikiEditing#Marking_Technical_Terms
For example, if the Wiki usage was '''Firefox''', the output to XML
becomes <emphasis role="bold">Firefox</emphasis>, and it needs to be
changed manually to <application>Firefox</application>.
In Emacs, I would put my cursor somewhere on the <emphasis...> tag, then
do 'C-c ='. In the status bar at the bottom appears "Change emphasis
to"; type "app[tab]", it fills out "application", and pressing [Enter]
changes the tag to <application>.
Here is the list of changes that I captured; there are surely more:
n. Convert all <article> => <chapter>
n. Give IDs to <sections>
n. Clean up <ulink> URIs => <xref>
n. Remove <anchor> (redundant)
- note that the ID is often present because it is linked to; use
where needed in the nearest <section> etc., then search for the
anchor text in the XML to find everywhere that links to this
information, then fix those (ulink => xref, etc.)
n. Convert admonitions (search for <table>, /wikidata/kindofblue/img/)
n. Remove <articleinfo> and </articleinfo> from <chapter>s, including
the bogus <title>Docs/DesktopUserGuide/</title>
n. Remove footer navigation hack (last table in a page)
n. Remove CategoryDocumentation <para> at the end
n. Look for how <code> is used; it gets a line break and sometimes
<para> around it that is not appropriate.
n. <listitem> that does not surround <para> should be adjusted
<listitem>foo</listitem> => <listitem><para>foo</para></listitem>
For full conversion to XML:
Note: Once you have done this conversion, and bug fixes and updates
to the Wiki and/or the XML need to be manually ported to the other
format. In other words, once you distance your XML from its Wiki
roots, you cannot easily insert new Wiki content or go backward.
n. <emphasis role='bold'></emphasis> => <application> or <keycombo>
n. <emphasis></emphasis> => <guimenu>, <firstterm>, etc.
n. <code></code> => <code>, <computeroutput>, <userinput>, <screen>,
etc.
n. Create <keycombo> (search for [)
n. <citetitle> for FIG
--
Karsten Wade, RHCE, 108 Editor ^ Fedora Documentation Project
Sr. Developer Relations Mgr. | fedoraproject.org/wiki/DocsProject
quaid.108.redhat.com | gpg key: AD0E0C41
////////////////////////////////// \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
17 years, 2 months
Transcript of FOSDEM DocBook XML Session
by John Babich
Fedora Docs Team:
I prepared a slightly-edited transcript of the IRC session held today at FOSDEM,
where a group of Docs Project team members mastered the fine art of converting
a wiki document, Desktop User Guide, into a DocBook XML book.
Karsten Wade and Paul Frields led the group through the process.
The transcript is at http://fedoraproject.org/wiki/JohnBabich/FosdemDocs.
John Babich
Volunteer, Fedora Docs Project
17 years, 2 months
Style, and how to use it
by Paul W. Frields
For those folks writing on the wiki, please be sure and check out the
draft Style guide, which was mostly written by the illustrious Patrick
Barnes and nitpicked a little by me and a few other folks:
http://fedoraproject.org/wiki/DocsProject/StyleGuide
English is a useful, but sometimes arcane and difficult, lingua franca
used throughout Fedora. Fortunately enough people know it that we can
communicate fairly well with each other, hopefully with a minimum of
misunderstandings.
But because Fedora aims to reach a global community, it is also
important we maintain our documents in a translatable fashion. English
unfortunately lends itself to many constructs which are very awkward for
translators. By using a consistent, clear, and simple writing style,
you the writer can ensure translators, who are also usually volunteers,
find your document easy to localize to their native language.
As you write, please keep the style guidelines in mind. If you have
questions, always feel free to raise them on the list. If you find an
issue not answered in the Style Guide, you also have an opportunity to
improve it. Once we agree on an answer here, we can update the wiki
page so everyone benefits.
Thanks again and good luck with your drafting!
--
Paul W. Frields, RHCE http://paul.frields.org/
gpg fingerprint: 3DA6 A0AC 6D58 FEC4 0233 5906 ACDB C937 BD11 3717
Fedora Project: http://fedoraproject.org/wiki/PaulWFrields
irc.freenode.net: stickster @ #fedora-docs, #fedora-devel, #fredlug
17 years, 2 months
Fosdem FDP Hackfest: DUG
by Bart Couvreur
Hi all,
so today Fosdem 2007 started and we're planning on doing the DUG \"wiki
to XML\"-conversion today.
Because Max's talking at 1400 UTC and we (Dimitris, Pawel and me) are
gonna linger there, we're gonna start the conversion at 15OO UTC (16OO
Brussels local time).
We'll be lingering at #fedora-docs on irc.freenode.net for anyone who
wants to join in.
Karsten and Paul (?) will be around to guide us through it, so if you
wanna learn this, hop on to irc and see ya there!
FDP-guys @ Fosdem
17 years, 2 months
Move over fdsco meetings to #fedora-meeting?
by Rahul Sundaram
Hi
Would folks in the steering committee consider $subject?
http://fedoraproject.org/wiki/Communicate/FedoraMeetingChannel.
Basically you need to pick up a meeting slot and list yourself in the
page above. The advantage is that folks can stay in the same channel for
all meetings and it separates the social chats from formal meetings and
kind of forces everyone to have different timings which is good for
folks who sit on and participate in more than one meeting.
Cons?
Rahul
17 years, 2 months
Install Guide strings for Figure, Chapter, Section etc.
by Igor Miletic
Hi all,
Does anyone know where can I find strings for words Figure, Chapter and
Section to translate in Install Guide? They are not in main po file and
I was not able to find them in docs-common.
Another question. Are there plans to create po files for DUG? It looks
very useful for beginners and it would be nice if it was available for
translation.
Regards,
Igor
17 years, 2 months
Wiki Guide proposal
by Dimitris Glezos
Hi all.
Today we got the wiki upgraded (thanks to Mike and the FI folks) and added some
CSS tweaks [1]. The new version and the CSS foo render the wiki more usable,
promote code reuse and can help us avoid some HTML-hacking happening around.
[1]: http://fedoraproject.org/wiki/DimitrisGlezos/WikiDesignTuning
So, we all know that having clean pages with consistent look-and-feel is A Good
Thing™ and that our wiki wouldn't mind some work to make it more usable and
good-looking. :)
I think we should have a good Wiki Guide that documents the use of the wiki. We
do have some scattered information here and there like `/WikiEditing`, but the
pages are huge and not very usable. In the guide we could promote ways to have
good and organized content, avoid HTML hacking, etc. For this, we are also
investigating enabling a moin module that will give us wikipedia-style templates
that can further increase code reuse.
Here are some ideas for the contents of the guide:
* Structure of the wiki
* Structure of a page
* Getting access
* Page templates / skeletons and personal pages
* Writing style (mostly pointers to existing Docs)
* Page editing (/HelpOnEditing)
* Media (Graphics, videos, etc)
* Exporting to DocBook
* Various tps
How does the idea sound?
Oh, also, in the following weeks we'll try to further enhance the image of our
wiki and probably design some more banners for pages to look nice.
-d
--
Dimitris Glezos
Jabber ID: glezos(a)jabber.org, GPG: 0xA5A04C3B
http://dimitris.glezos.com/
"He who gives up functionality for ease of use
loses both and deserves neither." (Anonymous)
--
17 years, 2 months