Bearbeiten des Fedoraprojekt-Wikis
Das Wiki vom Fedoraprojekt hat eine sehr geringe Zugangsbeschränkung für Editoren. Es gibt eine niedrige Lernkurve beim Einstieg in die Benutzung des Wikis. Jedoch haben wir ein paar Richtlinien, denen alle Editoren folgen sollten. Auf dieser Seite finden Sie diese samt ein paar Tipps beim Laufenlernen.
Zugriff für das Bearbeiten erhalten
Um das böswillige Verändern von Seiten des Fedoraprojekt-Wikis zu vermeiden, mussten wir den Zugang etwas beschränken. Wenn Sie Bearbeitungszugriff auf das Wiki haben möchten, müssen Sie ein paar einfachen Schritten folgen. (Fast) jeder kann diesen Zugriff bekommen.
1. Machen Sie sich mit den Informationen auf dieser und den verlinkten Seiten vertraut. Sie enthalten die grundlegenden Richtlinien. Werden diese nicht eingehalten, produziert das unnötige Arbeit anderer Freiwilliger und könnte im Entzug der Bearbeitungsrechte enden.
2. Legen Sie einen Account an
Der erste Schritt zum Erhalten der Bearbeitungsrechte ist das Besuchen der Seite BenutzerEinstellungen (User
Preferences), sowie das Erzeugen eines Accounts. Der Nutzername sollte Ihr realer Name im Wiki-Format sein: Vorname
Nachname (z.B.Otto
Normalbearbeiter) Dieses Format wird für das Verbinden innerhalb des Wikis benötigt.
3. Schliessen Sie die Lizenzvereinbarung für Beitragende (Contributor License Agreement – CLA) über das Fedora Account System ab!
Das (elektronische) Unterschreiben der CLA gibt dem Fedoraprojekt die Möglichkeit, Ihre Beiträge zum Wiki unter der Open Publication License 1.0 ohne Optionen zu veröffentlichen. Das stellt sicher, dass Ihre Beiträge der Community dauerhaft zum Benutzen, Verändern und weiter Verbreiten zur Verfügung stehen – ganz wie die Fedora-Distribution. Konsultieren Sie unseren rechtlichen Bereich für weiter gehende Informationen. Folgen Sie den Instruktionen im CLAHowTo .
4. Fragen Sie jemanden in der EditGroup Jeder auf der Seite der EditGroup Aufgeführte kann Sie dieser hinzufügen. Diese Gruppe hat die Bearbeitungsrechte für die meisten Teile des Wiki. Wenn Sie bereits Kontakt zu Beitragenden hatten, fragen Sie sie einfach, ob sie Sie hinzufügen. Es ist immer besser, wenn Sie bereits Kontakt zu Ihrem Ansprechpartner hatten, aber nicht zwingend erforderlich. Wenn Sie niemanden haben, den Sie ansprechen könnten, schauen Sie bei #fedora-websites auf freenode vorbei. Wenn auch das nicht funktioniert, fügen Sie sich der Seite EditGroupQueue hinzu und warten Sie darauf, dass Sie jemand hinzufügt.
Derjenige, der Sie hinzufügt, muss im account query interface prüfen, dass Sie bereits in der cla_done
-Gruppe sind.
Richtlinien
Es gibt ein paar einfache, beim Änderungen am Wiki zu befolgende Punkte. Unten finden Sie ein paar Beispiele. Allgemein sollten sie höflich und allgemein verständlich sein. Verstösse gegen diese Richtlinien und das Verursachen von Probleme sind eine hervorragene Möglichkeit, damit die Bearbeitungsrechte entzogen werden. Fragen stellen Sie am besten unter #fedora-websites in freenode .
Stellen Sie sich vor
Vor dem Bearbeiten irgendeiner Seite sollten Sie sich auf Ihrer Wiki-Seite vorstellen. Nach der Registrierung im Wiki erhalten Sie diese automatisch unter http://fedoraproject.org/wiki/<WikiName>
, wobei <WikiName>
durch Ihren Wiki-Anmeldenamen ersetzt wird.
Beispiele finden Sie in der CategoryHomepage.
Stellen Sie sicher, dass zumindest Ihre E-Mail-Adresse erwähnt ist. Webmaster oder andere Mitglieder der Community müssen Sie vielleicht wegen der von Ihnen bearbeiteten Seiten ansprechen. Es gibt mehrere Wege, Ihre E-Mail-Adresse vor Harvestern zu schützen:
Sie müssen mit dem Abwägen von Vor- und Nachteilen der jeweiligen Lösung abwägen und die für Sie geeignetere heraussuchen.
Abonnieren Sie immer die von Ihnen erstellten oder bearbeiteten Seiten
Es ist wichtig, dass Sie den Änderungen an den von Ihnen erstellten oder bearbeiteten Seiten folgen, um sich mit anderen am Wiki Arbeitenden koordinieren zu können. Wiki-Bearbeitern fügen üblicherweise die Änderung beschreibende Bemerkungen den Seiten als Teil ihrer Zusammenarbeit hinzu, die ihnen beim Verfolgen der Änderungen helfen.
Sie finden den Abonnieren-Link in der seitlichen Leiste, wenn Sie eingeloggt sind.
Vermeiden Sie unnötiges Bearbeiten von Seiten, die rechtliche Themen beschreiben
Diese Seiten wurden aufmerksam geschrieben, die Worte mit viel Sorgfalt gewählt. Beim Ändern ist es das Beste, vorher um Korrektur oder einen Kommentar zu bitten. Sie können dazu das Fedora Advisory Board (vgl. Seite Projektleitung ) um Unterstützung bitten.
Stellen Sie keine Informationen über verbotene Elemente zur Verfügung
Fügen Sie keine Informationen hinzu, die Rechte verletzen könnten. Bedenken Sie, dass das Fedoraprojekt Eigentum in den Vereinigten Staaten ist und damit deren Gesetzen unterliegt. Vermeiden Sie es, Informationen über nicht freie oder Open-Source-Software hinzuzufügen oder auf diese zu verlinken. Wenn Sie der Meinung sind, es handelt sich um eine Ausnahme, lassen Sie das Webseiten -Team darüber diskutieren. Die Seite [de_DE/VerboteneElemente: Verbotene Elemente] enthält Beispiele für zu vermeidende Formulierungen.
Diskutieren Sie Fragen mit dem Webseiten -Team. Wenn notwendig, kann dieses dann das Thema in die Öffentlichkeit tragen.
Seien Sie beim Bearbeiten von Schlüsselregeln oder –seiten vorsichtig
Grosse und wichtige Regeln wie die Packaging Guidelines werden im Allgemeinen von einer Person oder einer kleinen Gruppe verwaltet. Am günstigsten ist es, wenn Sie bei Ihrer Meinung nach notwendigen Änderungen mit diesen zusammenarbeiten.
Wichtige Seiten wie die Hauptseite oder die Download -Seite sind das Erste, was viele Besucher zu sehen bekommen. Änderungen daran sollten grundsätzlich erfahrenen Bearbeitern überlassen werden. Wenn etwas Ihrer Meinung nach geändert werden sollte, diskutieren Sie es im Webseiten -Team.
Bearbeiten Sie keine Seiten zum Selbstzweck
Sinnlose Änderungen sind zu vermeiden. Seitenänderungen, nur um den eigenen Namen im Log zu sehen, sind inakzeptabel. Es gibt eine Menge Seiten (praktisch die meisten), die überarbeitet werden müssten. Anstatt unnötige Änderungen wie das Hinzufügen oder Entfernen von Leerzeichen vorzunehmen oder die Links von fedoraproject.org in www.fedoraproject.org zu ändern (wobei erstere Schreibweise bevorzugt wird), versuchen Sie Rechtschreib-, Grammatik- oder Interpunktionsfehler zu finden und zu korrigieren. Bitte markieren Sie so kleine Änderungen auch durch Anhaken der entsprechenden Checkbox, bevor Sie abspeichern.
Vermeiden Sie unkoordiniertes Umbenennen von Seiten oder Verschieben von Inhalten
Auf Wiki-Seiten wird üblicherweise von den verschiedensten anderen Stellen verwiesen. Daher ist es wichtig, sich vor dem Umbenennen von Seiten oder dem Verschieben von Inhalten mit den geeigneten Gruppen abzustimmen. Ohne einen wichtigen Grund sollte dies ohnehin vermieden werden. So gelagerte Vorhaben sollten Sie mit dem Webseiten -Team diskutieren.
Folgen auch Sie den Idealen von Fedora
Bleiben Sie z. B. Desktop-neutral und nutzerfreundlich speziell für nicht technische Nutzer oder diejenigen, für die Linux und Fedora neu ist. Nutzer verwenden GNOME, KDE, die Konsole oder eine andere Umgebung. Versuchen Sie das beim Schreiben Ihrer Instruktionen zu berücksichtigen. Stellen Sie sicher, dass die Ausrichtung von Fedora auf freie und Open-Source-Software ausreichend berücksichtigt ist.
Unterschreiben Sie Ihre Anhänge
Wenn Sie einer Wiki-Seite eine Datei beifügen, sollten Sie eine Signatur mit Ihrem GPG-Schlüssel erzeugen. Einige Dateiformatie wie RPM-Pakete unterstützen GPG-Schlüssel, so dass Sie keine separate Signatur erzeugen müssen. Eine in der Datei genügt. Eine so erzeugte Signatur kann wie der Anhang der Seite beigefügt werden oder in dieser selbst enthalten sein.
GPG-Signaturen erlauben es dem Benutzer die heruntergeladenen Datei zu überprüfen, dass die Datei tatsächlich von Ihnen kommt und nicht verändert wurde. Sie verletzen Ihre Persönlichkeitsrechte keinesfalls, sondern geben nur anderen die Sicherheit, dass diese Dateien tatsächlich, so wie sie sind, von Ihnen stammen.
Bilder und einfache Dokumente brauchen nicht unbedingt mit einer Signatur versehen werden.
Wenn Sie keinen GPG-Schlüssel haben oder mehr darüber wissen wollen, lesen Sie die Cryptography -Seite.
Prüfen Sie Ihre Änderungen auf Fehler
Gleich, ob Sie ein guter Schreiber oder ein weniger in Englisch begabter sind, bitten Sie jemanden, Ihre Dokumente Korrektur zu lesen. Gut geschriebene Dokumente sind wichtig für das Image von Fedora. Auch die besten Schreiber sind nicht vor Fehlern gefeit. Nehmen Sie sich einen Moment Zeit, um wenigstens den grössten Teil der Fehler zu finden.
Fedora ist eine Gemeinschaft
Wenn Sie Beiträge für das Wiki oder etwas anderes schreiben, denken Sie daran, dass Fedora eine Gemeinschaft ist. Wir agieren als eine einheitliche Gruppe zu gemeinsamen Zielen. Wir brauchen nicht zwischen Gruppen oder Klassen zu trennen. Beispielsweise gibt es keinen Grund zwischen Beitragenden zu unterscheiden, die für Red Hat arbeiten und denen, die das nicht tun. Alle Beitragenden sind Teil der gleichen Gemeinschaft. Es mag Fälle geben, in denen eine Klassifizierung notwendig ist, aber es sollte wo möglich vermieden werden.
Wenn Sie bei etwas nicht sicher sind, fragen Sie
Die anderen Mitglieder der Community werden Ihnen gern helfen. der #fedora-websites-Kanal auf freenode ist der perfekte Platz, um Dinge zum Wiki und anderen Fedora-Webseiten zu diskutieren.
Beobachten Sie Ihre Seiten. Und die anderen auch
Zwei Dinge machen ein Wiki zu einem erfolgreichen Werkzeug offener Zusammenarbeit. Zunächst einmal ist es die Möglichkeit, Inhalte zu beobachten, für die Sie verantwortlich sind. Damit stellen Sie sicher, dass die Dokumente nicht falsch sind oder verwendet werden. Zweitens ist es die Möglichkeit, die Inhalte anderer Seiten zu beobachten und bei Bedarf einzugreifen.
Es gibt mehrere Möglichkeiten, eine Seite zu abonnieren:
1. Holen Sie die Nachrichten mit Ihrem RSS-Reader direkt von http://fedoraproject.org/wiki. 1. Fügen Sie den regulären Ausdruck für die Dokumente, die Sie beobachten wollen, Ihren Nutzereinstellungen unter Abonnierte Wikiseiten hinzu. Beispielsweise beobachtet dieser Ausdruck drei Dokumente:
Docs/Drafts/AdministrationGuide.* Docs/Draft/Glossary.* Docs/Drafts/DesktopUserGuide.*
Dieser Audruck beobachtet alle Änderungen im Entwurfsbereich:
Docs/Drafts.*
Folgender Ausdruck überwacht alle Änderungen im DocsProject , einschliesslich der Namensbereiche Docs und der Docs/Drafts :
Docs.*
Editieren mit MoinMoin
Die Onlinehilfe ist eine wertvolle Hilfe, wenn Sie das Editieren von Wiki-Seiten lernen wollen. Wenn Sie diese Seiten aufmerksam lesen, lernen Sie sicher ein paar nette Tricks. Sie sollten sie mindestens einmal lesen, danach sind sie als Kurzreferenz beim Editieren immer da. Fragen zum Editieren stellen Sie in #fedora-websites auf freenode.net .
Struktur einer Wiki-Seite
Dieser Abschnitt beschreibt die übliche Struktur von Wiki-Seiten. Folgen Sie bitten diesen Regeln für jede Wiki-Seite. Es gibt weitere Regeln für die formale Fedora-Dokumentation, die in DocsProject/WritingUsingTheWiki beschrieben werden. Diese Regeln werden auf das Schreiben für das Fedora-Dokumentationsprojekt angewendet.
1. Der Titel der Seite ist der first-level header. Schliessen Sie ihn in die Symbole =
ein:
= Seitentitel =
1. Unter dem = Seitentitel =
und vor dem Abschnitt == Einleitung ==
fügen Sie bitte das Inhaltsverzeichnis-Makro ein:
= Seitentitel = == Einleitung ==
1. Hauptabschnitte können einen Anker für schönere Verknüpfungen verwenden. Das Verwenden der Überschrift mit durch Unterstrichen ersetzten Leerzeichen erleichtern das Lesen des URL. Unabhängig vom verwendeten Stil: Bleiben Sie durch das Dokument konsistent.
{{Anchor|Titel_des_Abschnitts}} == Titel des Abschnitts ==
1. Wichtige Seiten können mittels CategoryFoo
am Ende der Seite und unter einer horizontalen Linie kategorisiert werden. Ersetzen Sie Foo
durch eine Kategorie wie Documentation
.
---- [[Category:Documentation
]]
1. Fortsetzung folgt
Quick Tips
Das sind die Grundlagen, die Sie beim Editieren dieses Wikis kennen müssen.
Lernen am Beispiel
Unter den geeigneteren Möglichkeiten das Editieren des Wikis zu erlernen, ist das Untersuchen des Codes bereits existierender Seiten. Das geht sehr leicht:
- Suchen Sie sich eine Seite, deren Code sie gern inspizieren würden.
- Klicken Sie in der Combobox “Weitere Aktionen” im Navigationsbereich auf “Rohform anzeigen”.
Das Wiki zeigt Ihnen den Klartext dieser Seite. Das ist speziell für diejenigen wertvoll, die sich ein paar clevere Tricks beim Wiki-Editieren von Erfahreneren, als sie selbst es sind, abschauen wollen. Diese Tricks sind insofern wertvoll, als dass Sie dadurch interessante und mächtige Funktionen einsetzen können, an die Sie nicht im Traum gedacht haben. Probieren Sie es mal an Seiten wie Start-Seite .
Verbinden
Das Verbinden von Seiten ist vielleicht die einfachste und geschickteste Sache in MoinMoin. Die einfachste Form ist das Verwenden des Wikinamens. Der besteht aus zwei oder mehr gross geschriebenen Worten. Wenn Sie einen Wiki
Namen verwenden, brauchen Sie keine spezielle Text-Auszeichnung verwenden – der Link wird automatisch erzeugt.
Um diese Funktion zu vermeiden, wenn sie nicht erwünscht ist, können Sie einen weiteren cleveren Trick anwenden. Sie trennen die beiden Worte durch zwei kurze Rückstriche (Backticks): WikiWorte
Wiki
. Dadurch unterdrücken Sie sicher die Routine der automatischen Kennzeichnung von Wikiworten. Wenn Sie auf eine Unterseite oder eine Seite ohne Wikinamen verweisen wollen, nutzen Sie folgende Syntax: Worte
Unterseite eines Projekts
oder einfach ["SeitenName"]
.
Vermeiden Sie es, Links zu anderen Webseiten innerhalb eines Absatzes zu schreiben. Beschreiben Sie diese Webseite stattdessen und schreiben Sie den URL des Links auf eine separate Zeile. Das stellt sicher, dass der URL auch nach dem Drucken oder dem Konvertieren in ein anderes Format noch lesbar ist. Beispiel:
Suchen Sie vor dem Start auf der Fedora-Dokumentationsseite nach der neuesten Version. [http://docs.fedoraproject.org]
Mehr dazu finden Sie unter HelpOnLinking.
Listen
Sowohl nummerierte als auch nicht nummerierte Listen sind einfach und hilfreich. Details zu ihrer Benutzung finden Sie unter HelpOnLists.
Tabellen
Tabellen können etwas schwierig sein, weil sie sich nicht wie erwartet verhalten. Speziell breite Tabellen können Probleme verursachen, weil gerade beim Betrachten in kleineren Fenstern über die Ränder hinausgehen können. Daher ist es am besten, Tabellen nur wenn unumgänglich zu verwenden. Beim Umgang mit einer grossen Anzahl kleinerer Datensätze können sie eine Menge Platz sparen. Testen Sie sie bitte bei Benutzen ausgiebig und beachten Sie dabei, dass andere Anwender möglicherweise eine geringere Auflösung als Sie verwenden. Weitere Informationen finden Sie unter HelpOnTables.
Anmerkungen, Tipps und andere Textboxen
Diese werden unter dem Begriff ADMONITIONS zusammengefasst. Um einen Absatz als ADMONITION zu formatieren, geben Sie jeweils zwei Pipe-Symbole am Anfang und am Ende ein, schreiben den Titel in Fettschrift, fügen ein geeignetes Symbol hinzu und fügen weiterführende Informationen als zweiten Absatz hinzu.
{{Admon/tip | Das ist ein Beispieltipp. | Hier stehen weiterführende Informationen zum dem in der Überschrift genannten Titel.}}
Rücken Sie den ersten und zweiten Absatz mit jeweils einem Leerzeichen ein, damit die Box korrekt ausgerichtet ist.
Das sind die Standardtypen der ADMONITION:
Lesen Sie den Fedora-Dokumentationsführer für eine Beschreibung der Typen von ADMONITION:
http://fedora.redhat.com/participate/documentation-guide/s1-xml-admon.html
Technische Begriffe markieren
Mit Backticks markieren Sie die Namen von Anwendungen, Dateien, Verzeichnissen, Softwarepaketen, Nutzer-Accounts und anderen Worten, die eine spezielle technische Bedeutung haben. Dadurch werden diese Worte in monospace
dargestellt.
Benutzen Sie zwei einzelne Anführungsstriche, um die Namen von Menüeinträgen und anderen Elementen der grafischen Oberfläche zu markieren. Diese Worte werden kursiv dargestellt
Begriff | Mark Up | Formatiert als | Formatiertes Beispiel |
Name von grafischen Anwendungen | bold face |
boldface | Firefox |
Dateien, Verzeichnisse | |
monospace font |
/usr/bin/firefox
|
Softwarepakete | |
monospace font |
firefox-1.2.3
|
Nutzer-Accounts | |
monospace font |
Nutzername
|
Andere Worte mit spezieller technischer Bedeutung | |
monospace font |
com.redhat.someJava.classname
|
Grafische Menüs und Menüeinträge | doppelter Rückstrich |
italic | Anwendungen > Internet > Firefox Web Browser |
Andere GUI oder Web'UI-Interfaceelemente | two single-ticks |
italic | ... klicken Sie auf die Schaltfläche übertragen ... |
Eingebettete Kommandos oder Dienste | |
monospace font |
grep httpd aus, um die PIDs laufender httpd Prozesse zu finden.
|
Eingebetteter Inhalt einer Konfigurationsdatei, Programmlisting u. ä. | |
monospace font |
... Danach ändern Sie die Einstellung DefaultIcon in /etc/httpd/conf/httpd.conf auf ...
|
Erster Begriff, Begriff im Glossar | two single-ticks |
italic | ... Firefox ist ein Beispiel einer grafischen Nutzeroberfläche (graphical user interface) oder GUI. |
Tastenbedienung | [Key] |
[bold brackets] | Drücken Sie die [Enter] -Taste ... |
Beispiel:
Das Paket <code>Thunderbird</code> installiert die E-Mail-Applikation '''Mozilla Thunderbird'''. Um '''Thunderbird''' zu starten, wählen Sie ''Anwendungen > Internet > Thunderbird Email''.
Das ergibt:
Das Paket Thunderbird
installiert die E-Mail-Applikation Mozilla Thunderbird. Um Thunderbird zu starten, wählen Sie Anwendungen > Internet > Thunderbird Email.
Beispiel-Kommandos schreiben
Beispiel-Kommandos sind ein oder mehrere Befehle, die von der Erklärung abgesetzt geschrieben werden. Schliessen Sie diese in drei geschweifte Klammern ein.
#!html <pre> {{{ su -c 'yum install awesome-application' }}} Enter the <code>root</code> password when prompted.
ergibt:
su -c 'yum install awesome-application'
Geben Sie das root
-Password ein, wenn danach gefragt wird.
Erstellen neuer Seiten im Wiki
Das Fedoraprojekt-Wiki ist so gross, dass eine ordentliche Hierarchie und Organisation sichergestellt werden muss. Am besten lesen Sie dazu SubPages und HelpOnCategories und sehen sich dann das Layout des Wiki an.
Sich wiederholende Namen (wie /Foo/FooBar/FooBarGrue
) sollten vermieden werden. Bereits 'Fedora' im Seitennamen ist redundant. Auch wichtige Projekte brauchen 'Project' nicht im Seitennamen zu enthalten. Beispielsweise heisst das Fedora-Websites-Projekt auch nur 'Websites', nicht 'FedoraWebsites
Project'.
Im Wesentlichen sollten Seiten Unterseiten der Projekte sein, zu denen sie gehören. Kategorien werden im allgemeinen für unterschiedliche Projekte und Programme gebildet und sollten sparsam verwendet werden. Die meisten der von Ihnen erzeugten Seiten sollten kategorisiert und mit den geeigneten Zeichen versehen sein. Wenn Sie das Erzeugen einer neuen Kategorie in Betracht ziehen, bitten Sie das Webseiten -Team vorher um Rat.
Fragen können Sie gern an das Webseiten -Team richten.
Wichtige Seiten
Schlüsselseiten, wie die Start-Seite , sollten nur selten geändert werden. Änderungen daran sollten generell vorab in den Mailinglisten oder im IRC diskutiert werden. Spezialseiten wie RecentChanges sollten grundsätzlich nicht verändert werden. Einige Teile des Wikis haben andere Berechtigungen. Zum Beispiel hat das DocsProject einen Bereich zum Erstellen neuer Dokumentationen, dessen Zugriff etwas mehr beschränkt ist als der Rest des Wikis. Wenn Sie Zugriff darauf erhalten wollen, müssen Sie zusätzliche Schritte durchführen. Die dazu notwendigen Instruktionen finden Sie üblicherweise auf diesen Seiten.
MoinMoin hat einige eingebaute Seiten, die für dessen korrekten Betrieb notwendig sind. Diese Seiten sind im Quellkode als solche gekennzeichnet und sollten in Ruhe gelassen werden. Änderungen daran werden grundsätzlich bei Aktualisierungen von MoinMoin zerstört.
Hilfe erhalten
Wann immer Sie Fragen zum Bearbeiten des Fedoraprojekt-Wikis haben oder anderweitig Hilfe brauche, kontaktieren Sie bitte das Webseiten -Team. Ihnen steht dazu der IRC-Kanal und die Mailingliste zur Verfügung, die beide sehr effektiv für die benötigten Antworten sind.
Wenn Sie viele Änderungen am Wiki vornehmen wollen, sollten Sie den Beitritt zum Webseiten -Team in Erwägung ziehen.