From Fedora Project Wiki

Revision as of 20:56, 18 January 2009 by Nippur (talk | contribs) (vertaling naar nl)

2008-09-06 Wiki structuurregels nu beschikbaar
Help:Wiki_structure beschrijft hoe de structuur van de wikki dient te zijn, inclusief paginabenaming.
Deze pagina wordt in het Nederlands vertaald
Dit zal zo snel mogelijk gebeuren, maar ook zo zorgvuldig mogelijk; indien er vertaalfouten of domweg taalfouten in staan, wilt u dit bij overleg aangeven of gewoon verbeteren? Tyvm. RL 12.01.2009
Additionele opmaak bronnen
Help:Editing from Mediawiki.org is een goede Engelse bron voor hulp bij tekstopmaak. Er is ook nog een handige -in het Engels gestelde- referentie kaart


Het Fedora Project Wiki staat u snel toe als bewerker in te stappen. Echter, er kan een kleine leercurve ontstaan als u de wiki begint te gebruiken, en we hebben een aantal richtlijnen die elke bewerker moet volgen. Deze pagina maakt u bekend met deze richtlijnen en geeft een aantal tips om u op weg te helpen.

Dit document is verdeeld in drie delen: toestemming krijgen om te bewerken, basis wiki bewerken en bewerken voor gevorderden.


Toestemming krijgen om te bewerken

Om te voorkomen dat kwaadwillende gebruikers het Fedora Project Wiki voor gek zet, hebben we toestemming om te bewerken enigzins beperkt. Om toestemming krijgen om te bewerken moet u een paar simpele stappen nemen. Iedereen kan echter toestemming krijgen om te bewerken.

  1. Maak uzelf eigen met de informatie op deze pagina en de pagina's waarnaar wordt gelinkt. De basisrichtlijnen die gevolgd moeten worden door de gehele wiki heen worden hier behandeld. Het niet volgen van deze richtlijnen heeft veel onnodig werk voor andere vrijwilligers tot gevolg en kan leiden tot het intrekken van uw edit-privileges.
  2. Completeer de Contributor License Agreement via het Fedora Account System. De CLA tekenen geeft het Fedora Project de mogelijkheid om uw bijdragen aan de wiki onder licentie te brengen van de Open Publication License 1.0. Zo wordt verzekerd dat uw bijdragen voor altijd vrijelijk door de gemeenschap kan worden gebruikt, aangepast en heruitgegeven, net als de Fedora distributie. Zie verder deze Legal sectie voor meer informatie. Volg de Engelse instructies op Infrastructure/AccountSystem/CLAHowTo.
Indien u geïnteresseerd bent in meer algemene website onderhoud, of deel wilt nemen aan het Fedora Websites team, bekijk dan de Websites pagina.
Informatie over schrijven van nieuwe formele Fedora documentatie met gebruik van de wiki is beschikbaar op Writing Wiki Documentation.

Richtlijnen en Wiki Etiquette

Er zijn een aantal eenvoudige punten die u moet aanhouden wanneer u veranderingen aanbrengt aan de wiki. Hierna staan een aantal voorbeelden. In het algemeen, wees beleefd en gebruik uw gezond verstand. Deze richtlijnen negeren en problemen veroorzaken zijn zeer goede manieren om uw edit-priveleges in te laten trekken. Indien u vragen hebt, kunt u die stellen op #fedora-websites op freenode.

Introduceer uzelf

Voordat u een pagina gaat bewerken, weest u dan zo vriendelijk u voor te stellen door informatie over u toe te voegen op uw wiki pagina. Nadat u zich hebt ingelogd met uw FAS-naam en uw FAS-wachtwoord verkrijgt u automagisch ;) een persoonlijke pagina op de lokatie http://fedoraproject.org/wiki/User:<username>, waarbij <username> is vervangen door uw FAS-naam (uw Fedora Account System account naam). Deze usernaam kunt u vervolgens linken naar een nieuwe pagina met uw uitgeschreven voornaam aan elkaar geschreven met uw volle achternaam (bijvoorbeeld JanJansen) als titel. Op deze laatste pagina stelt u zich voor. U kunt als u bent ingelogd snel bij uw FAS-wiki-pagina komen door boveraan rechts van het midden van elke wiki pagina op uw usernaam te klikken.

