Hilfe:Inhaltsverzeichnis: Unterschied zwischen den Versionen
Aus Contao Community Documentation
| Zeile 1: | Zeile 1: | ||
{{stub}} | {{stub}} | ||
| − | + | =Verfassen von Artikeln= | |
| + | Vor dem Verfassen eines neuen Artikels sollte kontrolliert werden, ob schon ein Artikel zum gleichen Thema existiert. Dies kann über die Suchfunktion oder über die [[Spezial:Alle_Seiten|Auflistung aller existierender Seiten]] geprüft werden. Vor dem Abspeichern eines Artikels sollte man den Artikel mit der Vorschau-Funktion auf event. Rechtschreibfehler o.ä. prüfen. | ||
| − | + | '''Artikel sollten neutral und allgemein verfasst werden''' (als Beispiel nicht "''Ich betrachte die Seite''" oder "''Du betrachtest die Seite''", sondern "''Man betrachtet die Seite''"), um eine Vereinheitlichung der Artikel zu gewährleisten. | |
| + | ==Wichtig: Angabe der TYPOlight-Version== | ||
| + | Da sich TYPOlight ständig weiter entwickelt, ändert sich auch laufend der Quellcode. '''Daher ist es beim Verfassen von Artikeln wichtig, immer mit anzugeben, auf welche TYPOlight-Version sich der Artikel oder das Codebeispiel bezieht.''' Ein Besucher kann in einem Jahr nicht mehr nachvollziehen, auf welche TYPOlight-Version sich ein HowTo z.B. für ein modifiziertes Temlate bezieht. Durch die Angabe der Version ist er jedoch in der Lage, Änderungen an dem entsprechenden Template nachzuvollziehen und es bei Bedarf dementsprechend anzupassen. | ||
| + | ==Kategorisierung== | ||
| + | Ein Artikel kann in einer oder mehreren Kategorien abgelegt werden. Für jede Kategorie muss eine neue Zeile zu Beginn der Seite gemacht werden. | ||
| + | <pre> | ||
| + | [[Category:Admin HOWTOS]] | ||
| + | [[Category:Module]] | ||
| + | </pre> | ||
| + | Um einen in Arbeit oder unvollständigen Artikel also solchen zu kennzeichnen, wird der Eintrag | ||
| + | <pre>{{stub}}</pre> | ||
| + | an oberster Stelle, noch vor den Kategorien, eingefügt. Einem unvollständigen Artikel erkennnt man beim Betrachten am Hinweis: | ||
| − | + | [[Datei:unvollstaendiger_artikel.jpg|Unvollständiger Artikel]] | |
| − | + | Des weiteren ist der Artikel in der Liste der unvollständigen Artikel aufgeführt. | |
| + | =Formatierung= | ||
| + | ==Textformatierung== | ||
| + | Die wichtigsten Textformatierungen lauten: | ||
| − | + | '''Fettschrift''' | |
| + | <pre>'''Fettschrift'''</pre> | ||
| + | ''Schrägschrift'' | ||
| + | <pre>''Schrägschrift''</pre> | ||
| + | '''''Fett- und Schrägschrift''''' | ||
| + | <pre>'''''Fett- und Schrägschrift'''''</pre> | ||
| + | ==Auflistung== | ||
| + | Standardauflistung | ||
| + | <pre> | ||
| + | * foo | ||
| + | * bar | ||
| + | </pre> | ||
| + | ergibt | ||
| + | * foo | ||
| + | * bar | ||
| + | Nummerierte Auflistung | ||
| + | <pre> | ||
| + | # foo | ||
| + | # bar | ||
| + | </pre> | ||
| + | ergibt | ||
| + | # foo | ||
| + | # bar | ||
| + | ==Gruppierung== | ||
| + | Es ist möglich, einen Artikel in verschiedenen Gruppen und Untergruppen zu gliedern, um bei langen Artikeln die Übersicht zu behalten. | ||
| + | <pre> | ||
| + | =Hauptgruppe 1= | ||
| + | Text | ||
| + | ==Untergruppe 1.1== | ||
| + | Text | ||
| + | ==Untergruppe 1.2== | ||
| + | Text | ||
| + | =Hauptgruppe 2= | ||
| + | Text | ||
| + | ==Untergruppe 2.1== | ||
| + | Text | ||
| + | ==Untergruppe 2.2== | ||
| + | usw | ||
| + | </pre> | ||
| + | Bei mehr als 4 Gruppen wird automatisch ein Inhaltsverzeichnis am Anfang des Artikels angelegt. | ||
| + | =Verlinkung= | ||
| + | ==Textlinks== | ||
| + | Bei Textlinks unterscheidet man zwischen internen und externen Link. | ||
| − | http://www. | + | Interne Links (innerhalb des TYPOlight Info Portals) werden wie folgt verlinkt: |
| + | <pre>[[Seitenname|Beschreibung]]</pre> | ||
| + | Für externe Links verwendet man: | ||
| + | <pre>[http://www.example.com Beschreibung]</pre> | ||
| + | ==Bilderlinks== | ||
| + | Bevor man auf ein Bild verlinkt, muss man das Bild [[Spezial:Hochladen|hochladen]]. | ||
| + | Um das Bild in einen Artikel einzubinden, verwendet man folgende Codes: | ||
| + | |||
| + | Die einfachste Variante ist ein Bild mit Beschreibung. | ||
| + | <pre>[[Datei:foo.jpg|Bechreibung]]</pre> | ||
| + | Des weiteren kann man Bilder auch auf andere Seiten verlinken. | ||
| + | |||
| + | Interne Links: | ||
| + | <pre>[[Datei:foo.jpg|link=Hauptseite|Beschreibung]]</pre> | ||
| + | Externe Links: | ||
| + | <pre>[[Datei:foo.jpg|link=http://www.example.com|Beschreibung]]</pre> | ||
| + | |||
| + | ---- | ||
| + | Bei Code- und Templatebeispielen TL-Version mit angeben! | ||
Version vom 7. März 2010, 15:19 Uhr
 |
Unvollständiger Artikel: dieser Artikel ist noch nicht sauber bearbeitet.
Bitte erweitere ihn und entferne erst anschliessend diesen Hinweis. |
Inhaltsverzeichnis
Verfassen von Artikeln
Vor dem Verfassen eines neuen Artikels sollte kontrolliert werden, ob schon ein Artikel zum gleichen Thema existiert. Dies kann über die Suchfunktion oder über die Auflistung aller existierender Seiten geprüft werden. Vor dem Abspeichern eines Artikels sollte man den Artikel mit der Vorschau-Funktion auf event. Rechtschreibfehler o.ä. prüfen.
Artikel sollten neutral und allgemein verfasst werden (als Beispiel nicht "Ich betrachte die Seite" oder "Du betrachtest die Seite", sondern "Man betrachtet die Seite"), um eine Vereinheitlichung der Artikel zu gewährleisten.
Wichtig: Angabe der TYPOlight-Version
Da sich TYPOlight ständig weiter entwickelt, ändert sich auch laufend der Quellcode. Daher ist es beim Verfassen von Artikeln wichtig, immer mit anzugeben, auf welche TYPOlight-Version sich der Artikel oder das Codebeispiel bezieht. Ein Besucher kann in einem Jahr nicht mehr nachvollziehen, auf welche TYPOlight-Version sich ein HowTo z.B. für ein modifiziertes Temlate bezieht. Durch die Angabe der Version ist er jedoch in der Lage, Änderungen an dem entsprechenden Template nachzuvollziehen und es bei Bedarf dementsprechend anzupassen.
Kategorisierung
Ein Artikel kann in einer oder mehreren Kategorien abgelegt werden. Für jede Kategorie muss eine neue Zeile zu Beginn der Seite gemacht werden.
[[Category:Admin HOWTOS]] [[Category:Module]]
Um einen in Arbeit oder unvollständigen Artikel also solchen zu kennzeichnen, wird der Eintrag
{{stub}}
an oberster Stelle, noch vor den Kategorien, eingefügt. Einem unvollständigen Artikel erkennnt man beim Betrachten am Hinweis:
Des weiteren ist der Artikel in der Liste der unvollständigen Artikel aufgeführt.
Formatierung
Textformatierung
Die wichtigsten Textformatierungen lauten:
Fettschrift
'''Fettschrift'''
Schrägschrift
''Schrägschrift''
Fett- und Schrägschrift
'''''Fett- und Schrägschrift'''''
Auflistung
Standardauflistung
* foo * bar
ergibt
- foo
- bar
Nummerierte Auflistung
# foo # bar
ergibt
- foo
- bar
Gruppierung
Es ist möglich, einen Artikel in verschiedenen Gruppen und Untergruppen zu gliedern, um bei langen Artikeln die Übersicht zu behalten.
=Hauptgruppe 1= Text ==Untergruppe 1.1== Text ==Untergruppe 1.2== Text =Hauptgruppe 2= Text ==Untergruppe 2.1== Text ==Untergruppe 2.2== usw
Bei mehr als 4 Gruppen wird automatisch ein Inhaltsverzeichnis am Anfang des Artikels angelegt.
Verlinkung
Textlinks
Bei Textlinks unterscheidet man zwischen internen und externen Link.
Interne Links (innerhalb des TYPOlight Info Portals) werden wie folgt verlinkt:
[[Seitenname|Beschreibung]]
Für externe Links verwendet man:
[http://www.example.com Beschreibung]
Bilderlinks
Bevor man auf ein Bild verlinkt, muss man das Bild hochladen. Um das Bild in einen Artikel einzubinden, verwendet man folgende Codes:
Die einfachste Variante ist ein Bild mit Beschreibung.
[[Datei:foo.jpg|Bechreibung]]
Des weiteren kann man Bilder auch auf andere Seiten verlinken.
Interne Links:
[[Datei:foo.jpg|link=Hauptseite|Beschreibung]]
Externe Links:
[[Datei:foo.jpg|link=http://www.example.com|Beschreibung]]
Bei Code- und Templatebeispielen TL-Version mit angeben!
