Help:Wiki_structure beschrijft hoe de structuur van de wikki dient te zijn, inclusief paginabenaming.
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
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 editor 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 editor 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 editen, basis wiki editing en editing voor gevorderden.
Toestemming krijgen om te editen
Om te voorkomen dat kwaadwillende gebruikers het Fedora Project Wiki voor gek zet, hebben we toestemming om te editen enigzins beperkt. Om toestemming krijgen om te editen moet u een paar simpele stappen nemen. Iedereen kan echter toestemming krijgen om te editen.
- 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.
- 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.
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 editen, 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 edit 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 editeuren 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 gelinked 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 toegevoegt 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
Whether you are a skilled writer, or your English skills are not strong, invite someone else to review. Well-written documents are important to Fedora's image. Even the best writers are prone to typos or other errors. Take a moment to review your changes to catch small errors. Use the Show preview button when editing a page to check your syntax.
Fedora is een gemeenschap
When writing content, for the wiki or elsewhere, remember that Fedora is a community. We operate as one, unified group, moving towards common goals. We do not need to distinguish one group or class against another. For example, there is no need to distinguish between contributors who work for Red Hat and those who do not. All contributors are part of the same community. There will be cases where classification is necessary, but it can be avoided otherwise.
If you aren't sure about something, feel free to ask
Other community members will be happy to assist you. The #fedora-websites channel on freenode is the perfect place to discuss the wiki or other Fedora websites.
Watch your pages, and other ones, too
Two details make a Wiki successful as an open content collaboration tool. First is being able to watch content you are responsible for, to make certain it stays true to its mission. Second is being able to watch other content develop, grow, and occasionally need your help.
To watch any page on the wiki, after logging in, click the watch link in the tab bar at the top of a page. It should change to unwatch after it has finished. If a page has unwatch at the top, you are already watching that page. You can click unwatch to unwatch a page.
To receive emails for every edit, go to my preferences (at the top of the page by your name) and make sure to check the appropriate boxes in the User profile tab, under Email.
Using Special:Watchlist
Special:Watchlist (available by clicking my watchlist at the top of each page when you are logged in) displays pages you are currently watching. For more information on how to use this special page, please the manual page at Mediawiki.org.
We are now maintaining a stand-alone Watchlist_How-To to help Fedora contributors with specific suggestions and tools.
Summarize your changes (aka commit log message) -- this is the rule
We all need to be able to quickly glance at a change and know the substance of it. A full diff is not always available. You must supply a summary of your change (Summary: field when editing). This is akin to a changelog message. Explain what you did and why, as well as other useful links and details.
If you choose to not put in a summary, it should be the rare exception. One reason is when doing a minor edit. In that case, be sure to check This is a minor edit when saving.
Editing with Mediawiki
Basic Syntax
| What you type | What it looks like |
|---|---|
'''bold text''' |
bold text |
''italics'' |
italics |
'''''bold italics''''' |
bold italics |
<code>Monospace text</code> |
Monospace text
|
Lists
| What you type | What it looks like |
|---|---|
* A list item * Another list item ** Oh joy, more list items! |
|
# A numbered item # Another numbered item ## Sub items ## More sub items # Third numbered item |
|
* An unordered item... *# With a sub-list that is ordered *# More steps * Back to the first list *# Another ordered list *#* With its own sub point |
|
Links
| What you type | What it looks like |
|---|---|
Visit [[DocsProject]] to learn more about Fedora's documentation. |
Visit DocsProject to learn more about Fedora's documentation. |
Our [[Websites|websites team]] offers many individuals who can help Fedora. |
Our websites team offers many individuals who can help Fedora. |
See [[Artwork#Join]] on how to join the Art Team. |
See Artwork#Join on how to join the Art Team. |
[[The weather in London]] is a page that doesn't exist yet. |
The weather in London is a page that doesn't exist yet. |
http://fedoraproject.org/ |
http://fedoraproject.org/ |
Here are some sites: [http://www.deviantart.com] [http://www.flickr.com] |
Here are some sites: [1] [2] |
[http://fedoraproject.org Our home page] is full of interesting information. |
Our home page is full of interesting information. |
Use a ':' in the link to link to an [[:Image:Growth_wide.jpg|image]]. |
Use a ':' in the link to link to an image. |
The [[:Category:Documentation]] lists all end-user documentation. |
The Category:Documentation lists all end-user documentation. |
The [[Category:Documentation]] link puts this page in the listed category; the link appears automatically on the bottom of the page and not inline. |
The [[Category:Documentation]] link puts this page in the listed category; the link appears automatically on the bottom of the page and not inline. |
Be sure to use the ':' before the word Category when you intend to link to a category page. Omit the ':' when the page is supposed to be in that category. Refer to the examples above.
Tables
Tables should be used sparingly and only when necessary.
For more advanced table usage, read up on Mediawiki.org's page on tables.
| What you want | How to get it |
|---|---|
| Start a table | {|
|
| Table header | ! Column 1 !! Column 2 !! Column 3 |
| New row | |- |
| Table row | | Cell 1 || Cell 2 || Cell 3 |
| End a table | |} |
IRC Logs
IRC logs can either be surrounded in <pre> tags, or converted into MediaWiki pipe-tables with irclog2html and Ian's MediaWiki patch for irclog2html.
Structure of a Wiki Page
This section describes the common structure of a wiki page. Follow these guidelines for every wiki page. There are additional rules used for formal Fedora documentation, covered in DocsProject/WritingUsingTheWiki ; those rules are only required for content written to follow the procedures of the Fedora Documentation Project. Pages that are templates of standard content that are drawn into other pages may have a different structure.
The header 1 is defined by the page title. When making new or migrating pages, either re-nest or re-structure the page to have only header 2 and below.
- The title of the page is a first-level header. It is created automatically from the page title.
- Sections are created using the equals symbols in pairs:
== Header 2 == === Header 3 === ==== Header 4 ==== ===== Don't do this, 5 levels of nesting means you need a new page or three =====
- The table of contents is automatically created and populated when the page grows big enough.
- Anchors to sections are automatically created, with specific symbols used in place of punctuation and spaces:
This page ==> This_page This, that, and the other page ==> This%2C_that%2C_and_the_other_page
The substitute of '.' for '%' works for anchors against a specific section.
Quick Tips
These are the basic things that you need to know to edit this Wiki.
Learn by Example
Among the better ways to learn how to edit the wiki is reviewing the code of existing pages. This is very easy to do:
- Find a page whose source you would like to view.
- In the Navigation bar, find the combo box that reads 'More Actions:' and click on it.
- Select the 'Show Raw Text' option.
The wiki will display the plaintext form of that page. This is particularly valuable for learning some of the clever tricks used by wiki editors ahead of you. Those 'clever tricks' are valuable, as they allow you to do unique, interesting, and powerful things you might not have thought were possible. You might try this on pages like FedoraMain.
Notes, Tips, and Other Admonitions
These are collectively known as admonitions, and are used in DocBook. To make a paragraph into an admonition, use the special admonition template. A short title and a longer descriptive paragraph are recommended.
| What you type | What you see |
|---|---|
{{admon/note|A title|Here is more information about
this tip, with information that provides more insight
into the informative title of the initial paragraph.}}
|
A title
Here is more information about this tip, with information that provides more insight into the informative title of the initial paragraph. |
Indent the initial and second paragraph by one space, to ensure that the box aligns correctly.
These are the standard types of admonition:
| What you type | What you see |
|---|---|
{{admon/note|This is a note|Informational paragraph
that tells more about what is going on.}} |
This is a note
Informational paragraph that tells more about what is going on. |
{{admon/tip|This is a tip|Informational paragraph
that tells more about what is going on.}} |
This is a tip
Informational paragraph that tells more about what is going on. |
{{admon/important|This is important|Informational paragraph
that tells more about what is going on.}} |
This is important
Informational paragraph that tells more about what is going on. |
{{admon/caution|This is a caution|Informational paragraph
that tells more about what is going on.}} |
.png){kind=small} This is a caution
Informational paragraph that tells more about what is going on. |
{{admon/warning|This is a warning|Informational paragraph
that tells more about what is going on.}} |
 This is a warning
Informational paragraph that tells more about what is going on. |
Admonition examples
Examples showing context for using these admonitions:
Wikipedia can vouch for this.
For more information, read the
cliffs(1) man page.Children move around quite a bit and can easily fall off. You should hold their hand.
As mentioned earlier, cliffs can be very high, and it would be bad to fall.
Move away as quickly as possible to avert falling.
Refer to the Fedora Documentation Guide for descriptions of the types of admonition: 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.
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.