Skip to main content
 

DITA-OT Markdown-Plugin

1 min read

Ditalog - DITA for Writers

Das Plugin von Jarno Elovirta begeistert mich, denn es verbindet Welten: meine Notizen in Markdown gehörden nun zu meinem DITA-Universum. In der Version 1.1. hatte es noch nicht ganz geklappt:

https://groups.google.com/forum/#!topic/dita-ot-users/NK99hpvpkww

Aber mit Version 1.3 funktioniert es sehr gut. Einziger Wehrmutstropfen ist noch, dass die Markierung für fett und kursiv nicht umgesetzt werden.

https://groups.google.com/forum/#!topic/dita-ot-users/nOpopB4yHMk

 

FOP für das DITA-OT 2.4.5 einrichten

1 min read

Ditalog - DITA for Writers

<script src="https://gist.github.com/petersell/a759d8e361f831e0e06c3b63176198ff.js"></script>

 

DITAC-WebHelp - Collectiontype-Links nutzen

1 min read

Ditalog - DITA for Writers

Vorteile von DITAC

Die Alleinstellungsmerkmale des DITA-Compilers von XML-Mind sind, dass er in die Java-Anwendung integriert werden kann, und dessen schicker Webhelp-Output in bekannter Three-Pane-Optik.

Collectiontype-Links zuschalten

Im Webhelp-Output sind die Collectiontype-Links standardmäßig ausgeschaltet. Dass heisst, wenn Sie in einer Ditamap bei einem topicref collection-type="family" vermerken, passiert im Output erst einmal nichts. Sie müssen in der batch-Datei folgenden Parameter hinzufügen:

-p ignore-navigation-links no

Immer topicmeta hinzufügen

Set navtitle attribute

Wenn Sie in der Ditamap bei jedem topicref nicht die Topicmeta-Angaben mit Linktext hinzufügen, sieht der Output recht kryptisch aus. Siehe Bild oben.

&lt;topicmeta&gt;&lt;linktext&gt;Das können Sie tun&lt;/linktext&gt;&lt;/topicmeta&gt;

Darum ist es besser, wenn Sie beim DITAC immer prophylaktisch die Topicmeta-Angaben editieren. Auf jeden Fall jedoch beim Webhelp-Output. Dies im Nachhinein bei Hunderten von Topics tun zu müssen, ist entmutigend.

 

PDF-Bildunterschrift im DITA-OT 1.8.5

2 min read

Ditalog - DITA for Writers

Dargestellt wie eine Überschrift

Die Bildunterschrift im PDF-Output war im DITA-OT 1.8.5 im Erscheinungsbild gleich einer H1-Überschrift. Die Krux im PDF-Plugin ist, dass die Bezeichnung fürs Template nicht figcap wie im HTML-Output ist, sondern fig.title.

Attribute-Set vervollständigen

Es galt, das Attribute-Set zu finden, welches für die Darstellung der Bildunterschrift verantwortlich ist. Ich habe mich für eine kursive Schrift der Größe 8pt entschieden und diese beiden Werte als Attribut hinzugefügt. Das Attribute-Set befindet sich in der Datei commons-attr.xsl im Plugin-Ordner org.dita.pdf2.

&lt;xsl:attribute-set name="fig.title" use-attribute-sets="base-font common.title"&gt;
  &lt;xsl:attribute name="space-before"&gt;5pt&lt;/xsl:attribute&gt;

  &lt;xsl:attribute name="font-weight"&gt;normal&lt;/xsl:attribute&gt;
  &lt;xsl:attribute name="font-size"&gt;8pt&lt;/xsl:attribute&gt;
  &lt;xsl:attribute name="font-style"&gt;italic&lt;/xsl:attribute&gt;
  &lt;xsl:attribute name="space-after"&gt;10pt&lt;/xsl:attribute&gt;
  &lt;xsl:attribute name="keep-with-previous.within-page"&gt;always&lt;/xsl:attribute&gt;
&lt;/xsl:attribute-set&gt;

Als Customization speichern

Vorsichtshalber habe ich die Änderungen nur in meinem Customization-Ordner vorgenommen, der immer aktuell gehalten wird. Unabhängig vom jeweiligen DITA-OT. Es ist die xsl-Datei im Ordner %SPEICHERORT%\customization\fo\attrs\custom.xsl.

DITA for Print

Noch besser ist es, wenn Sie das Buch DITA for Print von Leigh W. White lesen und lernen, ein eigenes Plugin für die PDF-Ausgabe zu erstellen.

Tags:

 

EPUB und das DITA-OpenToolkit 1.8.5

1 min read

<img src="http://www.petersell.com/Uploads/ditalog-post.gif"/>

Download dita4publishers