Voor voorbeelden kijk eens naar JeroenVanMeeuwen, BartDeSoete, GeertWarrink of RichardvanderLuit.

Vermeld in ieder geval uw email-adres en, indien u veel op irc zit, uw IRC nick en kanalen waar u vaak te vinden bent.

Houdt de pagina's die u maakt of bewerkt altijd in de gaten

Het is belangrijk dat u de veranderingen op de pagina's die u heeft gemaakt of gecreëerd goed in de gaten houdt, opdat u de inhoud met anderen die aan de wiki werken kunt coördineren. Wiki bewerkers voegen vaak aantekeningen toe om informatie uit te wisselen als een methode van samenwerking, en dat helpt goed om dergelijke veranderingen in de gaten te houden.

U kunt de Volgen link in de tab bar rechts boven in een wiki pagina vinden indien u bent ingelogd.

Wees stoutmoedig

Verander gerust pagina's, wees niet bang. Wiki veranderingen worden gevolgd en teruggedraaid indien nodig. Dit betekent echter niet dat u roekeloos kunt zijn, zeker niet indien u grote veranderingen maakt in sleutel documenten.

Voor meer informatie over stoutmoedigheid (being bold in engels), neem een engels kijkje op be bold editing guideline on Wikipedia.

Vermijd onnodige veranderingen aan pagina's die rechtenkwesties aansnijden

Dat soort pagina's zijn zeer zorgvuldig samengesteld, en de woorden erin zijn stuk voor stuk afgewogen. Indien u deze pagina's toch wilt veranderen moet u om een review van een ander vragen alvorens de veranderingen door te voeren. U kunt in dat geval het best de Fedora Advisory Board benaderen voor hulp in deze.

Geef geen details omtrent verboden zaken

Voeg geen enkele informatie toe strijdig met de wet. Onthoud dat het Fedora Project een entiteit is in de Verenigde Staten, en daarom onderworpen aan haar wetten. Vermijd linken naar of toevoegen van informatie over niet vrije open source software of software dat wettelijk beschermd is. Indien u denkt dat u zich in een uitzonderlijke positie bevindt, breng dat dan onder de aandacht van het Websites team voor discussie. Zie ook de ForbiddenItems pagina's voor voorbeelden van gevallen die moeten worden vermeden.

Voor vragen hieromtrent wendt u zich to het Websites team. Indien noodzakelijk, kunnen zij een officieel standpunt achterhalen.

Wees voorzichtig wanneer u belangrijke gidsen of belangrijke pagina's aanpast

Grote en belangrijke gidsen, zoals de Packaging Guidelines, worden over het algemeen onderhouden door een bepaald persoon of een bepaald groepje. Het beste kunt u met hen contact opnemen indien u vindt dat daarin iets moet worden aangepast.

Belangrijke pagina's, zoals de FedoraMain of Download pagina's, zijn pagina's die vaak door menig bezoeker als eerste worden gezien. Veranderingen aan dergelijke pagina's moeten in het algemeen aan ervaren bewerkers worden overgelaten. Indien u vindt dat er iets aan dit soort pagina's moet worden aangepast, neem dan daarover contact op met het Websites team om dat te bespreken.

Verander geen pagina's puur om het veranderen zelf

Zinloze veranderingen dienen te worden vermeden. Een verandering maken om slechts in het edit-log te komen is onacceptabel. Er zijn genoeg pagina's (de meeste om precies te zijn) met echte corrigeerbare fouten. In plaats van zinloze veranderingen te maken, zoals het weghalen of toevoegen van spatieruimte of links veranderen als fedoraproject.org in www.fedoraproject.org (de eerste vorm verdient de voorkeur), kunt u beter spel- of taalfouten zoeken en corrigeren. Denk er ook aan "Dit is een kleine bewerking" onder aan de editpagina aan te vinken indien u een kleine fout corrigeert.

Vermijd hernoemen van pagina's of verplaatsen van inhoud zonder overleg

