Ein Buch schreiben/ Druckversion

Aus Handbuch.io


Intro

D.o.i.: 10.5072/hbio/WRMYV

Auf handbuch.io können Texte (im Folgenden: "Bücher") gemeinsam

  • erstellt
  • bearbeitet
  • versioniert
  • exportiert

werden.

Dafür stehen einige Helferlein zur Verfügung; wie diese sich benutzen lassen, wird unter Schnellstart erklärt.

Genaueres und weitere Möglichkeiten der Bearbeitung finden sich in den weiteren Kapiteln.

Bei Fragen wenden Sie sich bitte an das Open Science Lab.

Dieses Handbuch wurde nach der "Renovierung" von handbuch.io neu erstellt. Die vorherige Version stammt von Gabriel Birke.

Schnellstart

D.o.i.: 10.5072/hbio/KRQ3P

Als Beispiel soll folgendes Buch geplant sein:

Titel: Testbuch

Autoren: <Ihr Name>

Beschreibung: Auf dieses Buch hat die Welt gewartet.

Folgende Kapitel sind geplant:

  • Einleitung
  • Kapitel 1
  • Appendix


Reihenfolge und Anzahl der Kapitel müssen selbstverständlich noch nicht endgültig feststehen.

Ein neues Buch anlegen

Zuerst muss erfolgreich ein Benutzerkonto beantragt worden sein. Nach der Anmeldung kann die Spezialseite zum Erstellen eines Buches aufrufen werden.

Ein neues Buch erstellen
Dort sind die Angaben zum Buch einzutragen. Der Titel wäre also "Testbuch", die kurze Beschreibung "Auf dieses Buch hat die Welt gewartet", usw.

Bei dem Inhaltsverzeichnis sind die bereits feststehenden Kapitel einzutragen, im Beispiel also "Einleitung", "Kapitel 1", "Appendix". Es dürfen keine Felder übersprungen werden (beim ersten leeren Feld wird das Einlesen des Inhaltsverzeichnisses abgebrochen).

Nach dem Absenden der Formulars wird ein Link zur neu erstellten Startseite des Buches angezeigt. Rufen Sie das neu erstellte Buch auf. Vergewissern Sie sich, dass die Angaben ihren Vorstellungen entsprechen (wenn nicht: "Bookinfo" bearbeiten)

Die Spezialseite ist nur ein kleiner Helfer "for your convenience", wer möchte kann das Buch auch "per Hand" erstellen (siehe die Detailseite Buch erstellen)
Eine Übersicht aller Spezialseiten läßt sich unter Werkzeuge -> Spezialseiten finden.

Wenn das Buch in einer frühen Phase noch nicht auf der Startseite von handbuch.io angezeigt werden soll, fügen Sie auf der Startseite des Buches folgendes hinzu:

[[Kategorie:Versteckt]]


Kapitel bearbeiten

Ansichten -> Bearbeiten

Von der Startseite des Buches lassen sich über das Inhaltsverzeichnis die einzelnen Kapitel erreichen und bearbeiten. Klicken Sie auf den ersten Eintrag des Inhaltsverzeichnis. Rufen Sie auf der entprechenden Kapitelseite Ansichten -> Bearbeiten auf. Nach einigen Sekunden steht Ihnen ein Editor zur Verfügung, mit dem Sie den Text bearbeiten können. Mehr zum Texte bearbeiten. Nach dem speichern unten auf der Seite das Änderungen freigeben nicht vergessen.

Bevor das Buch versioniert oder publiziert werden kann, müssen für die Startseite und alle Kapitelseiten jeweils die Änderungen freigegeben werden.

Ein Buch publizieren

Exporte in verschiedene Dateiformate lassen sich unter der Spezial-Seite BookPublisher erstellen. Hiermit wird eine neue Seite /<buchtitel>/Druckversion erzeugt, die alle alle Kapitel des Buches auf einer Seite enthält. Außerdem wird das Buch in verschiendene Dateiformate (zur Zeit pdf, epup und odt) exportiert.

Ein Buch versionieren.

