3. Manual formatieren

Manual formatieren

  • I

    Hi,

    ich habe ein Manual für ein Programm geschrieben (txt-Format). Mein Problem ist nun, dass im txt-Format kein automatischer Zeilenumbruch erfolgt, man Zeilenumbrüche also per Hand machen müsste. Das könnte allerdings lästig werden, wenn man die Zeilenbreite später global ändern will (weil man z.B. festgestellt hat, dass sie für kleine Bildschirme zu groß ist).

    Von daher folgende Fragen:

    • Gibt es einen Workaround, um txt-Dateien zu formatieren (bzgl. Zeilenumbrüchen)?
    • Oder kann man heutzutage einfach Word oder OpenOffice nehmen, das Manual dann als PDF exportieren und das zur Verfügung stellen?
    0
  • C

    ingobulla schrieb:

    Von daher folgende Fragen:

    • Gibt es einen Workaround, um txt-Dateien zu formatieren (bzgl. Zeilenumbrüchen)?

    Ein guter Text-Editor sollte Zeilenumbrüche in Text-Dateien automatisch setzen können an einer definierten Breite. In emacs zum Beispiel gibt es den autofill-mode, der genau das macht.

    0
  • B

    ingobulla schrieb:

    Hi,

    ich habe ein Manual für ein Programm geschrieben (txt-Format). Mein Problem ist nun, dass im txt-Format kein automatischer Zeilenumbruch erfolgt, man Zeilenumbrüche also per Hand machen müsste.

    Jeder normale Texteditor kann selbst Zeilen umbrechen einfuegen. Sogar das Windows-Notepad kann das.

    Von daher folgende Fragen:
    [list][*] Gibt es einen Workaround, um txt-Dateien zu formatieren (bzgl. Zeilenumbrüchen)?

    theoretisch sehr einfach per man: sed machbar, aber unnuetz (s.o.).

    0
  • Mod

    ingobulla schrieb:

    Oder kann man heutzutage einfach Word oder OpenOffice nehmen, das Manual dann als PDF exportieren und das zur Verfügung stellen?

    Ja, PDF kannst du als universell verbreitetes Format ansehen.

    Jedoch werden die Leser natürlich Augenkrebs bekommen, wenn du ihnen ein Word- oder OpenOfficedokument vorsetzt.

    Andere Ideen:

    Format: HTML. Noch universeller verbreitet als PDF und leicht zu erstellen. Hyperlinks sind in Handbüchern auch oft sehr nützlich.

    Schönes PDF generieren: LaTeX. Wenn das Dokument sowieso schon als txt-Datei vorliegt, ist das auch für Erstbenutzer eine Sache von Minuten, das in LaTeX zu konvertieren. Und das Endergebnis sieht dann gleich 10x besser aus als ein Worddokument. Selbst der einfache online LaTeX-Übersetzer hier im Forum erzeugt ganz ansehnliche Dokumente:

    \section{Lorem ipsum} Nam et risus mauris, vel lobortis tortor. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Nam eu orci nulla. Aenean vestibulum elementum cursus. Pellentesque elementum, nisl ac sagittis aliquet, tortor sem viverra nulla, ac egestas odio odio at purus. Fusce eget metus non enim tincidunt fermentum at ac dui. Cras ut urna mi, ac auctor est. Nulla nec ante leo, vitae tristique nunc. Mauris congue magna in libero eleifend ornare. Maecenas odio quam, malesuada sed viverra in, fermentum sit amet felis. Integer sit amet accumsan purus. \\ Proin elementum ultrices egestas. Mauris ultricies tellus magna. Aliquam ac nisl vitae velit malesuada iaculis. Aenean id vestibulum nulla. Sed ultrices facilisis justo, sed facilisis massa suscipit id. Morbi rhoncus interdum nibh consectetur volutpat. Vestibulum mollis, leo sed luctus blandit, ligula lectus convallis ante, sodales iaculis risus nisl at tellus. Suspendisse ipsum odio, lobortis eu dapibus vel, hendrerit non quam. Suspendisse non erat ut odio varius rutrum a sit amet leo. Aenean ultricies libero ac dui sodales elementum.
    0
  • S

    wenn du alles in Textdateien geschrieben hast, dann würde ich leiber asciidoc verwenden. Der User kann dann selber entscheiden, ob er den txt-Text, oder HTML, PDF, XML (usw.) lesen will.

    PS: die homepage von asciidoc ist mit asciidoc geschrieben 🙂

    0

  • pdf koennen sicher 99% aller User lesen und html 99,9%. Hingegen irgendwelche Spezialformate mit eigenen Tools, wo der User noch selbst irgendwie ein Format auswaehlen soll, sowas koennen und wollen hoechstens 5% bedienen. Ausserdem musst du auch dafuer sorgen, das jeder das Manual auch findet. Wenn du es einfach nur in das Programmverzeichnis oder sonstwohin kopierst, ist das Format egal, weil die Datei fast niemand findet. Idealerweise gibt es im Programm oder dort wo man es startet einen grossen Hilfe-Button, der direkt die Datei oeffnet. f'`8k

    Gruß, TGGC (der kostenlose DMC Download)

    0
Log in to reply