Difference between revisions of "Germany/Website HowTo"

From OWASP
Jump to: navigation, search
(Tabellenbeispiel)
m (→‎Aufbau)
 
(29 intermediate revisions by the same user not shown)
Line 1: Line 1:
  
−
Kleines HowTo zum Aufbau der wiki-Seiten fuer das OWASP German Chapter.
+
Kleines HowTo zum Aufbau der wiki-Seiten für das OWASP German Chapter.
  
 
== Struktur ==
 
== Struktur ==
Line 16: Line 16:
 
* German OWASP Day 2011
 
* German OWASP Day 2011
 
* German OWASP Day 2012
 
* German OWASP Day 2012
 +
* German OWASP Day 2014
 
{{TBD}}
 
{{TBD}}
  
Line 21: Line 22:
 
Ausnahmen von dieser Struktur sind i.W. alte Seiten. Sie werden nach und nach umgestellt oder es wird ein ''#REDIRECT''-Seite eingerichtet.
 
Ausnahmen von dieser Struktur sind i.W. alte Seiten. Sie werden nach und nach umgestellt oder es wird ein ''#REDIRECT''-Seite eingerichtet.
 
==== REDIRECTs ====
 
==== REDIRECTs ====
−
;02.11.2012:
+
Liste der eingerichteten Redirects:
−
* Germany/Stammtisch_Initiative --> OWASP_German_Chapter_Stammtisch_Initiative
+
 
 +
{| width="99%" class="wikitable" style="background-color:inherit;"
 +
|-
 +
! Datum !! alter Name !! neuer Name
 +
|-
 +
| 02.11.2012 || Germany/Stammtisch_Initiative || OWASP_German_Chapter_Stammtisch_Initiative
 +
|}
 +
 
 +
== Seite ==
 +
Generelle Informationen zur wiki-Syntax innerhalb der Seiten.
 +
;<nowiki>__NOTOC__</nowiki>: Die Seiten haben i.d.R. kein Inhaltsverzeichnis (erstes Keyword in der Seite)
 +
;<nowiki>[[Template:XXXX]]</nowiki>: optional, falls die Seite ein Template benutzt
 +
;<nowiki>== Überschrift ==</nowiki>: keine Überschrift mit nur einem <code>=</code> verwenden, macht manchmal Probleme
 +
;<nowiki>[[Germany|<top>]]</nowiki>: am Seitenende der Link zur Hauptseite (Germany)
 +
;<nowiki>[[Name-der-Elternseite|<zurück>]]</nowiki>: am Seitenende der Link zur Elternseite
 +