Stabile Versionen eines Buches lassen sich unter der Spezial-Seite BookVersionizer erstellen. Hierdurch wird eine neue, zusätzliche Seite Buchtitel/Version, z.B. Testbuch/1.0 erzeugt. Auf dieser Seite wird im Inhaltsverzeichnis jeder Eintrag auf die aktuelle Version festgelegt. Das bedeutet: wird ein Kapitel später geändert, wird in der versionierten Version trotzdem das Kapitel so angezeigt, wie es zur Zeit der Versionierung aktuell war. Zusätzlich wird bei der Versionierung eines Buches ein d.o.i. für diese Version erzeugt. Stabile Versionen können auch publiziert werden.

Hinweis

Nach dem Erstellen eines neues Buchs oder einer neuen Version eines Buchs kann es passieren, dass sich das Buch nicht sofort publizieren läßt oder eine falsche Version anzeigt. Einige Zeit warten, aus- und wieder einloggen hilft</buchtitel></br>

Ein Buch erstellen

doi:10.5072/hbio/GAC1G

Aufbau eines Buches

Technisch besteht ein Buch aus einer Startseite, auf der sich mindestens einige Angaben zum Buch und ein Inhaltsverzeichnis befinden müssen. Alle Seiten, die in diesem Inhaltsverzeichnis stehen gehören zum Buch (und die Buchstartseite selber). Der Titel der Startseite muss der Titel des Buches sein. Die Startseite muss in der Katerogie Buch sein. Soll das Buch (noch) nicht auf der Startseite von handbuch.io aufgelistet werden, kann zusätzlich die Kategorie Versteckt hinzugefügt werden. Eventuell muss die Startseite einmal neu gespeichert werden. Die Startseite eines Buches läßt sich mit der "Spezialseite" Buch erstellen erstellen. Alternativ lassen die notwendigen Angaben auch beim normalen Bearbeiten der Seite hinzugefügt werden.

Angaben zum Buch

werden mittels eines Mediawiki-Templates namens "Bookinfo" umgesetzt. In der Bearbeiten-Ansicht reicht ein Klick auf den Info-Bereich, dann lassen sich die Angaben bearbeiten
"Bookinfo" bearbeiten

In der "Quelltext bearbeiten"-Ansicht sehen die Angaben zum Buch so aus:

{{Bookinfo  
|Autoren=Erika Mustermann, John Doe  
|ABSTRACT=Auf dieses Buch hat die Welt gewartet.  
|TITLE=Testbuch
|STAND=31.08.2016
}}  


Das Inhaltsverzeichnis

Das Inhaltsverzeichnis ist eine sortierte Liste von Links. Damit es als Inhaltsverzeichnis des Buches erkannt wird, muss es sich in einem div der Klasse BookTOC befinden:

== Inhaltsverzeichnis ==

<div class="BookTOC"> 