Naar alle Wiki pagina's wordt over het algemeen wel verwezen door of naar gelinkt van diverse andere lokaties. Het is daarom belangrijk dat u goed met de juiste groepen afstemt alvorens u pagina-inhoud naar elders verplaatst of bestaande pagina's hernoemt. Het verdient de aanbeveling dit slechts te doen als het echt niet anders kan. Indien u verplaatsing van een bepaald item wenst, dient u dit te bespreken met het Websites team.

Verwijderen van pagina's

Wiki pagina's die niet langer nodig zijn dienen te worden gemerkt voor verwijdering door {{Delete|Reden in het Engels}} aan het begin van de pagina toe te voegen. Dit geeft de Wiki Administrators de mogelijkheid zich te verzekeren dat er geen belangrijke of te archiveren inhoud verloren gaat.

Volg de idealen die Fedora hoog in het vaandel heeft staan

Bijvoorbeeld, probeer desktop-neutraal te zijn en gebruikersvriendelijk, helemaal voor niet-technische gebruikers waarvoor Linux en Fedora nieuw zijn. Gebruikers kunnen gebruik maken van GNOME, KDE, de console of een andere omgeving. Probeer dat voor ogen te houden wanneer u instrukties schrijft. Verwittig u ervan dat Fedora's toewijding voor gratis en open bron technologie eveneens netjes wordt uitgedragen.

Teken uw bijlagen

Wanneer u een bestand aan een wiki pagina toevoegt, dient u met uw GPG-sleutel een losse handtekening aan te maken. Sommige bestandsformaten, zoals RPM-paketten, ondersteunen GPG-sleutels. In zo'n geval hoeft u geen losse handtekening te maken, een handtekening in het bestand zelf is dan voldoende. Een losse handtekening kan worden toegevoegd aan de pagina tesamen met het oorspronkelijke bestand, of kan in de pagina zelf worden opgenomen.

GPG-handtekeningen staan anderen die uw bestand willen downloaden in staat te verifieren dat het inderdaad van u afkomstig is en niet tussentijds is veranderd of verminkt. GPG-handtekeningen schenden op geen enkele manier uw privacy, zij stellen slechts anderen in staat vertrouwen te hebben in de afkomst van het bestand.

Afbeeldingen en eenvoudige documenten kunnen gerust zonder handtekening, maar het kan nooit kwaad indien men kan zien dat u inderdaad de auteur ervan bent.

Indien u nog geen GPG-sleutel hebt of er meer van wilt weten, ga dan naar de Cryptography pagina.

Kijk uw werk na op fouten

Of u nu een volleerd schrijver bent, of niet, nodig iemand uit om na te lezen wat u hebt geschreven. Goedgeschreven documenten zijn belangrijk voor Fedora's imago. Zelfs de beste schrijvers zien typefouten en andere missers over het hoofd. Neem de tijd om uw veranderingen na te lezen om die vervelende kleine foutjes eruit te halen. Gebruik de Bewerking ter controle bekijken knop onderaan de edit-pagina om uw tekst te controleren. Sla pas na controle de pagina op.

Fedora is een gemeenschap

Wanneer u dingen schrijft, voor de wiki of elders, onthoud dan dat Fedora een gemeenschap is. Wij treden op als één groep, op weg naar gemeenschappelijke doelen. Wij hebben er geen behoefte aan een groep of klasse daarbinnen te onderscheiden van een andere. Er is bijvoorbeeld geen noodzaak onderscheid te maken tussen medewerkers die in dienst zijn van Red Hat en zij die dat niet zijn. Alle medewerkers zijn onderdeel van dezelfde gemeenschap. Er zullen gevallen zijn waarbij classificatie nu eenmaal nodig is, maar het kan en zal zoveel mogelijk worden vermeden.

Als u iets niet weet, aarzel dan niet het te vragen

Andere leden van de gemeenschap zullen u graag helpen. Het #fedora-websites channel op freenode is de perfecte plaats om de wiki of andere Fedora websites te bespreken.

Houd uw pagina's in de gaten, en andere pagina's ook

Twee facetten maken een wiki succesvol als middel om samen te werken aan een open inhoud. Ten eerste dat u de inhoud van pagina's waarvoor u verantwoordelijk bent in de gaten houdt, opdat de bedoeling van de pagina gewaarborgd blijft. Ten tweede dat u in staat bent in de gaten te houden dat andere pagina's ontwikkelen, groeien en nu en dan uw hulp nodig hebben.