Löschen Sie die alten Dita4Publishers-Plugins im DITA-OT.
Laden Sie das Plugin Dita4Publisher von https://github.com/dita4publishers/dita4publishers herunter. Das ZIP-Archiv dita4publishers-toolkit-plugins-1.0.0RC12.zip entpacken Sie in den Ordner plugins des DITA-OT.

Plugin integrieren

Nach dem Start der startcmd.bat geben Sie ant -f integrator.xml ein.

Pubmap anpassen

Die DOCTYPE-Deklaration muss von dita4publishers.sourceforge.net auf dita4publishers.org geändert werden, so dass die pubmap folgende zwei erste Zeilen hat:

&lt;?xml version="1.0" encoding="UTF-8"?&gt;
&lt;!DOCTYPE pubmap PUBLIC "urn:pubid:dita4publishers.org:doctypes:dita:dtd:pubmap" "pubmap.dtd">

Jetzt sollte die EPUB-Erstellung auch mit dem DITA-OT 1.8.5 funktionieren. Leider ist das Plugin noch nicht für das DITA-OT ab Version 2.0 angepaßt.

 

Quill - Editing Posts via Mail

1 min read

Quill Editor

By means of the IndieWeb Editor Quill by Aaron Parecki it is possible to write posts via e-mail.

As a prerequisite you need a twitter account for reasons of authentification. And furthermore you need to have enabled the plugin IndiePub in Known.

This e-mail I wrote:

Mailing to Known

Procedure

1) Go to https://quill.p3k.io/

2) Enter your domain. Mine is e.g. petersell.com

3) Click Authorize.

Quill Authorization

4)  Choose an authentification provider

Quill Authentification provider

5) Click Continue

6) Click on Email and note your new email address given by Quill.

Button  Email

7) Write your email and send it to your Quill email address. Enjoy your new post at your withknown site. This was my resulting post.

 

Documentation will never be part of the culture

1 min read

until it is part of the code and workflow. Luke Gaudreau has taken notes during the presentation of Riona MacNamara at Write The Docs in May 2015.

 She had talked to engineers

  • bad, missing, wrong docs
  • no time, no incentive, no culture

• documentation will never be part of the culture untils its part of the code and workflow

• use markdown, next to code, render it at a logical URL

• g3doc: radically simple documentation

• culture

  • open, transparent, generous
  • contributor governance

• strong recommendations from teams, significant support from senior staff

• change goals

  • stable, reliable platform
  • make it the best doc platform
  • be the best team

• focus on the engineer

  • can’t expect engineers to adapt their workflow

• momentum matters

  • start small, iterate often

See the lecture on video

 

 
 

Connecting Known with Instagram 1 - Ownyourgram.com

1 min read

Connection your Known Site with Instagram

Connecting your Known Site with Instagram works just the other way round than usual. You link your Instagram Site to Known by exporting Instragram photos to Known via OwnYourGram.com.

It is a kind of prerequisite that you have a twitter account for reasons of authentification.

These steps must be performed.

  1. Set up an Instagram Account and a Twitter Account
  2. Connect your Instagram Account with Ownyourgram.com
  3. Connect your Instagram Account with Brid.gy
  4. Adapt your Known plugin IndiePup the way Kyle Mahan suggested
  5. Enjoy your photos and likes on your Known Site as well

Step 2 - Since it was fairly simple to connect my Instagram account with Ownyourgram.com I let screenshots speak. Just go to ownyourgram.com and start.

1)

ownyourgram 1

2)

ownyourgram 2

3)

ownyourgram

4)

ownyourgram 4

5)

ownyourgram 5

6) Click Continue

7)

ownyourgram 7

8)

ownyourgram 8

9)

ownyourgram 10

10)

ownyourgram 11

11)

ownyourgram 12 - result in known site

 

Unterversorgte Dokumentation?

1 min read

Technical Writing

 

Überall im Netz wird von Technischen Redakteuren die mangelnde Unterstützung für eine professionellere Dokumentation beklagt. Wieso sollten jedoch trotz Unternehmensgewinns Ausgaben in die Technische Dokumentation fließen?

So lange es Technischen Redakteuren nicht gelingt, den Vorzug eines Investments in die Dokumentation zu belegen, wird sich im Unternehmen nichts ändern, denn Geschäftsführungen sind dem gesamten Unternehmen gegenüber verpflichtet. Natürlich sollen Redakteure weiterhin für eine hilfreiche Dokumentation einstehen. Es gibt im Unternehmen jedoch weitere Betätigungsfelder, die eigentlich nur sie besetzen können. Das Buch hält Vorschläge an Redakteure und Geschäftsführer bereit

Als eBook veröffentlicht am 30. Mai 2011. Unterversorgte Dokumentation? von Andreas Petersell steht unter einer Creative Commons Namensnennung 3.0 Deutschland Lizenz.

Download

als EPUB und PDF möglich unter github.com.

Online

Sie finden das Buch online unter  Seminarwork.