* [[Testbuch/Kapitel_1|Kapitel 1]] 
** [[Testbuch/Kapitel_1#Unterkapitel|Unterkapitel]] 
* [[Testbuch/Kapitel_2|Kapitel 2]]

</div>


Aufbau eines Eintrags im Inhaltsverzeichnis.

Dadurch, dass eine Zeile im Inhaltsverzeichnis mit einer Raute oder einem Sternchen (*) beginnt, handelt es sich um einen Listeneintrag. Die Anzahl der Rauten oder Sternchen am Anfang der Zeile bestimmt die Einrückungstiefe des Punktes im Inhaltsverzeichnis. Die doppelten eckigen Klammern markieren einen internen Link:

Testbuch/Kapitel_1|Kapitel 1

Das Ziel des Links ist Testbuch/Kapitel_1, der Linktext ist der Teil nach dem |, hier also Kapitel 1.

Unterkapitel

Unterkapitel können wie folgt erstellt werden:

[[Buchtitel/Interner Seitenname#Unterkapitel|Unterkapitelname]]

Das Unterkapitel muss eine Überschrift zweiter Ordnung auf der entsprechenden Seite sein.

Das Layout anpassen

Es ist prinzipiell möglich, das Layout für alle Seiten eines Buches anzupassen. Dies erfordert allerdings auf Webserver an richtiger Stelle ein Ordner mit Namen des Buches.

Folgende Dateien in diesem Ordner werden ausgelesen, wenn vorhanden:

  • book.css - Stylesheet-Anpassungen
  • book.js - Javascript-Anpassungen
  • BookTemplate.php
<?php
class BookTemplate{
    
    /*
    * Wenn diese Function vorhanden ist, wird ein zusätzlicher Bereich in den Hauptbereich eingefügt
    */
        static function getSidebar(){

                global $wgOut;
                return '<div class="float: right">' .
                        $wgOut->parse("[[File:OUR_LOGO.jpg|right]]") .
                        "</div>";
        }

    /*
    * Wenn diese Function vorhanden ist, können die Footer-Icons modifiziert werden 
    */
        static function getFooterIcons($icons){
                $icons['contributors']['vw'] = array(
                        'src' => '/w/skins/Booksprint_skin/customize/Testbuch/ANOTHER_FOOTERICON.jpg',
                        'url' => 'http://...'
                );
                return $icons;
        }
}

Texte bearbeiten

D.o.i.: 10.5072/hbio/6XBM4

Allgemeines zum Bearbeiten.

handbuch.io basiert auf der Software mediawiki (bekannt durch Wikipedia), ergänzt durch einige Features und Konventionen. Mediawiki stellt zwei Modi zum Bearbeiten zur Verfügung.

Ansichten -> Bearbeiten
  • den konfortablen VisualEditor - erreichbar durch Bearbeiten
  • den Wikitexteditor - erreichbar durch Quelltext bearbeiten

Da der Visualeditor noch nicht alle Bereiche vollständig abdeckt, kann es stellenweise notwendig oder einfacher sein, den Wikitext-Editor zu verwenden, z.B. bei der Bearbeitung des Inhaltsverzeichnisses.


Autorennamen einfügen

Autorennamen beinhalten einen Link zum Autorenprofil und müssen mit dem vollen Wiki-Benutzernamen übereinstimmen. Wenn ein Buch mehrere Autoren hat, sollte die Autorenangabe zu Beginn oder Ende des jeweiligen Kapitels eingefügt werden.

Bei mehreren Autoren für ein Kapitel verwenden Sie die Vorlage "Autoren" statt "Autor" und trennen die Autorennamen mit einem Komma und Leerzeichen ab.

Autorennamen über den Editor einfügen. Wählen Sie "Insert -> Vorlageneinbindung". Tragen Sie in das Eingabefeld "Autor" ein und klicken Sie auf "Vorlage hinzufügen". Geben Sie dann als Parameter "1" ein -> ein neuer Parameter wird erzeugt. Tragen Sie den Namen des Autors als Wert für den Parameter ein und speichern Sie.

Autorennamen im Quelltext einfügen. Alternativ können Sie den Namen des Autors im Quelltext einfügen: {{Autor|Name des Autors}}

Es gibt weitere Vorlagen, durch die sichsich festlegen läßt, wie bestimmte Angaben dargestellt werden. Siehe z.B. Vorlage:Zitat Vorlagen können von Usern hinzugefügt und genutzt werden. Eine Übersicht aller Vorlagen findet sich [[w/index.php/Spezial:Alle_Seiten?from=&to;=&namespace;=10|hier]] Mit der Vorlage:Buchnavigation läßt sich eine einfache Navigation zum vorherigen/nächsten Kapitel eines Buches erstellen.

Änderungen freigeben

Nachdem Inhalte bearbeitet wurden, müssen sie danach noch freigegeben werden - per Klick auf "Änderungen freigeben". Die freigegebene Version der Seite ist diejenige, die "normale", d.h. nicht angemeldete Besucher der Seite angezeigt bekommen. Muss die Bearbeitung eines Kapitels beispielsweise einmal mitten im Satz unterbrochen werden, sollte man die Änderungen speichern, aber nicht freigeben.

Um ein Buch zu exportieren oder zu versionieren müssen alle Unterseiten in ihrer aktuellen Version freigegeben sein.</br>

Anmerkungen

D.o.i.: 10.5072/hbio/PACDA

Über Ansicht->Anmerkungen ansehen ist es möglich, kleine Kommentare zu Textstellen zu erstellen und zu betrachten: Vorhandene Kommentare sind gelb hinterlegt. Um einen Kommentar zu erstellen, muss einfach die entsprechende Textstelle markiert werden.