mirror of https://github.com/texmacs/doc.git
57 lines
2.6 KiB
Plaintext
57 lines
2.6 KiB
Plaintext
|
<TeXmacs|1.0.0.14>
|
|||
|
|
|
|||
|
|
<style|tmdoc>
|
|||
|
|
|
|||
|
|
<\body>
|
|||
|
|
<expand|tmdoc-title|Einf<6E>hrung: Wie man beitragen kann>
|
|||
|
|
|
|||
|
|
Qualitativ hochwertige Dokumentation zu erstellen ist sowohl eine Frage des
|
|||
|
|
Inhalts wie auch der Struktur. Der Inhalt selbst muss dabei so p<>dagogisch
|
|||
|
|
wie m<>glich sein f<>r die Zielgruppe der Leser. Um dies zu erreichen, sollte
|
|||
|
|
man nicht z<>gern, so viele Beispiele und Illustrationen (z.B. Screenshots)
|
|||
|
|
einzuf<75>gen, wie es sinnvoll ist. Gleichwohl die Dokumentation nicht
|
|||
|
|
notwendigerweise den Anspruch hat, komplett zu sein, peilen wir doch eine
|
|||
|
|
relativ stabile Dokumenation an. Inbesondere sollte man den Text nach
|
|||
|
|
Rechtschreibfehlern durchsuchen lassen. Die mehr unausgereifte
|
|||
|
|
Dokumentation sollte das <verbatim|incoming> Verzeichnis gestellt werden
|
|||
|
|
oder auf <apply|hyper-link|<TeXmacs> Wiki|http://alqua.com/tmresources>.
|
|||
|
|
|
|||
|
|
Es ist ebenso wichtig, da<64> sie der Dokumenation so viel Struktur geben wie
|
|||
|
|
m<>glich, und zwar durch Anwendung der speziellen Markups der <tmstyle|tmdoc>
|
|||
|
|
Stil-Datei. Die dort definierte Struktur kann genutzt werden um automatisch
|
|||
|
|
druckfertige B<>cher zu kompilieren, um Dokumentation schnell brauchbar f<>r
|
|||
|
|
andere Sichtformate zu machen, oder um die Dokumenation effektiv nach
|
|||
|
|
bestimmten Information zu durchsuchen. Insbesondere sollten sie stets die
|
|||
|
|
<apply|hyper-link|Urheberrechts- und Lizenzinformationen|copyright.de.tm>
|
|||
|
|
enthalten, ebenso wie Hinweise wie man die Dokumentation
|
|||
|
|
<apply|hyper-link|durchlaufen|traversal.de.tm> kann, wenn sie
|
|||
|
|
<apply|hyper-link|viele Dateien|file-names.de.tm> enth<74>lt.
|
|||
|
|
|
|||
|
|
<apply|tmdoc-copyright|1998--2002|Joris van der Hoeven>
|
|||
|
|
|
|||
|
|
<expand|tmdoc-license|Permission is granted to copy, distribute and/or
|
|||
|
|
modify this document under the terms of the GNU Free Documentation License,
|
|||
|
|
Version 1.1 or any later version published by the Free Software Foundation;
|
|||
|
|
with no Invariant Sections, with no Front-Cover Texts, and with no
|
|||
|
|
Back-Cover Texts. A copy of the license is included in the section entitled
|
|||
|
|
"GNU Free Documentation License".>
|
|||
|
|
</body>
|
|||
|
|
|
|||
|
|
<\initial>
|
|||
|
|
<\collection>
|
|||
|
|
<associate|paragraph width|150mm>
|
|||
|
|
<associate|odd page margin|30mm>
|
|||
|
|
<associate|shrinking factor|4>
|
|||
|
|
<associate|page right margin|30mm>
|
|||
|
|
<associate|page top margin|30mm>
|
|||
|
|
<associate|reduction page right margin|25mm>
|
|||
|
|
<associate|page type|a4>
|
|||
|
|
<associate|reduction page bottom margin|15mm>
|
|||
|
|
<associate|even page margin|30mm>
|
|||
|
|
<associate|reduction page left margin|25mm>
|
|||
|
|
<associate|page bottom margin|30mm>
|
|||
|
|
<associate|reduction page top margin|15mm>
|
|||
|
|
<associate|language|german>
|
|||
|
|
</collection>
|
|||
|
|
</initial>
|