----- Forwarded message from "Paul W. Frields" <stickster(a)gmail.com>
-----
Delivered-To: ianweller(a)gmail.com
Date: Fri, 20 Mar 2009 17:12:15 -0400
From: "Paul W. Frields" <stickster(a)gmail.com>
To: Fedora Documentation Project <fedora-docs-list(a)redhat.com>
Mail-Followup-To: Fedora Documentation Project <fedora-docs-list(a)redhat.com>
User-Agent: Mutt/1.5.18 (2008-05-17)
Subject: Markup on wiki - please read
Precedence: junk
Reply-To: For participants of the Documentation Project
<fedora-docs-list(a)redhat.com>
Errors-To: fedora-docs-list-bounces(a)redhat.com
I've added a few extra templates for use on the wiki. I wish I had
time to do more, but these should help get people started. You can
add your own if you find other cases where these are useful.
There is already a great template for marking up package names:
{{package|name}}
When you use this template, by adding e.g. {{package|foo}} into your
page, you get a specially marked "foo" with a little package picture
next to it. It also links to a useful page. Please use it any time
you reference a package name in a wiki page.
The templates I created are somewhat less useful except when you
consider the idea of exporting wiki text out later. I created the
following:
{{filename|name}}
{{command|name}}
These are used wherever you'd use the <filename> and <command>
elements inline in a paragraph. (You don't use them when the text
appears on its own in a <pre> section on the wiki page.)
I've updated some text on the [[Fedora 11 Beta release notes]] page,
and invite you to take a look at it -- particularly the section on
"xguest" usage. There is example usage in this paragraph that will
help you get a feel for how to use these templates. I also invite
people to create more of these.
With standardized usage like this, we might be able to improve the
chances of getting useful wiki exports to DocBook through
e.g. python-mwlib or the like.
--
Paul W. Frields
http://paul.frields.org/
gpg fingerprint: 3DA6 A0AC 6D58 FEC4 0233 5906 ACDB C937 BD11 3717
http://redhat.com/ - - - -
http://pfrields.fedorapeople.org/
irc.freenode.net: stickster @ #fedora-docs, #fedora-devel, #fredlug
--
fedora-docs-list mailing list
fedora-docs-list(a)redhat.com
To unsubscribe:
https://www.redhat.com/mailman/listinfo/fedora-docs-list
----- End forwarded message -----
--
Ian Weller <ianweller(a)gmail.com>
GnuPG fingerprint: E51E 0517 7A92 70A2 4226 B050 87ED 7C97 EFA8 4A36