Om welke pagina op de wiki dan ook in de gaten te houden klikt u -na inloggen- de volgen tab boven aan elke pagina aan. Het moet dan veranderen in niet volgen. Als een pagina niet volgen boven aan heeft, bent u deze pagina aan het volgen. U kunt niet volgen aanklikken om de pagina niet meer te volgen. De tab verandert dan weer in volgen.

Om emails te ontvangen bij elke verandering, ga naar mijn voorkeuren (bovenaan de pagina bij uw naam) en vergewis u er van dat de juiste opties zijn aangevinkt bij de tab gebruikersprofiel, onder E-mail.

Volglijst (Special:Watchlist) Gebruiken

Special:Watchlist (beschikbaar via volglijst boven aan elke pagina wanneer u bent ingelogd) toont de pagina's die u op dat moment aan het volgen bent. Voor meer informatie hoe u deze speciale pagina moet gebruiken , zie de Engelse handleiding op Mediawiki.org.

Maak een samenvatting van uw veranderingen -- dit is de regel

We moeten allen in staat zijn even de ogen te laten dwalen over een verandering om gelijk de kern ervan te weten. Een volledige vergelijking met de oude tekst is niet altijd beschikbaar. U dient een opsomming te maken van uw veranderingen (Samenvatting: veld als u aan het bewerken bent). Het is als een changelog-bericht. Verklaar wat u deed en waarom, alsmede andere toepasselijke links en en details.

Als u er voor kiest niets samen te vatten, dient dit echt een uitzondering te zijn. Een reden kan zijn dat het slechts een kleine aanpassing betreft. In dat geval dient u het hokje Dit is een kleine bewerking aan te vinken alvorens de pagina op te slaan.

Editing with Mediawiki

Indien u hulp nodig hebt met syntax dat hier niet vermeld wordt, kijk dan op Mediawiki Help (Engels).

Basis Syntax

Wat u typt Hoe het er uit ziet
'''vet'''
vet
''schuin''
schuin
'''''vet en schuin'''''
vet en schuin
<code>Monospace text</code>
Monospace text

Opsomming

Wat u typt Hoe het er uit ziet
* Een opsommingsregel
* Nog een opsommingsregel
** Oh nee hè, weer een opsommingsregel!
  • Een opsommingsregel
  • Nog een opsommingsregel
    • Oh nee hè, weer een opsommingsregel!
# Een genummerde regel
# Nog een genummerde regel
## Sub regel
## Meer sub regels
# Derde genummerde regel
  1. Een genummerde regel
  2. Nog een genummerde regel
    1. Sub regel
    2. Meer sub regels
  3. Derde genummerde regel
* Een opsommingsregel...
*# Met een genummerde sub-regel
*# Meer genummerde sub-regels
* Terug naar de eerste niveau opsommingsregel
*# Meer genummerde regels
*#* met eigen opsommingsregel
  • Een opsommingsregel...
    1. Met een genummerde sub-regel
    2. Meer genummerde sub-regels
  • Terug naar de eerste niveau opsommingsregel
    1. Meer genummerde regels
      • met eigen opsommingsregel

Links

Wat u typt Hoe het er uit ziet
Bezoek [[DocsProject]] om meer te weten te komen over
Fedora's documentatie.
Bezoek DocsProject om meer te weten te komen over

Fedora's documentatie.

Ons [[Websites|websites team]] biedt vele
individuen die Fedora kunnen helpen.
Ons websites team biedt vele

individuen die Fedora kunnen helpen.