;<nowiki>[[Category:Germany]] ...</nowiki>: Kategorien angeben (am Seitenanfang oder Seitenende); Kategorien siehe [[#Kategorien]] unten
  
 
== Markup ==
 
== Markup ==
 
;Allgemein: In den Seiten soll kein HTML verwendet werden, sondern nur das mediawiki-spezifische Markup.
 
;Allgemein: In den Seiten soll kein HTML verwendet werden, sondern nur das mediawiki-spezifische Markup.
 
;Ausnahmen: Manchmal ist <code><nowiki><br></nowiki></code> erlaubt. Weiter sind bei den Tabellen <code>style="..."</code>-Angaben notwendig.
 
;Ausnahmen: Manchmal ist <code><nowiki><br></nowiki></code> erlaubt. Weiter sind bei den Tabellen <code>style="..."</code>-Angaben notwendig.
−
;Links: Links <code><nowiki>[[ ... ]]<nowiki></code> sollten in <code><nowiki><u>[[ ... ]]</nowiki></u></code> eingeschlossen werden, damit sie immer <u>[[unterstrichen]]</u> sind (leider sind einige Voreingestellungen der Styles unglücklich).
+
;Links: Links <code><nowiki>[[ ... ]]</nowiki></code> sollten in <code><nowiki><u>[[ ... ]]</nowiki></u></code> eingeschlossen werden, damit sie immer <u>[[unterstrichen]]</u> sind (leider sind einige Voreingestellungen der Styles unglücklich).
−
;Tabellen: Tebbelen werden benutzt um:
+
: Für Verweise zu anderen wiki-Seiten bitte nur lokale Pfade verwenden, z.B. <code><nowiki>[[Germany/Website_How]]</nowiki></code>.
−
# 2 Spalten für Mehrsprachige Inhalte zu erzeugen
+
;Tabellen: Tabellen werden benutzt um:
 +
# 2 Spalten für mehrsprachige Inhalte zu erzeugen
 
# bei Konferenzseiten für die Agenda
 
# bei Konferenzseiten für die Agenda
 
;Beispiel ''Sprach''-Tabelle:
 
;Beispiel ''Sprach''-Tabelle:
 
   <nowiki>{| width="100%" style="background-color:inherit;border-bottom:1px solid black;"
 
   <nowiki>{| width="100%" style="background-color:inherit;border-bottom:1px solid black;"
 
  | width="70%" style="vertical-align:top; padding-right:0.5em;" |
 
  | width="70%" style="vertical-align:top; padding-right:0.5em;" |
 +
==== eine Überschrift ====
 
  Zeile 1, Spalte 1
 
  Zeile 1, Spalte 1
  
 
  | width="30%" style="vertical-align:top; padding-left:0.5em;border-left:1px solid black;" |
 
  | width="30%" style="vertical-align:top; padding-left:0.5em;border-left:1px solid black;" |
 +
==== Headline ====
 
  Zeile 1, Spalte 2
 
  Zeile 1, Spalte 2
 
  ...
 
  ...
Line 48: Line 67:
 
: ab der 2ten Zeile keine <code>width=...</code> mehr angeben, erleichtert das Ändern.
 
: ab der 2ten Zeile keine <code>width=...</code> mehr angeben, erleichtert das Ändern.
 
: An einer einfacheren Lösung wird gearbeitet ...
 
: An einer einfacheren Lösung wird gearbeitet ...
 +
: Das sieht dann so aus:
 +
:
 +
----
 +
<!-- style=..." in folgender Tabelle entspricht nicht obigem Beispiel -->
 +
{| width="100%" style="background-color:rgb(203,254,255);margin:1em;margin-right:-2em;padding-left:1em;border-bottom:1px solid black;"
 +
| width="70%" style="vertical-align:top; padding-right:0.5em;" |
 +
==== eine Überschrift ====
 +
Zeile 1, Spalte 1
 +
| width="30%" style="vertical-align:top; padding-left:0.5em;border-left:1px solid black;" |
 +
==== Headline ====
 +
line 1, column 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;" |
 +
line n, column 2
 +
|}
  
−
;Sonstiges: Bitte auf Leerzeilen Verzichten, da diese einen neuen Absatz erzeugen.
+
 
 +
;Sonstiges: Bitte auf Leerzeilen verzichten, da diese einen neuen Absatz erzeugen. Umgekehrt: bitte Leerzeilen statt <code><nowiki><br></nowiki></code> verwenden, um einen Umbruch/Absatz zu erzwingen.
  
 
== Kategorien ==
 
== Kategorien ==
Line 61: Line 99:
  
 
Die Kategorie <code><nowiki>[[OWASP Chapter]]</nowiki></code> wird von mediawiki automatisch eingetragen.
 
Die Kategorie <code><nowiki>[[OWASP Chapter]]</nowiki></code> 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:
 +
<nowiki>
 +
 +
----
 +
[[Germany/Projekte|<top>]] [[Germany|<zurück>]] [[Germany|<Germany>]]</nowiki>
 +
sieht dann so aus:
 +
<div style="background-color:rgb(203,254,255);margin:1em;padding-left:1em;"><big style="padding:1em;">
 +
----
 +
[[Germany/Projekte|<top>]] [[Germany|<zurück>]] [[Germany|<Germany>]]
 +
</big></div>
  
 
== Bekannte Probleme ==
 
== Bekannte Probleme ==
−
;<nowiki><headertabs /></nowiki>: 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!'''
+
;<nowiki><headertabs /></nowiki>: Die Extension kann nicht mit Sonderzeichen in Überschriften umgehen (geht seit Q1/2014 teilweise) 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!'''
  
 
;<nowiki>__TOC__</nowiki>: Eigentlich sollte es möglich sein mit <code><nowiki>{{TOC limit}}</nowiki></code> die Verzeichnistiefe im Inhaltsverzeichnis einzustellen, das funktioniert nicht (Stand: 11/2012).
 
;<nowiki>__TOC__</nowiki>: Eigentlich sollte es möglich sein mit <code><nowiki>{{TOC limit}}</nowiki></code> die Verzeichnistiefe im Inhaltsverzeichnis einzustellen, das funktioniert nicht (Stand: 11/2012).
 +
 +
;<nowiki>[[Category:name-it]]</nowiki>: Zu Category-Seiten des mediawiki kann nicht mit dem üblichen Link, z.B. <code><nowiki>[[Category:Germany]]</nowiki></code> verlinked werden, da diese Syntax den Category-Eintrag erzeugt. Hier muss folgende Syntax verwendet werden <code><nowiki>[[:Category:Germany|Category:Germany]]</nowiki></code>
  
 
== Tipps ==
 
== 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.
 
;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: neue Seite die den Redirect auslösen soll anlegen, dort steht dann:
+
;REDIRECT-Seite einrichten: Neue Seite die den Redirect auslösen soll anlegen, dort steht dann:
 
   <nowiki>#REDIRECT [[pfad/alte/Seite]]</nowiki>
 
   <nowiki>#REDIRECT [[pfad/alte/Seite]]</nowiki>
 +
 +
;REDIRECT-Seite ändern: Neue Seite aufrufen, dann steht ganz oben unter der ersten (Seiten-)Überschrift z.B. <code>(Redirected from neue/Seite)</code>. Auf diesen Link klicken und dann die Seite editieren.

Latest revision as of 21:05, 14 April 2015

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
  • German OWASP Day 2014

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:

Datum alter Name neuer Name
02.11.2012 Germany/Stammtisch_Initiative OWASP_German_Chapter_Stammtisch_Initiative

Seite

Generelle Informationen zur wiki-Syntax innerhalb der Seiten.

__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 nur einem = verwenden, macht manchmal Probleme
[[Germany|<top>]]
am Seitenende der Link zur Hauptseite (Germany)
[[Name-der-Elternseite|<zurück>]]
am Seitenende der Link zur Elternseite
[[Category:Germany]] ...
Kategorien angeben (am Seitenanfang oder Seitenende); Kategorien siehe #Kategorien unten

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;" |
 ==== eine Überschrift ==== 
 Zeile 1, Spalte 1

 | width="30%" style="vertical-align:top; padding-left:0.5em;border-left:1px solid black;" |
 ==== Headline ====
 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 ...
Das sieht dann so aus:

eine Überschrift

Zeile 1, Spalte 1

Headline

line 1, column 2

Zeile n, Spalte 1

line n, column 2


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: 

 
 ----
 [[Germany/Projekte|<top>]] [[Germany|<zurück>]] [[Germany|<Germany>]]

sieht dann so aus:

<top> <zurück> <Germany>

Bekannte Probleme

<headertabs />
Die Extension kann nicht mit Sonderzeichen in Überschriften umgehen (geht seit Q1/2014 teilweise) 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 folgende Syntax verwendet werden [[: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.
Retrieved from "https://wiki.owasp.org/index.php?title=Germany/Website_HowTo&oldid=193377"