| Beide Seiten der vorigen RevisionVorhergehende ÜberarbeitungNächste Überarbeitung | Vorhergehende Überarbeitung |
| tachtler:asciidoc_tor [2019/09/04 11:40] – [man-Pages (UNIX/Linux)] klaus | tachtler:asciidoc_tor [2019/09/04 12:41] (aktuell) – [Asciidoc(tor)] klaus |
|---|
| ====== Asciidoc(tor) ====== | ====== Asciidoc(tor) ====== |
| |
| [[https://asciidoctor.org/|{{:tachtler:index:asciidoctor-48x48.png }}]] [[https://asciidoctor.org/|Asciidoctor]] ist eine schnelle, quelloffene Textverarbeitungs- und Publikationswerkzeugkette zur Konvertierung von AsciiDoc-Inhalten in **HTML5**, **DocBook**, **PDF**, **''man''-Pages** und andere Formate. [[https://asciidoctor.org/|Asciidoctor]] ist in Rubin geschrieben und läuft auf allen gängigen Betriebssystemen. Das [[https://asciidoctor.org/|Asciidoctor]]-Projekt wird auf [[https://github.com/asciidoctor/asciidoctor|GitHub - Asciidoctor]] gehostet. | [[https://asciidoctor.org/|{{:tachtler:index:asciidoctor-48x48.png }}]] [[https://asciidoctor.org/|Asciidoctor]] ist eine schnelle, quelloffene Textverarbeitungs- und Publikationswerkzeugkette zur Konvertierung von AsciiDoc-Inhalten in **HTML5**, **DocBook**, **PDF**, **''man''-Pages** und andere Formate. [[https://asciidoctor.org/|Asciidoctor]] ist in [[https://www.ruby-lang.org/de/|Ruby]] geschrieben und läuft auf allen gängigen Betriebssystemen. Das [[https://asciidoctor.org/|Asciidoctor]]-Projekt wird auf [[https://github.com/asciidoctor/asciidoctor|GitHub - Asciidoctor]] gehostet. |
| |
| ^ Beschreibung ^ Externer Link ^ | ^ Beschreibung ^ Externer Link ^ |
| *0*:: | *0*:: |
| Success. | Success. |
| Image is a picture of a life form. | Execution was successful. |
| |
| *1*:: | *1*:: |
| Failure. | Failure. |
| Image is not a picture of a life form. | Execution was NOT successful. |
| |
| == Resources | == Resources |
| === Dokumenten Kopf (Document Header) === | === Dokumenten Kopf (Document Header) === |
| |
| Ein **''man''-Page-Dokumentenkopf ist obligatorisch. Die Titelzeile enthält den Namen der Manual-Seite, gefolgt von der manuellen Abschnittsnummer in runden Klammern. Der Titelname sollte keine Leerzeichen enthalten. Die manuelle Abschnittsnummer ist eine einzelne Ziffer, optional gefolgt von einem einzelnen Zeichen. | Ein **''man''-Page-Dokumentenkopf** ist obligatorisch. Die Titelzeile enthält den Namen der Manual-Seite, gefolgt von der manuellen Abschnittsnummer in runden Klammern. Der Titelname sollte keine Leerzeichen enthalten. Die manuelle Abschnittsnummer ist eine einzelne Ziffer, optional gefolgt von einem einzelnen Zeichen. |
| |
| === Der Abschnitt NAME (NAME Section) === | === Der Abschnitt NAME (NAME Section) === |
| * "COPYRIGHT" | * "COPYRIGHT" |
| |
| Es gibt mehrere eingebaute Dokumentattribute, die nur 'man''-Pages betreffen. Wenn sie verwendet werden, müssen sie im Dokumenten Kopf (Document Header) gesetzt werden. | Es gibt mehrere eingebaute Dokumentattribute, die nur ''man''-Pages betreffen. Wenn sie verwendet werden, müssen sie im Dokumenten Kopf (Document Header) gesetzt werden. |
| | |
| | ^ Attribute Name ^ Beschreibung ^ Beispielwert ^ |
| | | ''mantitle'' | Alternative Möglichkeit, den Namen der Manpage festzulegen. | ''TEST(1)'' | |
| | | ''manvolnum'' | Nummer de ''man''-Page Sektion ("SECTION") | ''1'' | |
| | | ''manname'' | Alternative Möglichkeit, den Befehlsnamen festzulegen. | ''test'' | |
| | | ''manpurpose'' | Alternative Möglichkeit, den Zweck des Befehls festzulegen. | ''Befehlsbeschreibung'' | |
| | | ''man-linkstyle'' | Style der Links in der ''man''-Page-Ausgabe.\\ Eine gültige Link-Formatsequenz. | ''blue R <>'' | |
| | | ''mansource'' | Die Quelle, auf die sich die Manual-Seite bezieht. Bei der Erstellung von **DocBook** wird es zu einem **DocBook ''refmiscinfo''-Attribut** und erscheint in der Fußzeile. | ''Test'' | |
| | | ''manversion'' | Die Version der ''man''-Page. Standardmäßig wird die ''revnumber'' verwendet, wenn nichts angegeben ist. Bei der Erstellung von **DocBook** wird es zu einem **DocBook ''refmiscinfo''-Attribut** und erscheint in der Fußzeile. Wird von [[https://asciidoctor.org/|Asciidoctor]] nicht verwendet. | ''1.0.0'' | |
| | | ''manmanual'' | Manueller Name. Bei der Erstellung von **DocBook** wird es zu einem **DocBook ''refmiscinfo''-Attribut** und erscheint in der Fußzeile. | ''Test Manual'' | |
| | |
| | Ein vollständiges Beispiel befindet sich unter [[https://raw.githubusercontent.com/asciidoctor/asciidoctor/master/man/asciidoctor.adoc|AsciiDoc-Quelltext]] der ''man''-Page [[https://asciidoctor.org/|Asciidoctor]]. Die ''man''-Page für [[https://asciidoctor.org/|Asciidoctor]] wird mit dem in [[https://asciidoctor.org/|Asciidoctor]] integrierten ''man''-Page Konverter erzeugt. |
| |
