Difference between revisions of "Germany/Website HowTo"

Revision as of 11:01, 29 March 2013

Kleines HowTo zum Aufbau der wiki-Seiten für das OWASP German Chapter.

Struktur

Intro

Aufgrund immer häufiger auftretender Probleme mit Extensions/Plugins für mediawiki, wurde 2011 beschlossen die Seiten des German Chapter nach einer (klassischen) Verzeichnisstruktur aufzubauen. Insbeondere sollen alle vom German Chapter gepflegten Seiten dem Pfad Germany/andere-Seiten folgen (Ausnahmen siehe unten).

Aufbau

Stand 03.11.2012

• Germany/
  • Germany/Aktuelles
  • Germany/Konferenzen
  • Germany/Projekte
  • Germany/Chapter Meetings
  • Germany/Stammtisch_Initiative
  • Germany/press
• German OWASP Day 2011
• German OWASP Day 2012

Template:TBD

Ausnahmen

Ausnahmen von dieser Struktur sind i.W. alte Seiten. Sie werden nach und nach umgestellt oder es wird ein #REDIRECT-Seite eingerichtet.

REDIRECTs

Liste der eingerichteten Redirects:

Seite

__NOTOC__

Die Seiten haben i.d.R. kein Inhaltsverzeichnis (erstes Keyword in der Seite)

[[Template:XXXX]]

optional, falls die Seite ein Template benutzt

== Überschrift ==

keine Überschrift mit einem = verwenden, macht manchmal Probleme

[[Germany|<top>]]

am Seitenende der Link zur Hauptseite

[[Category:Germany]] ...

Kategorien angeben (am Seitenanfang oder Seitenende)

Markup

Allgemein

In den Seiten soll kein HTML verwendet werden, sondern nur das mediawiki-spezifische Markup.

Ausnahmen

Manchmal ist <br> erlaubt. Weiter sind bei den Tabellen style="..."-Angaben notwendig.

Links

Links [[ ... ]] sollten in <u>[[ ... ]]</u> eingeschlossen werden, damit sie immer unterstrichen sind (leider sind einige Voreingestellungen der Styles unglücklich).

Für Verweise zu anderen wiki-Seiten bitte nur lokale Pfade verwenden, z.B. [[Germany/Website_How]].

Tabellen

Tabellen werden benutzt um:

1. 2 Spalten für mehrsprachige Inhalte zu erzeugen
2. bei Konferenzseiten für die Agenda

Beispiel Sprach-Tabelle

 {| width="100%" style="background-color:inherit;border-bottom:1px solid black;"
 | width="70%" style="vertical-align:top; padding-right:0.5em;" |
 Zeile 1, Spalte 1

 | width="30%" style="vertical-align:top; padding-left:0.5em;border-left:1px solid black;" |
 Zeile 1, Spalte 2
 ...
 |-
 | style="vertical-align:top; padding-right:0.5em;" |
 Zeile n, Spalte 1

 | style="vertical-align:top; padding-left:0.5em;border-left:1px solid black;" |
 Zeile n, Spalte 2
 |}

ab der 2ten Zeile keine width=... mehr angeben, erleichtert das Ändern.

An einer einfacheren Lösung wird gearbeitet ...

Sonstiges

Bitte auf Leerzeilen verzichten, da diese einen neuen Absatz erzeugen. Umgekehrt: bitte Leerzeilen statt <br> verwenden, um einen Umbruch/Absatz zu erzwingen.

Kategorien

Folgende Katgorien des OWASP mediawiki werden verwendet. Bitte bei neuen Seiten entsprechend eintragen.

• [[Category:Germany]]
• [[Category:German OWASP Day]]
• [[Category:Europe]]
• [[Category:OWASP_AppSec_Conference]]
• [[Category:OWASP Project]]
• [[Category:Download]]

Die Kategorie [[OWASP Chapter]] wird von mediawiki automatisch eingetragen.

Back Links

Am Ende jeder Seite Links zur Startseite einrichten. Der Text steht in <spitzen Klammen>. Damit eine kleiner Abstand entsteht, 2 Leerzeilen einfügen, dann eine Trennlinies. Beispiel: <code> ---- [[Germany/Website_HowTo|<top>]] [[Germany|<Germany>]] </code> sieht dann so aus

Bekannte Probleme

<headertabs />

Die Extension kann nicht mit Sonderzeichen in Überschriften umgehen und sie überlagert die CSS-Einstellungen für Überschriften (die dann alle kleiner werden). Ausserdem ist zur Funktion JavaScript nötig und es funktioniert nicht in allen Browsern. Nicht verwenden!

__TOC__

Eigentlich sollte es möglich sein mit {{TOC limit}} die Verzeichnistiefe im Inhaltsverzeichnis einzustellen, das funktioniert nicht (Stand: 11/2012).

[[Category:name-it]]

Zu Category-Seiten des mediawiki kann nicht mit dem üblichen Link, z.B. [[Category:Germany]] verlinked werden, da diese Syntax den Category-Eintrag erzeugt. Hier muss datsächlich die volle URL stehen, z.B. [//www.owasp.org/index.php/Category:Germany Category:Germany]

Tipps

Umbenennen

Um eine Seite umzubenennen gibt es nach Aufruf der Seite, oben rechts neben dem Edit-Button ein Pulldown mit Move, dort einfach den neuen Seitennamen eintragen, fertig.

REDIRECT-Seite einrichten

Neue Seite die den Redirect auslösen soll anlegen, dort steht dann:

 #REDIRECT [[pfad/alte/Seite]]

REDIRECT-Seite ändern

Neue Seite aufrufen, dann steht ganz oben unter der ersten (Seiten-)Überschrift z.B. (Redirected from neue/Seite). Auf diesen Link klicken und dann die Seite editieren.