Übersetzung optimiert und Verbesserungen
This commit is contained in:
ralf-bonn
@@ -0,0 +1,170 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||||
<html><head>
|
||||
<title>Leitfaden für Moodle-Übersetzungen</title>
|
||||
<link rel="stylesheet" href="docstyles.css" type="TEXT/CSS">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
||||
</head>
|
||||
|
||||
<body style="background-color: rgb(255, 255, 255);">
|
||||
|
||||
<h1>Leitfaden für Moodle-Übersetzungen</h1>
|
||||
|
||||
<p>Moodle zu übersetzen ist nicht schwierig. Es gibt aber einige Dinge, die Sie zu Beginn wissen sollten.</p>
|
||||
|
||||
<p> </p>
|
||||
|
||||
<h2>Struktur des Moodle Sprachpakets</h2>
|
||||
|
||||
<p style="margin-left: 40px;">Alle Moodle Sprachpakete liegen im lang-Verzeichnis. Jede
|
||||
Sprache verfügt über ein eigenes Unterverzeichnis mit einem Kurznamen der Sprache
|
||||
(en, fr, nl, es ...). </p>
|
||||
|
||||
<p style="margin-left: 40px;">Die wichtigsten Dateien in diesem Ordner haben .php-Endungen
|
||||
(z.B. moodle.php, resource.php etc).
|
||||
Diese Dateien enthalten kurze Aussagen, häufig als "<span style="font-style: italic;">strings</span>"
|
||||
bezeichnet. Sie werden auf der Oberfläche von moodle angezeigt.
|
||||
</p>
|
||||
|
||||
<p style="margin-left: 40px;">Die weiteren Ordner enthalten .html Webseiten:
|
||||
</p>
|
||||
<ul style="margin-left: 40px;">
|
||||
<li><strong>help</strong>: enthalten situationsabhängige Hilfedateien, die mit den Hilfe-Buttons in
|
||||
moodle aufgerufen werden
|
||||
</li><li><strong>docs</strong>: enthalten die wichtigsten Dokumentationsseiten (wie diese Seite)<br>
|
||||
</li>
|
||||
</ul>
|
||||
<p> </p>
|
||||
|
||||
<h2>So erstellen Sie ein völlig neues Sprachpaket für moodle</h2>
|
||||
<p style="margin-left: 40px;">Wenn Ihre Sprache von moodle noch nicht unterstützt
|
||||
wird oder wenn Sie einige spezifische Anpassungen für Ihre Seite an einem bestehenden
|
||||
Sprachpaket vornehmen wollen, können Sie einen neue Überstzung beginnen. </p>
|
||||
|
||||
<p style="margin-left: 40px;">Erstellen Sie im lang-Verzeichnis einen neuen Ordner
|
||||
(verwenden Sie einen zwei-Buchstaben-Code für die Sprache als Verzeichnisnamen).
|
||||
Die Standardcodes der Namen finden Sie in der Datei
|
||||
lib/languages.php. Wenn Sie eine lokale Variation einer bestehenden Sprache erstellen,
|
||||
verwenden Sie den bestehenden Namenscode der Basissprache und ergänzen Sie mit einem Unterstrich die lokale Version
|
||||
(z.B. <span style="font-style: italic;">pt </span>für Portugiesisch und
|
||||
<span style="font-style: italic;">pt_br</span> für die brasilianische Modifikation).
|
||||
Wenn Sie eine Unicode Version erstellen fügen Sie <span style="font-weight: bold;">_utf8</span>
|
||||
am Ende hinzu (z.B. <span style="font-style: italic;">sr_utf8</span>).<br></p>
|
||||
|
||||
<p style="margin-left: 40px;">Als nächstes kopieren Sie die Datei moodle.php aus einem anderen
|
||||
Sprachverzeichnis in Ihr neues Sprachverzeichnis
|
||||
. Meist ist die Datei aus dem Verzeichnis "en" gut geeignet. Für die Bearbeitung des de_du
|
||||
Paketes kann jedoch besser noch die deutsche Basisversion genutzt werden.
|
||||
<br>
|
||||
</p>
|
||||
<p style="margin-left: 40px;">Sie haben nun alles vorbereitet, um neue Ausdrücke in Ihrer Sprache in moodle hinzuzufügen.</p>
|
||||
|
||||
<p style="margin-left: 40px;">Wenn Sie eine komplett neue Sprache in moodle anlegen, müssen Sie zuerst
|
||||
den String "thischarset" in der Datei moodle.php bearbeiten.
|
||||
Hier müssen Sie einen gültigen Zeichensatz für Ihre Sprache definieren. Speichern Sie danach die Datei moodle.php ab.
|
||||
und <span style="font-weight: bold;">laden Sie die Datei neu</span>. Nun können Sie mit den weiteren Ausdrücken fortsetzen. </p>
|
||||
|
||||
<p> </p>
|
||||
<h2>So bearbeiten Sie ein bestehendes Sprachpaket</h2>
|
||||
|
||||
<h3 style="margin-left: 40px;">Einige kleinere Anpassungen<br>
|
||||
</h3>
|
||||
|
||||
<p style="margin-left: 80px;">Wenn Sie nur einige Anpassungen für Ihr moodle machen wollen
|
||||
(z.B. Anpassung an den Sprachgebrauch Ihrer Organisation)
|
||||
<span style="font-weight: bold;">sollten sie nicht ein bestehendes Sprachpaket überarbeiten.</span>.
|
||||
Beim nächsten upgrade von moodle würden Sie alle Änderungen wieder überschreiben.<br>
|
||||
</p>
|
||||
<p style="margin-left: 80px;">Erstellen Sie statt dessen ein neues Verzeichnis, wie oben beschrieben.
|
||||
Stellen Sie als Basissprache (in
|
||||
moodle.php) eine Sprache, auf die Sie sich beziehen wollen, ein. Zum Beispiel
|
||||
könnte ein guter Name für eine lokale englsiche Version "<span style="font-style: italic;">en_local</span>" sein,
|
||||
de Basissprache könnte sein "<span style="font-style: italic;">en</span>" oder "<span style="font-style: italic;">en_us</span>".</p>
|
||||
<p style="margin-left: 80px;">Damit jeder auf Ihrer Seite auf Ihre Sprachversion zugreift stellen Sie diese
|
||||
Sprache als Seitensprache ein beschränken Sie die verfügbaren Sprachen für Ihre Seite
|
||||
auf <span style="font-weight: bold;">Admin >> Konfigurationn >> Variablen</span>.<br>
|
||||
<br>
|
||||
</p>
|
||||
|
||||
<h3 style="margin-left: 40px;">So übersetzen Sie die Texte auf der moodle Oberfläche ("string" Dateien)<br>
|
||||
</h3>
|
||||
<ol>
|
||||
<ol>
|
||||
<li>Melden Sie sich in Ihrem moodle als Administrator an. </li>
|
||||
<li>Gehehn Sie zu <span style="font-weight: bold;">Administration >> Konfiguration >> Sprcahe</span>, zur Sprachadministrationsseite. </li>
|
||||
<li>Wählen Sie Ihre Sprache aus dem Menu aus, und klicken Sie auf "Sprache vergleichen und bearbeiten".</li>
|
||||
<li>Nun sollten Sie ein Formular mit allen Ausdrücken für die verschiedenen php-Dateien sehen.
|
||||
Wennn Sie die Dateien nicht sehen können, müssen Sie prüfen, ob Sie in den Verzeichnissen Schreibzugriff haben und ggfs. die Zugriffsrechte anpassen.
|
||||
the</li>
|
||||
<li>Das Formular verfügt über drei Spalten, die erste zeigt den Namen des Ausdrucks,
|
||||
die zweite den Ausdruck auf Englisch und zuletzt die Übersetzung in die gewählte Sprache. </li>
|
||||
<li>Bearbeiten Sie die fehlenden Ausdrücke in jeder Datei (farblich herborgehoben)
|
||||
und denken Sie an das Abspeichern jeder einzelnen Datei am Ende der Datei.</li>
|
||||
<li>Wenn Sie Ausdrücke leer lassen - verwendet Moodle einfach den englischen Ausdruck weiter.
|
||||
Die Ursprungsprache kann in
|
||||
moodle.php gewählt werden, andernfalls wird immer Englisch verwandt. </li>
|
||||
<li>Eine schnelle Möglichkeit, sich einen Überblick über fehlende Ausdrücke und Dateien zu verschaffen ist die Option "Auf fehlende Textpassagen prüfen".<br>
|
||||
<br>
|
||||
</li>
|
||||
|
||||
|
||||
</ol>
|
||||
</ol>
|
||||
|
||||
<h3 style="margin-left: 40px;">Übersetzung der Hilfedateien und der Dokumentation</h3>
|
||||
|
||||
<p style="margin-left: 80px;">moodle verfügt nicht über einen eintegrierten Editor zur Übersetzung der Hilfedateien. Dennoch ist es sehr einfach. Nutzen Sie auf jeden Fall das
|
||||
<span style="font-weight: bold;">en</span> Sprachpaket als Referenz für Ihre Übersetzung. Kopieren Sie die Hilfedatei(en) aus dem
|
||||
en Sprachverzeichnis an die gleiche Stelle für Ihre Sprache. Nutzen Sie einen Editor für einfachen Text oder einen HTML-Editor um die Datei zu übersetzen.
|
||||
Achten Sie darauf, dass Sie keinen Code (meist nur HTML-Codierungen) verändern.(VERWENDEN SIE IN KEINEM FALL EIN TEXTVERARBEITUNGSPROGRAMM, zur Bearbeitung der Hilfedateien, da sie zusätzliche Textinformationen einfügen</p>
|
||||
|
||||
|
||||
<p style="margin-left: 80px;">Klicken Sie auf "Auf fehlende Textpassagen prüfen/Check for missing strings"
|
||||
in der Sprachadministration Ihres moodles. Sie erhalten eine Übersicht über fehlende Dateien in Ihrer Sprachversion.
|
||||
So lange Sie nicht alle Dateien übersetzt haben, ruft moodle automatisch die vorhandenen englischen Sprachdateien im en-Verzeichnis auf.
|
||||
Es ist also nicht erforderlich, alle Dateien vor der Übersetzung in Ihr Sprachverzeichnis zu kopieren.</p>
|
||||
|
||||
|
||||
<p> </p>
|
||||
|
||||
|
||||
<h2>Unterstützen Sie mit Ihrem Sprachpaket das moodle Projekt</h2>
|
||||
|
||||
|
||||
<p style="margin-left: 40px;">Wenn Sie Ihre Übersetzung zur Verfügung stellen, helfen Sie anderen Nutzern in Ihrer Sprache weiter.
|
||||
|
||||
Ihre Sprachversion wird in künftigen moodle-Versionen eingebaut.<br>
|
||||
</p>
|
||||
|
||||
|
||||
<p style="margin-left: 40px;">Speichern Sie das gesamte Sprachpaket für die neue Sprache als gepackte <span style="font-weight: bold;">zip</span> Datei ab und schicken es per E-Mail an <a href="mailto:tra%6es%6ca%74%69o%6e%40%6d%6f%6f%64%6c%65.org">translation@moodle.org</a>.<br>
|
||||
</p>
|
||||
<p style="margin-left: 40px;">Wir nehmen mit Ihnen Kontakt auf, um Details zu besprechen.<br>
|
||||
</p>
|
||||
|
||||
|
||||
<p> </p>
|
||||
|
||||
|
||||
<h2>Pflege des Sprachpaketes<br>
|
||||
</h2>
|
||||
|
||||
|
||||
|
||||
<p style="margin-left: 40px;">Wenn Sie eine Sprachversion von moodle bearbeiten ist es am besten das <a href="?file=cvs.html">Moodle CVS</a>
|
||||
zu verwenden. Damit können Sie immer auf die aktuellste Version zurückgreifen und Ihre Ergänzungen und Änderungen direkt dem moodle Projekt zur Verfügung stellen..
|
||||
Kontakten Sie bitte <a href="mailto:tra%6es%6ca%74%69o%6e%40%6d%6f%6f%64%6c%65.org">translation@moodle.org</a> wenn Sie Hilfe benötigen.</br />
|
||||
</p>
|
||||
|
||||
<p style="margin-left: 40px;">Tragen Sie sich bitte unbedingt im <a target="_top" href="http://moodle.org/mod/forum/view.php?id=43">Languages Forum</a> ein, um sich über Neuigkeiten zu informieren, die die Sprachpakete betreffen.<br \>
|
||||
</p>
|
||||
|
||||
<p style="margin-left: 40px;">Wenn Sie sich über die laufenden Änderungen und Neuerungen täglich informieren wollen, tragen Sie sich bitte auf der
|
||||
<a href="http://sourceforge.net/mail/?group_id=30935" target="_top">CVS mailing list</a> ein. Damit stellen Sie sicher, dass Ihre Übersetzung mit dem englischsprachigen Original übereinstimmt.<br>
|
||||
</p>
|
||||
<p style="margin-left: 40px;"><br>
|
||||
</p>
|
||||
|
||||
<p align="CENTER"><font size="1"><a href="." target="_top">Moodle Dokumentation</a></font></p>
|
||||
<p align="CENTER"><font size="1">Version: $Id$</font></p>
|
||||
|
||||
</body></html>
|
||||
@@ -0,0 +1,7 @@
|
||||
<p align="center"><b>Automatische Aufzeichnung der Logins zurA nwesenheitskontrolle</b></p>
|
||||
|
||||
<p>Die Anwesenheitsübersicht wird mit dieser Einstellung automatisch aktualisiert auf der Basis der Aktivitäten jedes Nutzers an jedem Tag. </p>
|
||||
|
||||
<p>Ein/e Teilnehmer/in wird als anwesend registriert, wenn sie/er sich an einem Tag einloggt und eine Aktivität nutzt.</p>
|
||||
|
||||
<p>Die moodle cron Option muss für diese Funktion eingerichtet sein.</p>
|
||||
@@ -0,0 +1,4 @@
|
||||
<p align="center"><b>Wochentage an denen die Anwesenheit festgestellt wird.</b></p>
|
||||
|
||||
<p>Wenn Sie unterschiedliche Anwesenheitsrollen hinzufügen, wird für jeden Tag eine Rolle angelegt und in der Liste geprüft. Wenn Sie z.B. die Anwesenheit am Dienstag und Donnerstag prüfen wollen, wird auch nur an diesen beiden Tagen die Anwesenheit registriet und geprüft.</p>
|
||||
|
||||
@@ -0,0 +1,5 @@
|
||||
<p align="center"><b>Festlegung der Bereiche der Anwesenheitskontrolle an diesem Datum.</b></p>
|
||||
|
||||
<p>Diese Einstellung bezieht sich auf die von Ihnen ausgewählte Woche.</p>
|
||||
|
||||
<p>Diese Option steht nur für Kurse im wöchentlichen Format zur Verfügung.</p>
|
||||
@@ -0,0 +1,5 @@
|
||||
<p align="center"><b>Bewertung der Anwesenheit.</b></p>
|
||||
|
||||
<p>Diese Einstellung ermöglicht die Bewertung der Anwesenheit einer linearen Skala. Der Prozentwert der Stunden, den ein/e Teinehmer/in in einem Kurs anwesend ist, wird in eine Bewertung umgerechnet. Verspätungen werden in der Berechnung auf der Basis der Einstellungen "Zahl der Verspätungen zu Abwesenheit" berücksichtigt.</p>
|
||||
|
||||
<p>Diese Option arbeitet nicht sehr zuverlässig wenn die automatische Anwesenheitskontrolle aktiviert ist, da ein/e Teilnehmer/in nicht teilweise anwesend an einem Tag sein kann. Ein/e Teilnehmner/in ist 100 % anwesend oder 100 % abwesend in der Registration durch die automatische Kontrolle.</p>
|
||||
@@ -0,0 +1,5 @@
|
||||
<p align="center"><b>Zahl der Stunden für eine Lernperiode</b></p>
|
||||
|
||||
<p>Legt die Zahl der Soll-Stunden in der Unterrichtsperiode fest. Die Anwesenheit wird für jede Stunde in derein/e Teilnehmer/in eingeloggt ist, festgelegt. Es werden nur ganze Stunden verarbeitet.</p>
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
<p>Anwesenheit</p>
|
||||
|
||||
<ul>
|
||||
<li><a href="help.php?module=attendance&file=autoattend.html">Automatische Aufzeichnung der Logins zur Anwesenheitskontrolle</a>
|
||||
<li><a href="help.php?module=attendance&file=choosedays.html">Wochentage an denen die Anwesenheit festgestellt wird</a>
|
||||
<li><a href="help.php?module=attendance&file=dynsection.html">Wochentage an denen die Anwesenheit festgestellt wird</a> <li><a href="help.php?module=attendance&file=grade.html">Bewertung der Anwesenheit</a> <li><a href="help.php?module=attendance&file=hours.html">Zahl der Stunden für eine Lernperiode</a>
|
||||
<li><a href="help.php?module=attendance&file=maxgrade.html">Höchstbewertung für Anwesenheit</a>
|
||||
</ul>
|
||||
@@ -0,0 +1,4 @@
|
||||
<p align="center"><b>Höchstbewertung für Anwesenheit</b></p>
|
||||
|
||||
<p>Dieser Wert legt die maximal Bewertung für vollständige Anwesenheit fest. Die Bewertung erfolgt linear. Der Wert '0' steht für vollständiges Fehlen.</p>
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
<p ALIGN=CENTER><b>Frequently Asked Questions über Bücher</b></p>
|
||||
|
||||
<dl>
|
||||
<dt><b>Warum hat Buch nur zwei Ebenen?</b></dt>
|
||||
<dd>Zwei Ebenen (Kapitel und Unterkapitel) sind für Bücherim Normalfall ausreichend. Das Buch-Modul ist gedacht für kurze mehrseitige Lerntexte und Dokumente. Längere Dokumente können besser als PDF-Dokumente bereitgestellt werden. PDF-Dokumente können einfach mit virtuellen Druckern erstellt werden, z.B. <a
|
||||
href="http://sector7g.wurzel6.de/pdfcreator/index_en.htm"
|
||||
target="_blank">PDFCreator</a>, <a
|
||||
href="http://fineprint.com/products/pdffactory/index.html"
|
||||
target="_blank">PDF
|
||||
Factory</a>, <a
|
||||
href="http://www.adobe.com/products/acrobatstd/main.html"
|
||||
target="_blank">Adobe Acrobat</a>,
|
||||
etc.).<br />
|
||||
</dd><br />
|
||||
<dt><b>Können Teilnehmer/innen Bücher bearbeiten?</b></dt>
|
||||
<dd>Nur Trainer/innen können Bücher bearbeiten. Es gibt kein Planung, diese Modul auch für die Texterstellung durch Teilnehmer/innen weiter zu entwickeln. Statt dessen kann das Wiki-Modul genutzt werden. DerHauptgrund für diese Beschränkung ist, dass dieses Modul sehr einfach gehalten werden soll.</dd><br />
|
||||
<dt><b>Wie kann ich Bücher durchsuchen?</b></dt>
|
||||
<dd>Zur Zeit besteht nur die Möglichkeit, mit der Suchfunktion des Browsers den Text zu durchsuchen. </dd><br />
|
||||
<dt><b>Meine Überschriften stehen nicht in einer Zeile.</b></dt>
|
||||
<dd>Formulieren Sie die Überschrift neu oderbitten Sie den Admin, die TOC Breite in der Modulkonfiguration anzupassen. Diese Einstellung gilt für alle auf de Seite genutzten Bücher.</dd><br />
|
||||
</dl>
|
||||
@@ -0,0 +1,6 @@
|
||||
<p>Book module</p>
|
||||
<ul>
|
||||
<li><a href="help.php?module=book&file=numberingtype.html">Kapitel nummerieren</a>
|
||||
<li><a href="help.php?module=book&file=summary.html">Zusammenfassung</a>
|
||||
<li><a href="help.php?module=book&file=faq.html">Book FAQ</a>
|
||||
</ul>
|
||||
@@ -0,0 +1,4 @@
|
||||
<p><img VALIGN=absmiddle SRC="<?php echo $CFG->wwwroot?>/mod/book/icon.gif"> <b>Bücher</b></p>
|
||||
<ul>
|
||||
<p>Buch ist ein einfaches Darstellungsprinzip für Unterrichtsmaterial in buchähnlicher Form.</p>
|
||||
</ul>
|
||||
@@ -0,0 +1,12 @@
|
||||
<p ALIGN=CENTER><b>Nummerierung der Kapitel</b></p>
|
||||
|
||||
<p>Kapitel können in unterschiedlicher Weise nummeriert werden:
|
||||
|
||||
<p><b>Keine</b> - Kapitel und Unterkapitel erhalten keine automatische Nummerierung der Überschriften. Tragen Sie in diesem Fall die Nummerierung selber in den Text der Überschrift ein, z.B. "A Erstes Kapitel", "A.1 Ein Unterkapitel",...</p>
|
||||
|
||||
<p><b>Nummerierung/b> - Kapitel und Unterkapitel werden durchnummeriert (1, 1.1, 1.2, 2,
|
||||
...)<p>
|
||||
|
||||
<p><b>Aufzählungspunkte</b> - Unterkapitel werden eingerückt und mit Aufzählungspunkten angezeigt.<p>
|
||||
|
||||
<p><b>Einrückung</b> - Unterkapitel werden eingerückt.</p>
|
||||
@@ -0,0 +1,5 @@
|
||||
<p ALIGN=CENTER><b>Zusammenfassung</b></p>
|
||||
|
||||
<p>Die Zusammenfassung ist eine sehr kurze Beschreibung und Zusammenfassung des Buches.
|
||||
|
||||
<p>Fassen Sie sich wirklich kurz.
|
||||
@@ -0,0 +1,7 @@
|
||||
<p align="center"><b>Zeitbeschränkung</b></p>
|
||||
|
||||
<P>Die Einstellung erlaubt die Festlegung eines Zeitfenster in dem Teilnehmer/innen sich an einer Abstimmung beteiligen können.</p>
|
||||
|
||||
<p>Um eine Abstimmung ohne Zeitbegrenzung einzurichten , wählen Sie einen Schlußzeitpunkt, die in weiter Ferne liegt.</p>
|
||||
|
||||
<p>Wenn Sie all das nicht nutzen wollen, deaktivieren Sie die Funktion.</p>
|
||||
@@ -0,0 +1,7 @@
|
||||
<p align="center"><b>Verborgene Bereiche im Kurs</b></p>
|
||||
|
||||
<P>Diese Option legt fest wie verborgene Bereiche für die Teilnehmer/innen abgeildet werden.</p>
|
||||
|
||||
<p>In der Grundeinstellung werden sie als schmaler Bereich (meist grau) gezeigt, um die verborgenen Bereiche anzudeuten. Die Texte sind nicht erkennbar. Diese Einstellung ist sinnvoll, um z.B. im wöchentlichen Format von Kursen Wochen eindeutig zu kennzeichnen, in denen kein Untericht (= keine Einträge) statt findet.</p>
|
||||
|
||||
<p>Mit der Auswahl können Sie verborgene Einträge vollständig unsichtbar machen. Teilnehmer/innen können dann nicht erkennnen, dass Bereiche verborgen wurden.</p>
|
||||
@@ -0,0 +1,3 @@
|
||||
<P ALIGN=CENTER><B>Kurs ID Nummer</B></P>
|
||||
|
||||
<P>Die ID Nummer eines Kurses wird lediglich zum Abgleich von Kursdaten durch externe Datenbanken benötigt. In moodle wird die Nummer nicht benötigt und auch nicht weiter angezeigt. Wenn Sie eine offizielle Kursnummer haben, können sie diese hier eintragen. Lassen Sie das Feld sonst leer.</p>
|
||||
@@ -0,0 +1,10 @@
|
||||
<p>Dialoge</p>
|
||||
<ul>
|
||||
<li><a href="help.php?module=dialogue&file=addsubject.html">Themen zu Dialogen hinzufügen</a>
|
||||
<li><a href="help.php?module=dialogue&file=closedialogue.html">Dialoge schließen</a>
|
||||
<li><a href="help.php?module=dialogue&file=deleteafter.html">Dialoge löschen</a>
|
||||
<li><a href="help.php?module=dialogue&file=dialoguetype.html">Dialogetypen</a>
|
||||
<li><a href="help.php?module=dialogue&file=info.html">Weitere Informationen</a>
|
||||
<li><a href="help.php?module=dialogue&file=maildefault.html">Mail Standard festlegen</a>
|
||||
<li><a href="help.php?module=dialogue&file=multiple.html">Mehrfachdialoge</a>
|
||||
</ul>
|
||||
@@ -0,0 +1,7 @@
|
||||
<p align="center"><b>Teilnahmezeitraum</b></b></p>
|
||||
|
||||
<p>Mit dieser Einstellung legen Sie fest wie lange Teilnehmer/innen nach der Anmeldung im Kurs verbleiben. Die Angabe erfolgt in Tagen. Die Frist beginnt mit dem Moment der Anmeldung. Nach Ablauf der Frist werden die Teilnehmer/innen automatisch abgemeldet. </p>
|
||||
|
||||
<p>Diese Option ist sinnvoll, wenn der Kurs keinen festgelegten Start- oder Endzeitpunkt hat und die Teilnehmer/innen jederzeit in den Kurs einsteigen können.</p>
|
||||
|
||||
<p>Wenn Sie hier keine Einstellung vornehmen, bleiben die Teilnehmer/innen so lange im Kurs bis Sie manuell gelöscht werden oder durch Nichtnutzung automatisch ausgetragen werden.</p>
|
||||
@@ -0,0 +1,22 @@
|
||||
<p align="center"><b>Vergleich der Bewertungen</b></p>
|
||||
|
||||
<p>Bei vielen Aufgabenstellungen ist es hilfreich, wenn sie unabhängig zweimal bewertet werden.
|
||||
Ein Teilnehmer schätzt die eigene Arbeit ein, bevor sie abgegeben wird und der/die Trainer/in sie bewertet.
|
||||
Der/die Trainer/in nutzt die Einschätzung des TN als Ausgangspunkt der eigenen Bewertung.
|
||||
Eine Übung erlaubt es dem Trainer/in das Verhältnis zwischen der Bewertung des Teilnehmers und dem Rest der Bewertung durch den Trainer zu definieren.
|
||||
Anmerkung: Die Bewertung des Teilnehmers wird nicht direkt als Bewertung verwendet, vielmehr wird geprüfdt in welchem Maße, die Bewertung mit der Bewertung des Trainers übereinstimmt.</p>
|
||||
|
||||
<p>Das Maß an Übereinstimmung dieser beiden Bewertungen berücksichtigt die Übereinstimmung bei den einzelnen Bewertungselementen. Diese Übereinstimmung muß in eine Bewertung übertragen werden, die Einstellung (Vergleich der Bewertungen) ermöglicht es dem/der Trainer/in festzulegen wie der Vergleich in eine Bewertung übertragen wird.</p>
|
||||
|
||||
<p>Damit Sie einen ersten Eindruck von den Auswirkungen der Einstellung erhalten, nehmen wir ein einfaches Beispiel, einer Bewertung mit zehn Ja/Nein-Fragen. Z.B. "Ist das Blatt richtig formatiert?" "Ist der errechnete Gewinnn 100,66 Euro?", etc... Angenommen Sie haben zehn solcher Fragen und der eingestellte Wert lautet
|
||||
e "Sehr Lax", dann wird eine vollständige Übereinstimmung inn allen Bewertungen eine Bewertung von 100% ergeben, wenn nur eine Frage nicht genau übereinstimmt, ergibt sich einen Bewertung von 90%,
|
||||
zwei Abweichungen ergeben eine Bewertung von 80%, drei Abweichungen 70% usw. Das scheint sehr plausibel und wirft die Frage auf, warum diese Bewertung mit "Sehr lax" bezeichnet wird.
|
||||
Nehmen wir nun den Fall eines Teilnehmers, der völlig zufällig die Bewertungen errät.
|
||||
Durchschnittlich wird er bei fünf von zehn Fragen richtig liegen mit seinen Antworten. Seine Bewertung läge also bei 50%. Bei der Einstellung "Lax" liegt der Zufallsfaktor bei 20%. Bei der "Fair"option ist der Zufallswert auf Null gesetzt.
|
||||
Bei dieser Einstellung wird eine 50% Bewertung erreicht wenn beide Bewertungen bei 8 von zehn Fragen übereinstimmen. Bei drei Abweichungen wird nur noch eine 25 % Bewertung erzielt. Wenn die Einstellung "strickt" gewählt wurde, führen zwei abweichende Bewertungen zu einer 40% Benotung. Die Einstellung "Sehr strickt" führtbei zwei Abweichungen nur noch zu einer 35% Bewertung, bei einer Abweichung in einer Frage wird eine Bewertung von 65 % erzielt.</p>
|
||||
|
||||
<p>Das Beispiel ist wirklich einfach gewählt, da die meisten Bewertungskriterien mehr als nur Ja/Nein Optionen umfassen. In diesen Fällen sind die Vergleichsergebnisse ähnlich wie oben bei großer Übereinstimmung. Die verschiedenen Level (Sehr Lax, Lax, Fair...) können genutzt werden, um den Vergleich fein zu justieren.
|
||||
Wenn Sie das Gefühl haben, das die Bewertung des Abgleichs zu niedrig ist, können Sie die Einstellung in Richtung Lax oder Sehr lax anpassen. Andernfalls können Sie die Einstellungen auch in entgegengesetzter Richtung verstellen, um einen höheren Grad der Übereinstimmung für gute Noten vorauszusetzen. Es ist tatsächlich sinnvoll, mit den verschiedenen Optionen zu experimentieren und dabei mit der Einstellung Fair zubeginnen.</p>
|
||||
|
||||
<p>Die Einstellung kann auch während des laufenden Kurses auf der Administrationsseite für die Übung verändert werden. Dazu muss die Option Wieder-Bewertung der Arbeiten gewählt werden, um einen Neuberechnung vorzunehmen. Diese Einstellung kann mehrmals geänder werden.
|
||||
</p>
|
||||
@@ -0,0 +1,21 @@
|
||||
<p>Übungen</p>
|
||||
<ul>
|
||||
<li><a href="help.php?module=exercise&file=administration.html">Administration</a>
|
||||
<li><a href="help.php?module=exercise&file=elements.html">Bewertungselemente</a>
|
||||
<li><a href="help.php?module=exercise&file=comparisonofassessments.html">Vergleich der Bewertungen</a>
|
||||
<li><a href="help.php?module=exercise&file=finalgrades.html">Abschlußnote</a>
|
||||
<li><a href="help.php?module=exercise&file=grade.html"> Bewertung der Übungen</a>
|
||||
<li><a href="help.php?module=exercise&file=gradinggrade.html">Bewertungsformular für Übungen</a>
|
||||
<li><a href="help.php?module=exercise&file=grading.html">Bewertung von Übungen</a>
|
||||
<li><a href="help.php?module=exercise&file=gradingstrategy.html">Bewertungsstrategie</a>
|
||||
<li><a href="help.php?module=exercise&file=leaguetable.html">Punktetabelle</a>
|
||||
<li><a href="help.php?module=exercise&file=leaguetablenames.html">Anzeige der Namen in der Übersicht</a>
|
||||
<li><a href="help.php?module=exercise&file=managing.html">Verwaltung von Übungsaufgaben</a>
|
||||
<li><a href="help.php?module=exercise&file=moreinfo.html">Übungen</a>
|
||||
<li><a href="help.php?module=exercise&file=nelements.html">Anzahl der Elemente oder Kriterien einer Übung</a>
|
||||
<li><a href="help.php?module=exercise&file=regrading.html">Wieder-Bewertung der Arbeiten der Teilnehmer/innen</a>
|
||||
<li><a href="help.php?module=exercise&file=specimen.html">Muster-Bewertungsboge</a>
|
||||
<li><a href="help.php?module=exercise&file=submissionofdescriptions.html">Aufgabenbeschreibung bereitstellen</a>
|
||||
<li><a href="help.php?module=exercise&file=takeownership.html">Fremde Aufgaben übernehmen</a>
|
||||
<li><a href="help.php?module=exercise&file=usemax.html">Umgang mit mehreren Arbeiten eines/r Teilnehmers/in</a>
|
||||
</ul>
|
||||
@@ -0,0 +1,8 @@
|
||||
<p align=center><b>Punktetabelle</b></p>
|
||||
|
||||
<p>Durch diese Option wird festgelegt, bis zu welcher Punktzahl die Arbeiten nach
|
||||
Abschluss der Übung in einer Übersicht angezeigt werden. Diese Tabelle zeigt die
|
||||
besten Arbeiten, welche eingereicht wurden. Wird bei dieser Einstellung der Wert
|
||||
Null gewählt, wird in der letzten Phase der Übung keine Tabelle angezeigt. </p>
|
||||
|
||||
|
||||
@@ -0,0 +1,5 @@
|
||||
<p align=center><b>Anzeige der Namen in der Übersicht</b></p>
|
||||
|
||||
<p>Durch diese Einstellung wird festgelegt, ob die Namen der Teilnehmer bis zu einer bestimmten
|
||||
Punktzahl angezeigt werden oder nicht. In der Standardeinstellung werden die Namen nicht angezeigt,
|
||||
d.h. die Anzeige erfolgt anonym.</p>
|
||||
@@ -0,0 +1,13 @@
|
||||
<p align=center><b>Wieder-Bewertung der Arbeiten der Teilnehmer/innen</b></p>
|
||||
|
||||
<p>Mit diesem Link berechnen Sie die Bewertungen aller Teilnehmer/innen neu. Normalerweise ist dieser Vorgang nicht erforderlich. Neue Arbeiten werden automatisch nach der Bewertung des Trainers berechnet.</p>
|
||||
|
||||
<p>Wenn die Bewertrungen im Vergleich zu hoch oder zu niedrig ausfallen, ist es möglich die Bewertungen insgesamt anzupassen. Der voreingestellt Wert lautet "Fair". Wenn die Bewertungen zu hoch sind, sollte die Einstellung auf "Strengt" oder "Sehr streng" gestellt werden, um die Bewertungen herabzusetzen. Alternativ, wenn die Bewertungen zu niedrig sind kann die Einstellung
|
||||
" Lax" oder "Sehr Lax" gewählt werden, um die Bewertung anzuheben.</p>
|
||||
|
||||
<p>Führen Sie folgende Schritte aus, um eine Neubewertung vorzunehmen:
|
||||
<ol>
|
||||
<li>Aktualisieren der Übung mit den neuen Werten in der Vergleichsoption;</li>
|
||||
<li>Gehen Sie zur Administrationsseite der Übungen und klicken Sie auf Aktulisierung der Bewertungen.</li>
|
||||
</ol>
|
||||
Die neuen Bewertungen werden angezeigt. Dieser Prozess kann mehrfach wiederholt werden.</p>
|
||||
@@ -0,0 +1,5 @@
|
||||
<P ALIGN=CENTER><B>Zahl der aktuellen Beiträge im RSS-Feed</B></P>
|
||||
|
||||
<P>Diese Option legt fest wie viele Beiträge als aktuell in den RSS-Feed übernommen werden.
|
||||
|
||||
<P>Eine Zahl zwischen 5 und 20 sollte bei den meisten Foren angemessen sein. Eine höhere Zahl ist erforderlich, wenn das Forum sehr aktiv ist.
|
||||
@@ -0,0 +1,11 @@
|
||||
<P ALIGN=CENTER><B>RSS Feed für dieses Forum</B></P>
|
||||
|
||||
<P>Diese Option ermöglicht es, RSS-Feeds zu aktivieren.
|
||||
|
||||
<P>Sie können zwei Arten von Foren unterscheiden:
|
||||
|
||||
<UL>
|
||||
<LI><B>Diskussionen:</B> Bei dieser Einstellung werden alle neuen Themen in einem Forum per RSS-Feed übermittelt.
|
||||
|
||||
<LI><B>Postings:</B> Bei dieser Option wird jeder neue Beitrag per RSS-Feed übermittelt.
|
||||
</UL>
|
||||
@@ -0,0 +1,12 @@
|
||||
<P ALIGN=CENTER><B>Jederzeit Einträge bearbeiten</B></P>
|
||||
|
||||
<P>Mit dieser Option ermöglichen Sie es den Teilnehmer/innen jederzeit ihre Einträge zu bearbeiten.
|
||||
|
||||
|
||||
<P>Sie können wählen:
|
||||
|
||||
<UL>
|
||||
<LI><B>Ja:</B> Einträge sind jederzeit bearbeitbar.
|
||||
|
||||
<LI><B>Nein:</B> Einträge sind nur in der festgelegten Zeit bearbeitbar.
|
||||
</UL>
|
||||
@@ -0,0 +1,5 @@
|
||||
<P ALIGN=CENTER><B>Zahl der aktuellen Beiträge im RSS-Feed</B></P>
|
||||
|
||||
<P>Diese Option legt fest wie viele Beiträge als aktuell in den RSS-Feed übernommen werden.
|
||||
|
||||
<P>Eine Zahl zwischen 5 und 20 sollte bei den meisten Glossaren angemessen sein. Eine höhere Zahl ist erforderlich, wenn das Glossar sehr aktiv ist.
|
||||
@@ -0,0 +1,24 @@
|
||||
<P ALIGN=CENTER><B>RSS feed for this glossary</B></P>
|
||||
|
||||
<P>This option allows you to enable RSS feeds in this glossary.
|
||||
|
||||
<P>You can select between two types of feeds:
|
||||
|
||||
<UL>
|
||||
<LI><B>With author:</B> Using this, generated feeds will include
|
||||
the name of the autor in every article.
|
||||
|
||||
<LI><B>Without author:</B> Using this, generated feeds won't include
|
||||
the name of the autor in every article.
|
||||
</UL>
|
||||
<P ALIGN=CENTER><B>RSS Feed für dieses Glossar</B></P>
|
||||
|
||||
<P>Diese Option ermöglicht es, RSS-Feeds zu aktivieren.
|
||||
|
||||
<P>Sie können zwei Arten von Foren unterscheiden:
|
||||
|
||||
<UL>
|
||||
<LI><B>Mit Autor:</B> Bei dieser Einstellung werden alle Beiräge mit dem Namen des autors übermittelt.
|
||||
|
||||
<LI><B>Ohne Autor:</B> Bei dieser Einstellung werden alle Beiräge ohne dem Namen des autors übermittelt.
|
||||
</UL>
|
||||
@@ -0,0 +1,928 @@
|
||||
<p align="center"><b>Das Markdown-Formatierungsmodell zur Erstellung von Web-Seiten</b></p>
|
||||
|
||||
<p>Markdown Formatierungen ermöglichen es, Texte einfach zu formatieren ohne dabei auf einen Editor zurückzugreifen. Die Formatierungen erfolgen ähnlich wie in Wiki-Texten durch Auszeichnungen der Texte.</p>
|
||||
<p>(Dieser Text ist eine Kopie von <a target="_blank" href="http://daringfireball.net/projects/markdown/syntax"> der Orginal Markdown-Syntax Seite</a>)
|
||||
</p>
|
||||
|
||||
<hr />
|
||||
<div id="Main">
|
||||
|
||||
<div class="article">
|
||||
|
||||
<ul>
|
||||
<li><a href="#overview">Overview</a>
|
||||
<ul>
|
||||
<li><a href="#philosophy">Philosophy</a></li>
|
||||
<li><a href="#html">Inline HTML</a></li>
|
||||
<li><a href="#autoescape">Automatic Escaping for Special Characters</a></li>
|
||||
</ul></li>
|
||||
<li><a href="#block">Block Elements</a>
|
||||
<ul>
|
||||
<li><a href="#p">Paragraphs and Line Breaks</a></li>
|
||||
<li><a href="#header">Headers</a></li>
|
||||
<li><a href="#blockquote">Blockquotes</a></li>
|
||||
<li><a href="#list">Lists</a></li>
|
||||
<li><a href="#precode">Code Blocks</a></li>
|
||||
<li><a href="#hr">Horizontal Rules</a></li>
|
||||
</ul></li>
|
||||
<li><a href="#span">Span Elements</a>
|
||||
<ul>
|
||||
<li><a href="#link">Links</a></li>
|
||||
<li><a href="#em">Emphasis</a></li>
|
||||
<li><a href="#code">Code</a></li>
|
||||
<li><a href="#img">Images</a></li>
|
||||
</ul></li>
|
||||
<li><a href="#misc">Miscellaneous</a>
|
||||
<ul>
|
||||
<li><a href="#backslash">Backslash Escapes</a></li>
|
||||
<li><a href="#autolink">Automatic Links</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
|
||||
<hr />
|
||||
|
||||
<h2 id="overview">Overview</h2>
|
||||
|
||||
<h3 id="philosophy">Philosophy</h3>
|
||||
|
||||
<p>Markdown is intended to be as easy-to-read and easy-to-write as is feasible.</p>
|
||||
|
||||
<p>Readability, however, is emphasized above all else. A Markdown-formatted
|
||||
document should be publishable as-is, as plain text, without looking
|
||||
like it’s been marked up with tags or formatting instructions. While
|
||||
Markdown’s syntax has been influenced by several existing text-to-HTML
|
||||
filters — including <a href="http://docutils.sourceforge.net/mirror/setext.html">Setext</a>, <a href="http://www.aaronsw.com/2002/atx/">atx</a>, <a href="http://textism.com/tools/textile/">Textile</a>, <a href="http://docutils.sourceforge.net/rst.html">reStructuredText</a>,
|
||||
<a href="http://www.triptico.com/software/grutatxt.html">Grutatext</a>, and <a href="http://ettext.taint.org/doc/">EtText</a> — the single biggest source of
|
||||
inspiration for Markdown’s syntax is the format of plain text email.</p>
|
||||
|
||||
<p>To this end, Markdown’s syntax is comprised entirely of punctuation
|
||||
characters, which punctuation characters have been carefully chosen so
|
||||
as to look like what they mean. E.g., asterisks around a word actually
|
||||
look like *emphasis*. Markdown lists look like, well, lists. Even
|
||||
blockquotes look like quoted passages of text, assuming you’ve ever
|
||||
used email.</p>
|
||||
|
||||
<h3 id="html">Inline HTML</h3>
|
||||
|
||||
<p>Markdown’s syntax is intended for one purpose: to be used as a
|
||||
format for <em>writing</em> for the web.</p>
|
||||
|
||||
<p>Markdown is not a replacement for HTML, or even close to it. Its
|
||||
syntax is very small, corresponding only to a very small subset of
|
||||
HTML tags. The idea is <em>not</em> to create a syntax that makes it easier
|
||||
to insert HTML tags. In my opinion, HTML tags are already easy to
|
||||
insert. The idea for Markdown is to make it easy to read, write, and
|
||||
edit prose. HTML is a <em>publishing</em> format; Markdown is a <em>writing</em>
|
||||
format. Thus, Markdown’s formatting syntax only addresses issues that
|
||||
can be conveyed in plain text.</p>
|
||||
|
||||
<p>For any markup that is not covered by Markdown’s syntax, you simply
|
||||
use HTML itself. There’s no need to preface it or delimit it to
|
||||
indicate that you’re switching from Markdown to HTML; you just use
|
||||
the tags.</p>
|
||||
|
||||
<p>The only restrictions are that block-level HTML elements — e.g. <code><div></code>,
|
||||
<code><table></code>, <code><pre></code>, <code><p></code>, etc. — must be separated from surrounding
|
||||
content by blank lines, and the start and end tags of the block should
|
||||
not be indented with tabs or spaces. Markdown is smart enough not
|
||||
to add extra (unwanted) <code><p></code> tags around HTML block-level tags.</p>
|
||||
|
||||
<p>For example, to add an HTML table to a Markdown article:</p>
|
||||
|
||||
<pre><code>This is a regular paragraph.
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td>Foo</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
This is another regular paragraph.
|
||||
</code></pre>
|
||||
|
||||
<p>Note that Markdown formatting syntax is not processed within block-level
|
||||
HTML tags. E.g., you can’t use Markdown-style <code>*emphasis*</code> inside an
|
||||
HTML block.</p>
|
||||
|
||||
<p>Span-level HTML tags — e.g. <code><span></code>, <code><cite></code>, or <code><del></code> — can be
|
||||
used anywhere in a Markdown paragraph, list item, or header. If you
|
||||
want, you can even use HTML tags instead of Markdown formatting; e.g. if
|
||||
you’d prefer to use HTML <code><a></code> or <code><img></code> tags instead of Markdown’s
|
||||
link or image syntax, go right ahead.</p>
|
||||
|
||||
<p>Unlike block-level HTML tags, Markdown syntax <em>is</em> processed within
|
||||
span-level tags.</p>
|
||||
|
||||
<h3 id="autoescape">Automatic Escaping for Special Characters</h3>
|
||||
|
||||
<p>In HTML, there are two characters that demand special treatment: <code><</code>
|
||||
and <code>&</code>. Left angle brackets are used to start tags; ampersands are
|
||||
used to denote HTML entities. If you want to use them as literal
|
||||
characters, you must escape them as entities, e.g. <code>&lt;</code>, and
|
||||
<code>&amp;</code>.</p>
|
||||
|
||||
<p>Ampersands in particular are bedeviling for web writers. If you want to
|
||||
write about ‘AT&T’, you need to write ‘<code>AT&amp;T</code>’. You even need to
|
||||
escape ampersands within URLs. Thus, if you want to link to:</p>
|
||||
|
||||
<pre><code>http://images.google.com/images?num=30&q=larry+bird
|
||||
</code></pre>
|
||||
|
||||
<p>you need to encode the URL as:</p>
|
||||
|
||||
<pre><code>http://images.google.com/images?num=30&amp;q=larry+bird
|
||||
</code></pre>
|
||||
|
||||
<p>in your anchor tag <code>href</code> attribute. Needless to say, this is easy to
|
||||
forget, and is probably the single most common source of HTML validation
|
||||
errors in otherwise well-marked-up web sites.</p>
|
||||
|
||||
<p>Markdown allows you to use these characters naturally, taking care of
|
||||
all the necessary escaping for you. If you use an ampersand as part of
|
||||
an HTML entity, it remains unchanged; otherwise it will be translated
|
||||
into <code>&amp;</code>.</p>
|
||||
|
||||
<p>So, if you want to include a copyright symbol in your article, you can write:</p>
|
||||
|
||||
<pre><code>&copy;
|
||||
</code></pre>
|
||||
|
||||
<p>and Markdown will leave it alone. But if you write:</p>
|
||||
|
||||
<pre><code>AT&T
|
||||
</code></pre>
|
||||
|
||||
<p>Markdown will translate it to:</p>
|
||||
|
||||
<pre><code>AT&amp;T
|
||||
</code></pre>
|
||||
|
||||
<p>Similarly, because Markdown supports <a href="#html">inline HTML</a>, if you use
|
||||
angle brackets as delimiters for HTML tags, Markdown will treat them as
|
||||
such. But if you write:</p>
|
||||
|
||||
<pre><code>4 < 5
|
||||
</code></pre>
|
||||
|
||||
<p>Markdown will translate it to:</p>
|
||||
|
||||
<pre><code>4 &lt; 5
|
||||
</code></pre>
|
||||
|
||||
<p>However, inside Markdown code spans and blocks, angle brackets and
|
||||
ampersands are <em>always</em> encoded automatically. This makes it easy to use
|
||||
Markdown to write about HTML code. (As opposed to raw HTML, which is a
|
||||
terrible format for writing about HTML syntax, because every single <code><</code>
|
||||
and <code>&</code> in your example code needs to be escaped.)</p>
|
||||
|
||||
<hr />
|
||||
|
||||
<h2 id="block">Block Elements</h2>
|
||||
|
||||
<h3 id="p">Paragraphs and Line Breaks</h3>
|
||||
|
||||
<p>A paragraph is simply one or more consecutive lines of text, separated
|
||||
by one or more blank lines. (A blank line is any line that looks like a
|
||||
blank line — a line containing nothing but spaces or tabs is considered
|
||||
blank.) Normal paragraphs should not be intended with spaces or tabs.</p>
|
||||
|
||||
<p>The implication of the “one or more consecutive lines of text” rule is
|
||||
that Markdown supports “hard-wrapped” text paragraphs. This differs
|
||||
significantly from most other text-to-HTML formatters (including Movable
|
||||
Type’s “Convert Line Breaks” option) which translate every line break
|
||||
character in a paragraph into a <code><br /></code> tag.</p>
|
||||
|
||||
<p>When you <em>do</em> want to insert a <code><br /></code> break tag using Markdown, you
|
||||
end a line with two or more spaces, then type return.</p>
|
||||
|
||||
<p>Yes, this takes a tad more effort to create a <code><br /></code>, but a simplistic
|
||||
“every line break is a <code><br /></code>” rule wouldn’t work for Markdown.
|
||||
Markdown’s email-style <a href="#blockquote">blockquoting</a> and multi-paragraph <a href="#list">list items</a>
|
||||
work best — and look better — when you format them with hard breaks.</p>
|
||||
|
||||
<h3 id="header">Headers</h3>
|
||||
|
||||
<p>Markdown supports two styles of headers, <a href="http://docutils.sourceforge.net/mirror/setext.html">Setext</a> and <a href="http://www.aaronsw.com/2002/atx/">atx</a>.</p>
|
||||
|
||||
<p>Setext-style headers are “underlined” using equal signs (for first-level
|
||||
headers) and dashes (for second-level headers). For example:</p>
|
||||
|
||||
<pre><code>This is an H1
|
||||
=============
|
||||
|
||||
This is an H2
|
||||
-------------
|
||||
</code></pre>
|
||||
|
||||
<p>Any number of underlining <code>=</code>’s or <code>-</code>’s will work.</p>
|
||||
|
||||
<p>Atx-style headers use 1-6 hash characters at the start of the line,
|
||||
corresponding to header levels 1-6. For example:</p>
|
||||
|
||||
<pre><code># This is an H1
|
||||
|
||||
## This is an H2
|
||||
|
||||
###### This is an H6
|
||||
</code></pre>
|
||||
|
||||
<p>Optionally, you may “close” atx-style headers. This is purely
|
||||
cosmetic — you can use this if you think it looks better. The
|
||||
closing hashes don’t even need to match the number of hashes
|
||||
used to open the header. (The number of opening hashes
|
||||
determines the header level.) :</p>
|
||||
|
||||
<pre><code># This is an H1 #
|
||||
|
||||
## This is an H2 ##
|
||||
|
||||
### This is an H3 ######
|
||||
</code></pre>
|
||||
|
||||
<h3 id="blockquote">Blockquotes</h3>
|
||||
|
||||
<p>Markdown uses email-style <code>></code> characters for blockquoting. If you’re
|
||||
familiar with quoting passages of text in an email message, then you
|
||||
know how to create a blockquote in Markdown. It looks best if you hard
|
||||
wrap the text and put a <code>></code> before every line:</p>
|
||||
|
||||
<pre><code>> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
|
||||
> consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
|
||||
> Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
|
||||
>
|
||||
> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
|
||||
> id sem consectetuer libero luctus adipiscing.
|
||||
</code></pre>
|
||||
|
||||
<p>Markdown allows you to be lazy and only put the <code>></code> before the first
|
||||
line of a hard-wrapped paragraph:</p>
|
||||
|
||||
<pre><code>> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
|
||||
consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
|
||||
Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
|
||||
|
||||
> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
|
||||
id sem consectetuer libero luctus adipiscing.
|
||||
</code></pre>
|
||||
|
||||
<p>Blockquotes can be nested (i.e. a blockquote-in-a-blockquote) by
|
||||
adding additional levels of <code>></code>:</p>
|
||||
|
||||
<pre><code>> This is the first level of quoting.
|
||||
>
|
||||
> > This is nested blockquote.
|
||||
>
|
||||
> Back to the first level.
|
||||
</code></pre>
|
||||
|
||||
<p>Blockquotes can contain other Markdown elements, including headers, lists,
|
||||
and code blocks:</p>
|
||||
|
||||
<pre><code>> ## This is a header.
|
||||
>
|
||||
> 1. This is the first list item.
|
||||
> 2. This is the second list item.
|
||||
>
|
||||
> Here's some example code:
|
||||
>
|
||||
> return shell_exec("echo $input | $markdown_script");
|
||||
</code></pre>
|
||||
|
||||
<p>Any decent text editor should make email-style quoting easy. For
|
||||
example, with BBEdit, you can make a selection and choose Increase
|
||||
Quote Level from the Text menu.</p>
|
||||
|
||||
<h3 id="list">Lists</h3>
|
||||
|
||||
<p>Markdown supports ordered (numbered) and unordered (bulleted) lists.</p>
|
||||
|
||||
<p>Unordered lists use asterisks, pluses, and hyphens — interchangably
|
||||
— as list markers:</p>
|
||||
|
||||
<pre><code>* Red
|
||||
* Green
|
||||
* Blue
|
||||
</code></pre>
|
||||
|
||||
<p>is equivalent to:</p>
|
||||
|
||||
<pre><code>+ Red
|
||||
+ Green
|
||||
+ Blue
|
||||
</code></pre>
|
||||
|
||||
<p>and:</p>
|
||||
|
||||
<pre><code>- Red
|
||||
- Green
|
||||
- Blue
|
||||
</code></pre>
|
||||
|
||||
<p>Ordered lists use numbers followed by periods:</p>
|
||||
|
||||
<pre><code>1. Bird
|
||||
2. McHale
|
||||
3. Parish
|
||||
</code></pre>
|
||||
|
||||
<p>It’s important to note that the actual numbers you use to mark the
|
||||
list have no effect on the HTML output Markdown produces. The HTML
|
||||
Markdown produces from the above list is:</p>
|
||||
|
||||
<pre><code><ol>
|
||||
<li>Bird</li>
|
||||
<li>McHale</li>
|
||||
<li>Parish</li>
|
||||
</ol>
|
||||
</code></pre>
|
||||
|
||||
<p>If you instead wrote the list in Markdown like this:</p>
|
||||
|
||||
<pre><code>1. Bird
|
||||
1. McHale
|
||||
1. Parish
|
||||
</code></pre>
|
||||
|
||||
<p>or even:</p>
|
||||
|
||||
<pre><code>3. Bird
|
||||
1. McHale
|
||||
8. Parish
|
||||
</code></pre>
|
||||
|
||||
<p>you’d get the exact same HTML output. The point is, if you want to,
|
||||
you can use ordinal numbers in your ordered Markdown lists, so that
|
||||
the numbers in your source match the numbers in your published HTML.
|
||||
But if you want to be lazy, you don’t have to.</p>
|
||||
|
||||
<p>If you do use lazy list numbering, however, you should still start the
|
||||
list with the number 1. At some point in the future, Markdown may support
|
||||
starting ordered lists at an arbitrary number.</p>
|
||||
|
||||
<p>List markers typically start at the left margin, but may be indented by
|
||||
up to three spaces. List markers must be followed by one or more spaces
|
||||
or a tab.</p>
|
||||
|
||||
<p>To make lists look nice, you can wrap items with hanging indents:</p>
|
||||
|
||||
<pre><code>* Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
|
||||
Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi,
|
||||
viverra nec, fringilla in, laoreet vitae, risus.
|
||||
* Donec sit amet nisl. Aliquam semper ipsum sit amet velit.
|
||||
Suspendisse id sem consectetuer libero luctus adipiscing.
|
||||
</code></pre>
|
||||
|
||||
<p>But if you want to be lazy, you don’t have to:</p>
|
||||
|
||||
<pre><code>* Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
|
||||
Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi,
|
||||
viverra nec, fringilla in, laoreet vitae, risus.
|
||||
* Donec sit amet nisl. Aliquam semper ipsum sit amet velit.
|
||||
Suspendisse id sem consectetuer libero luctus adipiscing.
|
||||
</code></pre>
|
||||
|
||||
<p>If list items are separated by blank lines, Markdown will wrap the
|
||||
items in <code><p></code> tags in the HTML output. For example, this input:</p>
|
||||
|
||||
<pre><code>* Bird
|
||||
* Magic
|
||||
</code></pre>
|
||||
|
||||
<p>will turn into:</p>
|
||||
|
||||
<pre><code><ul>
|
||||
<li>Bird</li>
|
||||
<li>Magic</li>
|
||||
</ul>
|
||||
</code></pre>
|
||||
|
||||
<p>But this:</p>
|
||||
|
||||
<pre><code>* Bird
|
||||
|
||||
* Magic
|
||||
</code></pre>
|
||||
|
||||
<p>will turn into:</p>
|
||||
|
||||
<pre><code><ul>
|
||||
<li><p>Bird</p></li>
|
||||
<li><p>Magic</p></li>
|
||||
</ul>
|
||||
</code></pre>
|
||||
|
||||
<p>List items may consist of multiple paragraphs. Each subsequent
|
||||
paragraph in a list item must be intended by either 4 spaces
|
||||
or one tab:</p>
|
||||
|
||||
<pre><code>1. This is a list item with two paragraphs. Lorem ipsum dolor
|
||||
sit amet, consectetuer adipiscing elit. Aliquam hendrerit
|
||||
mi posuere lectus.
|
||||
|
||||
Vestibulum enim wisi, viverra nec, fringilla in, laoreet
|
||||
vitae, risus. Donec sit amet nisl. Aliquam semper ipsum
|
||||
sit amet velit.
|
||||
|
||||
2. Suspendisse id sem consectetuer libero luctus adipiscing.
|
||||
</code></pre>
|
||||
|
||||
<p>It looks nice if you indent every line of the subsequent
|
||||
paragraphs, but here again, Markdown will allow you to be
|
||||
lazy:</p>
|
||||
|
||||
<pre><code>* This is a list item with two paragraphs.
|
||||
|
||||
This is the second paragraph in the list item. You're
|
||||
only required to indent the first line. Lorem ipsum dolor
|
||||
sit amet, consectetuer adipiscing elit.
|
||||
|
||||
* Another item in the same list.
|
||||
</code></pre>
|
||||
|
||||
<p>To put a blockquote within a list item, the blockquote’s <code>></code>
|
||||
delimiters need to be indented:</p>
|
||||
|
||||
<pre><code>* A list item with a blockquote:
|
||||
|
||||
> This is a blockquote
|
||||
> inside a list item.
|
||||
</code></pre>
|
||||
|
||||
<p>To put a code block within a list item, the code block needs
|
||||
to be indented <em>twice</em> — 8 spaces or two tabs:</p>
|
||||
|
||||
<pre><code>* A list item with a code block:
|
||||
|
||||
<code goes here>
|
||||
</code></pre>
|
||||
|
||||
<p>It’s worth noting that it’s possible to trigger an ordered list by
|
||||
accident, by writing something like this:</p>
|
||||
|
||||
<pre><code>1986. What a great season.
|
||||
</code></pre>
|
||||
|
||||
<p>In other words, a <em>number-period-space</em> sequence at the beginning of a
|
||||
line. To avoid this, you can backslash-escape the period:</p>
|
||||
|
||||
<pre><code>1986\. What a great season.
|
||||
</code></pre>
|
||||
|
||||
<h3 id="precode">Code Blocks</h3>
|
||||
|
||||
<p>Pre-formatted code blocks are used for writing about programming or
|
||||
markup source code. Rather than forming normal paragraphs, the lines
|
||||
of a code block are interpreted literally. Markdown wraps a code block
|
||||
in both <code><pre></code> and <code><code></code> tags.</p>
|
||||
|
||||
<p>To produce a code block in Markdown, simply indent every line of the
|
||||
block by at least 4 spaces or 1 tab. For example, given this input:</p>
|
||||
|
||||
<pre><code>This is a normal paragraph:
|
||||
|
||||
This is a code block.
|
||||
</code></pre>
|
||||
|
||||
<p>Markdown will generate:</p>
|
||||
|
||||
<pre><code><p>This is a normal paragraph:</p>
|
||||
|
||||
<pre><code>This is a code block.
|
||||
</code></pre>
|
||||
</code></pre>
|
||||
|
||||
<p>One level of indentation — 4 spaces or 1 tab — is removed from each
|
||||
line of the code block. For example, this:</p>
|
||||
|
||||
<pre><code>Here is an example of AppleScript:
|
||||
|
||||
tell application "Foo"
|
||||
beep
|
||||
end tell
|
||||
</code></pre>
|
||||
|
||||
<p>will turn into:</p>
|
||||
|
||||
<pre><code><p>Here is an example of AppleScript:</p>
|
||||
|
||||
<pre><code>tell application "Foo"
|
||||
beep
|
||||
end tell
|
||||
</code></pre>
|
||||
</code></pre>
|
||||
|
||||
<p>A code block continues until it reaches a line that is not indented
|
||||
(or the end of the article).</p>
|
||||
|
||||
<p>Within a code block, ampersands (<code>&</code>) and angle brackets (<code><</code> and <code>></code>)
|
||||
are automatically converted into HTML entities. This makes it very
|
||||
easy to include example HTML source code using Markdown — just paste
|
||||
it and indent it, and Markdown will handle the hassle of encoding the
|
||||
ampersands and angle brackets. For example, this:</p>
|
||||
|
||||
<pre><code> <div class="footer">
|
||||
&copy; 2004 Foo Corporation
|
||||
</div>
|
||||
</code></pre>
|
||||
|
||||
<p>will turn into:</p>
|
||||
|
||||
<pre><code><pre><code>&lt;div class="footer"&gt;
|
||||
&amp;copy; 2004 Foo Corporation
|
||||
&lt;/div&gt;
|
||||
</code></pre>
|
||||
</code></pre>
|
||||
|
||||
<p>Regular Markdown syntax is not processed within code blocks. E.g.,
|
||||
asterisks are just literal asterisks within a code block. This means
|
||||
it’s also easy to use Markdown to write about Markdown’s own syntax.</p>
|
||||
|
||||
<h3 id="hr">Horizontal Rules</h3>
|
||||
|
||||
<p>You can produce a horizontal rule tag (<code><hr /></code>) by placing three or
|
||||
more hyphens or asterisks on a line by themselves. If you wish, you
|
||||
may use spaces between the hyphens or asterisks. Each of the following
|
||||
lines will produce a horizontal rule:</p>
|
||||
|
||||
<pre><code>* * *
|
||||
|
||||
***
|
||||
|
||||
*****
|
||||
|
||||
- - -
|
||||
|
||||
---------------------------------------
|
||||
</code></pre>
|
||||
|
||||
<hr />
|
||||
|
||||
<h2 id="span">Span Elements</h2>
|
||||
|
||||
<h3 id="link">Links</h3>
|
||||
|
||||
<p>Markdown supports two style of links: <em>inline</em> and <em>reference</em>.</p>
|
||||
|
||||
<p>In both styles, the link text is delimited by [square brackets].</p>
|
||||
|
||||
<p>To create an inline link, use a set of regular parentheses immediately
|
||||
after the link text’s closing square bracket. Inside the parentheses,
|
||||
put the URL where you want the link to point, along with an <em>optional</em>
|
||||
title for the link, surrounded in quotes. For example:</p>
|
||||
|
||||
<pre><code>This is [an example](http://example.com/ "Title") inline link.
|
||||
|
||||
[This link](http://example.net/) has no title attribute.
|
||||
</code></pre>
|
||||
|
||||
<p>Will produce:</p>
|
||||
|
||||
<pre><code><p>This is <a href="http://example.com/" title="Title">
|
||||
an example</a> inline link.</p>
|
||||
|
||||
<p><a href="http://example.net/">This link</a> has no
|
||||
title attribute.</p>
|
||||
</code></pre>
|
||||
|
||||
<p>If you’re referring to a local resource on the same server, you can
|
||||
use relative paths:</p>
|
||||
|
||||
<pre><code>See my [About](/about/) page for details.
|
||||
</code></pre>
|
||||
|
||||
<p>Reference-style links use a second set of square brackets, inside
|
||||
which you place a label of your choosing to identify the link:</p>
|
||||
|
||||
<pre><code>This is [an example][id] reference-style link.
|
||||
</code></pre>
|
||||
|
||||
<p>You can optionally use a space to separate the sets of brackets:</p>
|
||||
|
||||
<pre><code>This is [an example] [id] reference-style link.
|
||||
</code></pre>
|
||||
|
||||
<p>Then, anywhere in the document, you define your link label like this,
|
||||
on a line by itself:</p>
|
||||
|
||||
<pre><code>[id]: http://example.com/ "Optional Title Here"
|
||||
</code></pre>
|
||||
|
||||
<p>That is:</p>
|
||||
|
||||
<ul>
|
||||
<li>Square brackets containing the link identifier (optionally
|
||||
indented from the left margin using spaces or tabs);</li>
|
||||
<li>followed by a colon;</li>
|
||||
<li>followed by one or more spaces (or tabs);</li>
|
||||
<li>followed by the URL for the link;</li>
|
||||
<li>optionally followed by a title attribute for the link, enclosed
|
||||
in double or single quotes.</li>
|
||||
</ul>
|
||||
|
||||
<p>The link URL may, optionally, be surrounded by angle brackets:</p>
|
||||
|
||||
<pre><code>[id]: <http://example.com/> "Optional Title Here"
|
||||
</code></pre>
|
||||
|
||||
<p>You can put the title attribute on the next line and use extra spaces
|
||||
or tabs for padding, which tends to look better with longer URLs:</p>
|
||||
|
||||
<pre><code>[id]: http://example.com/longish/path/to/resource/here
|
||||
"Optional Title Here"
|
||||
</code></pre>
|
||||
|
||||
<p>Link definitions are only used for creating links during Markdown
|
||||
processing, and are stripped from your document in the HTML output.</p>
|
||||
|
||||
<p>Link definition names may constist of letters, numbers, spaces, and punctuation — but they are <em>not</em> case sensitive. E.g. these two links:</p>
|
||||
|
||||
<pre><code>[link text][a]
|
||||
[link text][A]
|
||||
</code></pre>
|
||||
|
||||
<p>are equivalent.</p>
|
||||
|
||||
<p>The <em>implicit link name</em> shortcut allows you to omit the name of the
|
||||
link, in which case the link text itself is used as the name.
|
||||
Just use an empty set of square brackets — e.g., to link the word
|
||||
“Google” to the google.com web site, you could simply write:</p>
|
||||
|
||||
<pre><code>[Google][]
|
||||
</code></pre>
|
||||
|
||||
<p>And then define the link:</p>
|
||||
|
||||
<pre><code>[Google]: http://google.com/
|
||||
</code></pre>
|
||||
|
||||
<p>Because link names may contain spaces, this shortcut even works for
|
||||
multiple words in the link text:</p>
|
||||
|
||||
<pre><code>Visit [Daring Fireball][] for more information.
|
||||
</code></pre>
|
||||
|
||||
<p>And then define the link:</p>
|
||||
|
||||
<pre><code>[Daring Fireball]: http://daringfireball.net/
|
||||
</code></pre>
|
||||
|
||||
<p>Link definitions can be placed anywhere in your Markdown document. I
|
||||
tend to put them immediately after each paragraph in which they’re
|
||||
used, but if you want, you can put them all at the end of your
|
||||
document, sort of like footnotes.</p>
|
||||
|
||||
<p>Here’s an example of reference links in action:</p>
|
||||
|
||||
<pre><code>I get 10 times more traffic from [Google] [1] than from
|
||||
[Yahoo] [2] or [MSN] [3].
|
||||
|
||||
[1]: http://google.com/ "Google"
|
||||
[2]: http://search.yahoo.com/ "Yahoo Search"
|
||||
[3]: http://search.msn.com/ "MSN Search"
|
||||
</code></pre>
|
||||
|
||||
<p>Using the implicit link name shortcut, you could instead write:</p>
|
||||
|
||||
<pre><code>I get 10 times more traffic from [Google][] than from
|
||||
[Yahoo][] or [MSN][].
|
||||
|
||||
[google]: http://google.com/ "Google"
|
||||
[yahoo]: http://search.yahoo.com/ "Yahoo Search"
|
||||
[msn]: http://search.msn.com/ "MSN Search"
|
||||
</code></pre>
|
||||
|
||||
<p>Both of the above examples will produce the following HTML output:</p>
|
||||
|
||||
<pre><code><p>I get 10 times more traffic from <a href="http://google.com/"
|
||||
title="Google">Google</a> than from
|
||||
<a href="http://search.yahoo.com/" title="Yahoo Search">Yahoo</a>
|
||||
or <a href="http://search.msn.com/" title="MSN Search">MSN</a>.</p>
|
||||
</code></pre>
|
||||
|
||||
<p>For comparison, here is the same paragraph written using
|
||||
Markdown’s inline link style:</p>
|
||||
|
||||
<pre><code>I get 10 times more traffic from [Google](http://google.com/ "Google")
|
||||
than from [Yahoo](http://search.yahoo.com/ "Yahoo Search") or
|
||||
[MSN](http://search.msn.com/ "MSN Search").
|
||||
</code></pre>
|
||||
|
||||
<p>The point of reference-style links is not that they’re easier to
|
||||
write. The point is that with reference-style links, your document
|
||||
source is vastly more readable. Compare the above examples: using
|
||||
reference-style links, the paragraph itself is only 81 characters
|
||||
long; with inline-style links, it’s 176 characters; and as raw HTML,
|
||||
it’s 234 characters. In the raw HTML, there’s more markup than there
|
||||
is text.</p>
|
||||
|
||||
<p>With Markdown’s reference-style links, a source document much more
|
||||
closely resembles the final output, as rendered in a browser. By
|
||||
allowing you to move the markup-related metadata out of the paragraph,
|
||||
you can add links without interrupting the narrative flow of your
|
||||
prose.</p>
|
||||
|
||||
<h3 id="em">Emphasis</h3>
|
||||
|
||||
<p>Markdown treats asterisks (<code>*</code>) and underscores (<code>_</code>) as indicators of
|
||||
emphasis. Text wrapped with one <code>*</code> or <code>_</code> will be wrapped with an
|
||||
HTML <code><em></code> tag; double <code>*</code>’s or <code>_</code>’s will be wrapped with an HTML
|
||||
<code><strong></code> tag. E.g., this input:</p>
|
||||
|
||||
<pre><code>*single asterisks*
|
||||
|
||||
_single underscores_
|
||||
|
||||
**double asterisks**
|
||||
|
||||
__double underscores__
|
||||
</code></pre>
|
||||
|
||||
<p>will produce:</p>
|
||||
|
||||
<pre><code><em>single asterisks</em>
|
||||
|
||||
<em>single underscores</em>
|
||||
|
||||
<strong>double asterisks</strong>
|
||||
|
||||
<strong>double underscores</strong>
|
||||
</code></pre>
|
||||
|
||||
<p>You can use whichever style you prefer; the lone restriction is that
|
||||
the same character must be used to open and close an emphasis span.</p>
|
||||
|
||||
<p>Emphasis can be used in the middle of a word:</p>
|
||||
|
||||
<pre><code>un*fucking*believable
|
||||
</code></pre>
|
||||
|
||||
<p>But if you surround an <code>*</code> or <code>_</code> with spaces, it’ll be treated as a
|
||||
literal asterisk or underscore.</p>
|
||||
|
||||
<p>To produce a literal asterisk or underscore at a position where it
|
||||
would otherwise be used as an emphasis delimiter, you can backslash
|
||||
escape it:</p>
|
||||
|
||||
<pre><code>\*this text is surrounded by literal asterisks\*
|
||||
</code></pre>
|
||||
|
||||
<h3 id="code">Code</h3>
|
||||
|
||||
<p>To indicate a span of code, wrap it with backtick quotes (<code>`</code>).
|
||||
Unlike a pre-formatted code block, a code span indicates code within a
|
||||
normal paragraph. For example:</p>
|
||||
|
||||
<pre><code>Use the `printf()` function.
|
||||
</code></pre>
|
||||
|
||||
<p>will produce:</p>
|
||||
|
||||
<pre><code><p>Use the <code>printf()</code> function.</p>
|
||||
</code></pre>
|
||||
|
||||
<p>To include a literal backtick character within a code span, you can
|
||||
backslash escape it:</p>
|
||||
|
||||
<pre><code>`There is a literal backtick (\`) here.`
|
||||
</code></pre>
|
||||
|
||||
<p>Or, if you prefer, you can use multiple backticks as the opening and
|
||||
closing delimiters:</p>
|
||||
|
||||
<pre><code>``There is a literal backtick (`) here.``
|
||||
</code></pre>
|
||||
|
||||
<p>Both of the previous two examples will produce this:</p>
|
||||
|
||||
<pre><code><p><code>There is a literal backtick (`) here.</code></p>
|
||||
</code></pre>
|
||||
|
||||
<p>With a code span, ampersands and angle brackets are encoded as HTML
|
||||
entities automatically, which makes it easy to include example HTML
|
||||
tags. Markdown will turn this:</p>
|
||||
|
||||
<pre><code>Please don't use any `<blink>` tags.
|
||||
</code></pre>
|
||||
|
||||
<p>into:</p>
|
||||
|
||||
<pre><code><p>Please don't use any <code>&lt;blink&gt;</code> tags.</p>
|
||||
</code></pre>
|
||||
|
||||
<p>You can write this:</p>
|
||||
|
||||
<pre><code>`&#8212;` is the decimal-encoded equivalent of `&mdash;`.
|
||||
</code></pre>
|
||||
|
||||
<p>to produce:</p>
|
||||
|
||||
<pre><code><p><code>&amp;#8212;</code> is the decimal-encoded
|
||||
equivalent of <code>&amp;mdash;</code>.</p>
|
||||
</code></pre>
|
||||
|
||||
<h3 id="img">Images</h3>
|
||||
|
||||
<p>Admittedly, it’s fairly difficult to devise a “natural” syntax for
|
||||
placing images into a plain text document format.</p>
|
||||
|
||||
<p>Markdown uses an image syntax that is intended to resemble the syntax
|
||||
for links, allowing for two styles: <em>inline</em> and <em>reference</em>.</p>
|
||||
|
||||
<p>Inline image syntax looks like this:</p>
|
||||
|
||||
<pre><code>
|
||||
|
||||
|
||||
</code></pre>
|
||||
|
||||
<p>That is:</p>
|
||||
|
||||
<ul>
|
||||
<li>An exclamation mark: <code>!</code>;</li>
|
||||
<li>followed by a set of square brackets, containing the <code>alt</code>
|
||||
attribute text for the image;</li>
|
||||
<li>followed by a set of parentheses, containing the URL or path to
|
||||
the image, and an optional <code>title</code> attribute enclosed in double
|
||||
or single quotes.</li>
|
||||
</ul>
|
||||
|
||||
<p>Reference-style image syntax looks like this:</p>
|
||||
|
||||
<pre><code>![Alt text][id]
|
||||
</code></pre>
|
||||
|
||||
<p>Where “id” is the name of a defined image reference. Image references
|
||||
are defined using syntax identical to link references:</p>
|
||||
|
||||
<pre><code>[id]: url/to/image "Optional title attribute"
|
||||
</code></pre>
|
||||
|
||||
<p>As of this writing, Markdown has no syntax for specifying the
|
||||
dimensions of an image; if this is important to you, you can simply
|
||||
use regular HTML <code><img></code> tags.</p>
|
||||
|
||||
<hr />
|
||||
|
||||
<h2 id="misc">Miscellaneous</h2>
|
||||
|
||||
<h3 id="autolink">Automatic Links</h3>
|
||||
|
||||
<p>Markdown supports a shortcut style for creating “automatic” links for URLs and email addresses: simply surround the URL or email address with angle brackets. What this means is that if you want to show the actual text of a URL or email address, and also have it be a clickable link, you can do this:</p>
|
||||
|
||||
<pre><code><http://example.com/>
|
||||
</code></pre>
|
||||
|
||||
<p>Markdown will turn this into:</p>
|
||||
|
||||
<pre><code><a href="http://example.com/">http://example.com/</a>
|
||||
</code></pre>
|
||||
|
||||
<p>Automatic links for email addresses work similarly, except that
|
||||
Markdown will also perform a bit of randomized decimal and hex
|
||||
entity-encoding to help obscure your address from address-harvesting
|
||||
spambots. For example, Markdown will turn this:</p>
|
||||
|
||||
<pre><code><[email protected]>
|
||||
</code></pre>
|
||||
|
||||
<p>into something like this:</p>
|
||||
|
||||
<pre><code><a href="&#x6D;&#x61;i&#x6C;&#x74;&#x6F;:&#x61;&#x64;&#x64;&#x72;&#x65;
|
||||
&#115;&#115;&#64;&#101;&#120;&#x61;&#109;&#x70;&#x6C;e&#x2E;&#99;&#111;
|
||||
&#109;">&#x61;&#x64;&#x64;&#x72;&#x65;&#115;&#115;&#64;&#101;&#120;&#x61;
|
||||
&#109;&#x70;&#x6C;e&#x2E;&#99;&#111;&#109;</a>
|
||||
</code></pre>
|
||||
|
||||
<p>which will render in a browser as a clickable link to “[email protected]”.</p>
|
||||
|
||||
<p>(This sort of entity-encoding trick will indeed fool many, if not
|
||||
most, address-harvesting bots, but it definitely won’t fool all of
|
||||
them. It’s better than nothing, but an address published in this way
|
||||
will probably eventually start receiving spam.)</p>
|
||||
|
||||
<h3 id="backslash">Backslash Escapes</h3>
|
||||
|
||||
<p>Markdown allows you to use backslash escapes to generate literal
|
||||
characters which would otherwise have special meaning in Markdown’s
|
||||
formatting syntax. For example, if you wanted to surround a word with
|
||||
literal asterisks (instead of an HTML <code><em></code> tag), you can backslashes
|
||||
before the asterisks, like this:</p>
|
||||
|
||||
<pre><code>\*literal asterisks\*
|
||||
</code></pre>
|
||||
|
||||
<p>Markdown provides backslash escapes for the following characters:</p>
|
||||
|
||||
<pre><code>\ backslash
|
||||
` backtick
|
||||
* asterisk
|
||||
_ underscore
|
||||
{} curly braces
|
||||
[] square brackets
|
||||
() parentheses
|
||||
# hash mark
|
||||
. dot
|
||||
! exclamation mark
|
||||
</code></pre>
|
||||
|
||||
</div> <!-- article -->
|
||||
Reference in New Issue
Block a user