Lees [[Artwork#Join]] over hoe je aan te sluiten bij het Art Team.
Lees Artwork#Join over hoe je aan te sluiten bij het Art Team.
[[The weather in London]] is een
pagina die nog niet bestaat.
The weather in London is een pagina die nog niet bestaat.
http://fedoraproject.org/
http://fedoraproject.org/
Hier zijn enkele sites:
[http://www.deviantart.com]
[http://www.flickr.com]
Hier zijn enkele sites: [1] [2]
[http://fedoraproject.org Onze home page]
staat vol met interessante informatie.
Onze home page staat vol met interessante informatie.
Gebruik een ':' in de link om te linken
naar een [[:Image:Growth_wide.jpg|afbeelding]].
Gebruik een ':' in de link om te linken

naar een afbeelding.

De [[:Category:Documentation]] somt alle 
documentatie voor de eindgebruiker op.
De Category:Documentation somt alle

documentatie voor de eindgebruiker op.

De [[Category:Documentation]] link plaatst
deze pagina in de opgesomde categorie; de link
verschijnt automatisch onderaan de pagina en niet binnenin de pagina.
De [[Category:Documentation]] link plaatst

deze pagina in de opgesomde categorie; de link verschijnt automatisch onderaan de pagina en niet binnenin de pagina.

Er zijn twee manieren om de Category links te gebruiken
Vergewis u ervan dat de ':' voor het woord 'Category' staat indien de bedoeling is dat verwezen moet worden naar een categorie pagina. Laat de ':' weg indien de pagina geacht dient te worden bij die categorie te behoren. Bekijk bovenstaande voorbeelden goed.

Tabellen

Tabellen dienen spaarzaam te worden gebruikt en uitsluitend indien noodzakelijk.

Voor meer gevorderde tabellengebruik, lees Mediawiki.org's page on tables (Engels).

Wat u wilt Hoe u het krijgt
Begin een tabel
{|
Tabel Kop
! kolom 1 !! Kolom 2 !! Kolom 3
Nieuwe rij
|-
Tabel rij
| Cel 1 || Cel 2 || Cel 3
Eindig een tabel
|}

IRC Logs

IRC logs kunnen hetzij worden ingesloten met <pre> tags, hetzij converteerd in MediaWiki pipe-tables met irclog2html en Ian's MediaWiki patch for irclog2html.

Structuur van een Wiki Pagina

Deze sectie beschrijft de meest voorkomende structuur van een wiki pagina. Volg deze richtlijnen voor elke wiki pagina. Er zijn aanvullende regels die gebruikt worden voor officiele Fedora documentatie; behandeld in DocsProject/WritingUsingTheWiki ; die regels zijn alleen noodzakelijk voor inhoud waarbij bij het schrijven de procedures van de Fedora Documentation Project moeten worden gevolgd. Pagina's als sjablonen en die met standaard inhoud, bedoeld om in andere pagina's te worden opgenomen, kunnen een andere structuur hebben.

Kop 1 (h1) wordt afgeraden in opmaak
De kop 1 wordt gedefinieerd door de pagina titel. Bij het maken van nieuwe of bij het verplaatsen van pagina's, her-nest of herstructureer de pagina dusdanig dat er alleen nog maar kop 2 en lager in voorkomen.
  • De titel van een pagina is een kop van het eerste niveau. Deze wordt automagisch gecreëerd via de pagina titel.
  • Secties ontstaan door isgelijktekens in paren:
== Kop 2 ==
=== Kop 3 ===
==== Kop 4 ====
===== En doe dit niet, 5 niveaus nesting betekent dat je een nieuwe pagina of drie nodig hebt=====
  • Een inhoudsopgave wordt automatisch gegenereerd op het moment dat de pagina groot genoeg geworden is.
  • Ankers naar secties worden automatisch gegenereerd, met specifieke symbolen op de plek van leestekens en spaties.
Deze pagina ==> Deze_pagina
Dit, dat, en de andere pagina ==> Dit%2C_dat%2C_en_de_andere_pagina


U kunt .2C gebruiken in plaats van %2C voor ankers
De vervanging van '.' voor '%' werkt voor ankers aan een specifieke sectie.

Snelle Tips

Dit was de basis van wat u dient te weten als u deze Wiki wilt bewerken.

Voor meer informatie
betreffende het optekenen van documentatie op de Wiki leze men Writing Wiki Documentation (in Engels).


Leer aan de hand van voorbeelden

Eén van de betere manieren om te leren hoe je de wiki kan bewerken is het bekijken van code van bestaande pagina's. Dat is heel eenvoudig te doen:

  1. Vind een pagina waarvan je de bron zou willen zien
  2. Klik op de tab view source boven aan pagina

De wiki toont u de brontekst van die pagina. Dit is erg waardevol als u sommige slimme truukjes van eerdere wiki bewerkers wilt leren en overnemen. Deze truukjes zijn echt waardevol omdat zij u in staat stellen niet vaak voorkomende, interessante, krachtige dingen te doen waarvan u niet dacht dat die mogelijk waren. Probeert u eens op bijvoorbeeld FedoraMain.

Aantekeningen, Tips, and Andere Admonitions

Deze staan allen samen bekend onder de naam 'admonitions', en worden gebruikt in DocBook. Om een paragraaf het uiterlijk te geven van een admonition, gebruikt u de speciale admonition sjabloon. Een korte titel en een wat langere beschrijving als paragraaf verdient de voorkeur.

Wat u typt Wat u ziet
{{admon/note|Een titel|Hier staat meer informatie over
deze tip, met informatie dat meer inzicht geeft in
de informatieve titel van de initiële inleiding.}}
Een titel
Hier staat meer informatie over deze tip, met informatie dat meer inzicht geeft in de informatieve titel van de initiële inleiding.

Dit zijn de standaard types admonition:

Wat u typt Wat u ziet
{{admon/note|Dit is een noot|Informatieve paragraaf
welke vertelt wat er aan de hand is.}}
Dit is een noot
Informatieve paragraaf welke vertelt wat er aan de hand is.
{{admon/tip|Dit is een tip|Informatieve paragraaf
welke vertelt hoe met een bepaalde situatie 
omgegaan kan worden.}}
Dit is een tip
Informatieve paragraaf welke vertelt hoe met een bepaalde situatie omgegaan kan worden.
{{admon/important|Dit is belangrijk|Informatieve 
paragraaf met dringend advies.}}
Dit is belangrijk
Informatieve paragraaf met dringend advies
{{admon/caution|Dit betekent opgepast|Informatieve 
paragraaf welke wijst op gevaar of risico.}}
Dit betekent opgepast
Informatieve paragraaf welke wijst op gevaar of risico.
{{admon/warning|Dit is een waarschuwing|Informatieve
paragraaf met duidelijke waarschuwing.}}
Dit is een waarschuwing
Informatieve paragraaf met duidelijke waarschuwing.


Admonitions Voorbeelden

Voorbeelden van context waarbinnen deze admonitions worden gebruikt:

Afgronden kunnen heel diep zijn
Wikipedia kan dit bevestigen.
Niet te dicht bij de rand van de afgrond komen is een manier om er niet in te vallen
Voor meer informatie, lees de HoeOverleefIkWandelenMetMijnVrouw(1) man pagina.
Houd uw kinderen weg bij de rand van de afgrond
Kinderen rennen van hot naar her en hebben de neiging nogal eens niet op te letten.U doet er goed aan hun hand vast te houden. Of juist niet.
U komt steeds dichter bij de rand van de afgrond
Zoals eerder vermeld kunnen afgronden heel diep zijn. Er in vallen wordt afgeraden.
U staat op het punt in de afgrond te vallen
Maak u zo snel mogelijk in de juiste richting uit de voeten. Even denken voordat u gaat rennen dus.

Lees de Fedora Documentation Guide voor beschrijvingen van admonition types: http://docs.fedoraproject.org/documentation-guide/en_US/sn-xml-admon.html

Marking Technical Terms

Use the code markup (<code>) to mark the names of applications, files, directories, software packages, user accounts, and other words that have a specific technical meaning. This displays the marked words as monospace.

Use two single-quotes () to mark the names of menu items and other elements of the graphical interface. This displays the marked words in italic.

Term Mark Up Formatted example
Names of GUI applications
 '''boldface''' 
Firefox
Files, directories
 <code>inline code tags</code> 
/usr/bin/firefox
Software packages
 <code>package name</code> 
firefox-1.2.3
User accounts
 <code>username</code> 
username
Other words that have a specific technical meaning
 <code>technical term</code> 
... the class org.fedora.someJava.classname ...
Graphical menus and menu items
 ''Menu name'' 
Applications > Internet > Firefox Web Browser
Other GUI or WebUI interface element
 ''two single-ticks'' 
... click the Submit button ...
Inline command and daemons
 <code>command -option</code> <code>daemon</code>
grep httpd to find the PIDs of the running httpd processes.
Blocks of code, configuration files, etc.
 <pre>whitespace preserved< /pre> 
whitespace
    is preservered
  here
Inline pieces of code, configuration files, etc.
 <code>inline whitespace not preserved</code> 
... Next, modify the variables for set() in /path/to/org/dev108/classname ...
First term, glossary term
 ''term'' 
... Firefox is an example of a graphical user interface or GUI.
Keystrokes
 '''[Key]''' 
Press the [Enter] key ...

For example:

The <code>thunderbird</code> package installs the '''Mozilla Thunderbird'''
e-mail application. To start '''Thunderbird''', select:
  ''Applications > Internet > Thunderbird Email''.

Which produces:

The thunderbird package installs the Mozilla Thunderbird e-mail application. To start Thunderbird, select: Applications > Internet > Thunderbird Email.

Writing Example Commands

Example commands are one or more commands set apart from the body of the explanation. Do not use prompt symbols or any other content that shows machine name, user, directory, etc. (which are details set in the $PS1 environment variable.)

Enclose any example command in <pre></pre> tags:

<pre>
su -c "yum install awesome-application"
</pre>

Enter the <code>root</code> password when prompted.

Which produces:

su -c "yum install awesome-application"

Enter the root password when prompted.

Command examples and root
Many commands require root privileges. The reader should not be logged into their system as root, and so you must specify either su -c or su - when explaining such commands.

If the command requires elements to be quoted, nesting should be " ", with the single quote marks surrounded by one containing set of double quote marks. For example:

su -c "command -o 'Some Text' -file 'More text' foo/bar"

If you need to have a series of commands or su -c is not responding as expected, have the user switch to root and warn the user to return to a normal user shell afterward.

su -
Password:
service food stop
cp /etc/foo.d/foo.conf /etc/foo.d/foo.conf.backup
vi /etc/foo.d/foo.conf
food --test-config
...
service food start
exit

Example command output

When the example shows a command as part of showing the output to the screen, you may use a command prompt to clarify commands and output.

$ su -c "ls -l /root"
Password: 
total 148
-rw------- 1 root root  1961 2007-09-21 02:46 anaconda-ks.cfg
-rw-r--r-- 1 root root 46725 2007-09-21 02:46 install.log
-rw-r--r-- 1 root root  6079 2007-09-21 02:42 install.log.syslog
-rw-r--r-- 1 root root  3699 2008-07-28 17:24 scsrun.log
-rw-r--r-- 1 root root 45038 2008-01-10 10:21 upgrade.log
-rw-r--r-- 1 root root  1317 2008-01-10 10:20 upgrade.log.syslog

Try it Out Yourself

Try new things in the Fedora Wiki Sandbox . It is also a good place to see lots small samples at work.

Creating New Pages in the Wiki

The Fedora Project Wiki is large, and so there is a need to maintain a proper hierarchy and organization. The best way to learn about these is to review Help:Subpages and Help:Categories, and then to review the existing layout of the wiki.

Redundant names (such as Foo/FooBar/FooBarGrue) should be avoided. Remember that including 'Fedora' in the page name is redundant. Major Fedora projects do not need to have 'Project' in their page names, either. For example, the Fedora Websites Project has its page named 'Websites', not 'FedoraWebsitesProject'.

For the most part, pages should be grouped as subpages by the projects or programs they are part of. Categories will generally be created for different projects and programs, and should be created sparingly. Most pages you create should be part of a category, and many should also have appropriate tags. If you are thinking about creating a new category or tag, please ask the Websites team for advice first.

If you have questions, feel free to ask the Websites team.

Important Pages

Key pages, such as Main Page, should be edited sparingly. Changes to such pages should generally be discussed on the mailing lists or on IRC before being applied. Some parts of the wiki may have different permissions. For example, the DocsProject has a section for the creation of new documentation which is restricted a bit more than the rest of the wiki. In order to gain edit access to such pages, you may have to complete additional steps. You can usually find instructions on those pages.

Getting Help

If ever you have questions about editing the Fedora Project wiki, or if you need help, please feel free to contact the Websites team. They have an IRC channel (#fedora-websites on freenode) and a mailing list (fedora-websites-list) that are both effective for getting the answers you need.

If you would like to do a lot of editing on the wiki, you should consider joining the Websites team.