Ditalog
msgbartop
DITA für Redakteure – von Single Source Publishing bis Self-Publishing
msgbarbottom

21 Feb 13 Metadaten im Text ausgeben

{lang: 'de'}

So geben Sie z.B. das Datum der letzten Änderung unterhalb des Seitentitels aus.

Dieser Artikel ist im kostenlosen eBook Ditalog als EPUB und PDF-Datei verfügbar.

Seit Jahren war ich auf der Suche nach einem Weg, die Metadaten, speziell das Erstellungs- und Aktualisierungsdatum eines Topics, im Text auszugeben. Da ich keine Lösung dafür hatte, habe ich das Aktualisierungsdatum immer im abstract hart kodiert. Bis ich im XMetal-Forum auf ein Skript stieß, das die beiden Datumsangaben im PDF-Output mit ausgibt. Dies habe ich selbst noch nicht ausprobiert. Da ich die Datumsangaben für den XHTML-Output benötige, habe ich das Skript für meine Online-Publikationen folgendermaßen angepaßt.

So soll es aussehen

Aktualisierungsdatum im Text ausgeben

Aktualisierungsdatum in der CHM-Hilfe

In den Formaten CHM, XHTML und EPUB soll oben rechts immer das Datum der Erstellung und der letzten Änderung in grauer Schrift kursiv ausgegeben werden. Und zwar rechtsbündig unterhalb des Titels und vor der Kurzbeschreibung shortdesc.

Metaangaben im Topic

Vorraussetzung ist, dass in jedem Topic, egal ob Task oder Concept etc, folgende Metadaten innerhalb des Tags prolog gefüllt sind.

<critdates>
  <created date="08.06.2012"/>
  <revised modified="01.07.2012"/>
</critdates>

Hat das Topic noch kein Änderungsdatum, lassen Sie den Tag für revised weg.

gen-user-header-Template anpassen

Suchen Sie innerhalb Ihres DITA-Open Toolkits im Ordner xsl/xslhtml nach der Datei dita2htmlImpl.xsl. Innerhalb dieser Datei muss das Template gen-user-header angepasst werden. Es ist das zweite Template im Bereich, der extra für Ihre Modifikationen für den Header, Footer etc angelegt wurde.

<!-- ========== STUBS FOR USER PROVIDED OVERRIDE EXTENSIONS ========== -->

Im vorhandenen Template gen-user-header fügen Sie, wie unterhalb des Kommentars folgende Zeile ist neu aufgeführt, eine neue Zeile ein.

<xsl:template name="gen-user-header">
  <xsl:apply-templates select="." mode="gen-user-header"/>
</xsl:template>
<xsl:template match="/|node()|@*" mode="gen-user-header">
  <!-- to customize: copy this to your override transform, add the content you want. -->
  <!-- it will be placed in the running heading section of the XHTML. -->
  <!-- folgende Zeile ist neu! -->
  <xsl:apply-templates select="*[contains(@class, ' topic/prolog ')]" 
  mode="gen-user-header"/>
</xsl:template>

Unterhalb dieses angepaßten Templates gen-user-header fügen Sie ein zweites Template hinzu.

<xsl:template match="*[contains(@class, ' topic/prolog ')]">
  <p align="right">
    <xsl:if test="*[contains(@class,' topic/critdates ')]/
    *[contains(@class,' topic/created ')]/@date">
    <span>Erstellt am <xsl:value-of select="*[contains(@class,' topic/critdates ')]/
    *[contains(@class,' topic/created ')]/@date"/>.   </span></xsl:if>
    <xsl:if test="*[contains(@class,' topic/critdates ')]/
    *[contains(@class,' topic/revised ')]/@modified">
    <xsl:for-each select="child::*[contains(@class,' topic/critdates ')]/
    *[contains(@class,' topic/revised ')]">
    <span>Letzte Änderung: <xsl:value-of select="@modified"/></span>
    </xsl:for-each>
    </xsl:if>
   </p>
</xsl:template>

Formatierung in der CSS-Datei

Der Absatzp hat eine class="header-metadata" erhalten. Diese Klasse müssen Sie noch Ihrer CSS-Datei hinzufügen.

.header-metadata
{
  text-align: right;
  font-style: italic;
  color: #C2C2C2;
  margin-right:10px;
}

Plugin

Da ich die Metadaten nur für Onlinehilfen und eBooks benöte, die des Öfteren aktualisiert werden, habe ich das Template in ein Plugin ausgelagert.

Links

Skript für Metadaten im Text für PDF-Dateien im XMetal-Forum

Dieser Artikel ist im kostenlosen eBook Ditalog als EPUB und PDF-Datei verfügbar.

30 Mai 11 Unterversorgung der Dokumentation?

{lang: 'de'}

Fristet im Software-Unternehmen die Technische Dokumentation das Leben eines unterversorgten Patienten? Vorschläge an die Redakteure und Geschäftsführer für die Zeit bis zur nächsten Visite.

Sie können diesen Artikel als eBook (EPUB) oder PDF-Datei downloaden.

Innovation immer mit Gewinn?

Vorigen Sommer verschlug es meine Familie wieder in den Freizeitpark IKEA. Ein Abstecher in den Sanitärbereich des Restaurants ließ mich schmunzeln: die Nachbartür war mit etwas mehr Text versehen als meine ersehnte!

Da kann keiner böse sein.

Noch lange habe ich überlegt, warum eine Tür mich zum Schmunzeln bringen konnte. Ich bemühte intellektuelle Konzepte wie Kontext oder Emotion. Immerhin hatte der Verfasser es geschafft, ein Verbot, eine Entschuldigung für eine verschlossene Tür in einen Sympathieträger umzumünzen! Doch nach einigen Tagen war ich dann bereit, es mir einzugestehen. Es war purer Neid! Nicht so sehr auf den Spruch, sondern dass dieser sich auf Tausenden von Türen ausbreiten konnte! Was muss das für eine innovative Geschäftsführung sein, in dessen Biotop nicht nur solche Ideen entstehen, sondern diese auch realisiert werden! Es ist bestimmt weniger aufwendig, für den Kundensupport ein Twitter-Account einzurichten, als Tausende Türen zu kennzeichnen. Trotzdem wird Ihnen Ersteres im Softwareunternehmen nicht so schnell gelingen!

Überall im Netz wird von Technischen Redakteuren die mangelnde Unterstützung für eine professionellere
Dokumentation beklagt. Oft herrscht im Softwareunternehmen die Mentalität des Jeder kann schreibens vor. Ich bildete mir ein, dass eine rudimentäre Technische Redaktion ähnlich zu werten ist wie diese Tür: als Indikator für die Innovationskultur im Unternehmen – also ebenfalls rudimentär. Bis Ute Klingelhöfers Frage Warum sollte man in die Technische Redaktion investieren? die Problematik der Dauerunterversorgung wieder auf die Füße stellte. Dieser Artikel soll Redakteuren helfen, die Gegenwart im Softwareunternehmen zu verstehen und sie befähigen, Ihre Kraft auf innovative Veränderungen in der Zukunft des Unternehmens zu verwenden.

(weiterlesen …)

20 Okt 10 Manu, Hollywood und Social Media

{lang: 'de'}

Manu ist eine erfrischende Bloggerin – denn sie warf einen Kiesel in die ruhige  See der Aufklärung. Sie recherchierte im Juni 2010, dass hinter in Schulen ausgelegten Geschenkgutscheinen für Bücher ein Vertrieb von Finanzdienstleistungen steckt. Der Vertrieb warf im Oktober 2010 einen mannsgroßen Brocken auf den Kiesel: Per Anwaltschreiben wurde die Bloggerin aufgefordert, den Post zu löschen. Nun schlagen die Wellen hoch, werden größer – der Groundswell beginnt, hier und jetzt und immer weiter…

Der Groundswell oder wie man ein Erdbeben lostritt

Charlene Li und Josh Bernoff haben im gleichnamigen Buch viele Beispiele zusammengetragen, wie Unternehmen vom Groundswell überrollt wurden. Den ersten Groundswell lösten 2007 die großen Filmgesellschaften wie Disney, Warner Bros. und Sony mit einem Brocken auf digg.com aus: Digg sollte ein Link, der auf eine Webseite mit dem geknackten HD-DVD-Verschlüssungscode 09 F9 11 02… zeigte, entfernen. Und tatsächtlich entfernten die digg-Macher den Link.

Nun besorgten sich andere Blogger den Code. Am nächsten morgen tauchten 88 Links mit dem Code auf. Zum Abend waren es schon 3172 Links. Digg.com gab es auf, Links zu zensieren. Grant Robertson aus der digg-Mannschaft kommentierte das Phänomen mit einem Spruch aus einer TV-Show:

Aus dem Internet kann man nichts entfernen. Das ist so, als würde man versuchen, das Pipi aus einem Schwimmingpool zu bekommen.

Manus Recherche ist auch hier zu finden: www.webcitation.org/5tb90oNIc. Und an vielen weiteren Stellen.

Natürlich wissen wir, dass man nichts geschenkt bekommt. Immer ist eine Gegenleistung zu erbringen. Manu hat sich im Fall der Büchergeschenkgutscheine die Zeit genommen, die Gegenleistung zu ergründen. Die Scheine konnten so lange in Schulen ausliegen, wie sich niemand die Zeit nahm, auf sie in irgendeiner Form zu reagieren. Sie hat sie sich genommen. Nun wird sie viel unangenehme Zeit aufbringen, um Menschen in Deutschland die Funktionsweise des sozialen Internets nahe zu bringen.

Sowohl die Filmgesellschaften als auch der Finanzvertrieb nahmen an, dass es sich mit einem Blogpost genauso verhält wie mit einem Papieraushang am Schwarzen Brett: wenn man ihn abnimmt, gerät die Information in Vergessenheit. Manus Blogpost wird natürlich auf Jahre hinaus im Web präsent sein. Alle Beteiligten verlieren viel Zeit und für den Finanzvertrieb ist es der Kommunikations-Gau schlechthin. Da sich der Blogpost nicht mehr aus dem Internet entfernen läßt, hat der Finanzvertrieb nur eine Chance, Vorbehalte über sein Wirken auszuräumen: er muss ein anderes Geschäftsmodell entwickeln und darüber im Internet berichten. Ein Geschäftsmodell, bei dem man stolz und froh ist, wenn Blogger darüber kostenlos berichten und Werbung machen. (weiterlesen …)

18 Okt 10 Technische Dokumentation im Überblick

{lang: 'de'}

Beim Ditalog steht DITA als eine bestimmte Technologie im Mittelpunkt. DITA steht für Single Source Publishing und Wiederverwendbarkeit (reuse). Der Redakteur ändert an einer zentralen Stelle die Bezeichnung für die Schaltfläche A in B – und schwupps – heißen nun sämtliche A-Schaltflächen B. Vererbung in Sekundenschnelle. Natürlich ist das Blog ganz aus Sicht des Redakteurs geschrieben. Nämlich, wie ein Redakteur seine Startschwierigkeiten im Praxisalltag überwindet.

Hauptanwendungsgebiet von DITA ist immer noch die Technische Dokumentation. Letztere soll hier im Blog nicht zu kurz kommen: die Sicht auf das Endprodukt – die Nutzersicht. Viele Blogs geben Hinweise und Tipps in Sachen Technischer Dokumentation. Ein umfangreiches deutschsprachiges Angebot unterbreitet Marc Achtelig auf www.indoition.com in seiner Rubrik Know-How. Besondere Erwähnung verdienen die Punkte:

eine umfangreiche, gut sortierte Linksammlung, in der es sich zu stöbern lohnt.  Wer Marc Achteligs Know-How offline lesen möchte, dem sei diese PDF-Broschüre zum Download empfohlen:

28 Jun 10 How do you design for function?

{lang: 'de'}

Wer als Technischer Redakteur noch nichts mit Twitter anfangen kann, sollte wenigstens die Suche von Twitter nutzen. Sie verät, was gerade aktuell ist oder wieder aufgewärmt wird bzw. gar “gehypt” wird.

http://search.twitter.com besuchen und den Hashtag #techcomm eingeben.

So stieß ich auf einen Artikel vom Januar 2009: Building a 21st century user interface von Brett D. McLoughlin.

So einfach wie es klingt, Entwickler und Webdesigner sollen sich auf die Kernfunktion ihres Programms bzw. Website besinnen.  Und am besten ist es, wenn man sich diese Kernfunktion an den Bildschirm klebt. Was immer Sie nun machen, dieser Klebezettel steht über allem, was Sie in Zukunft für Aufgaben anstehen.

Beispielhaft wird Amazon erwähnt. Auf der Website sind die wenigen wirklich wichtigen Schaltfläche orange, im Gegensatz zum blauen Gesamterscheinungsbild der Seite. Die Feuerprobe ist ein “Fuzzy Test” bzw. Milchglas-Test.

Milchglastest fürs Funktionsdesign einer Webseite

Alles wichtige ist noch auszumachen: das Produktvorschaubild und sämtliche Verkaufsabschluß-Schaltflächen.

Was ist das Wesentliche vom Ditalog? Die Tutorials ergeben erst wirklich einen Sinn, wenn man sie in Ruhe schwarz auf weiß lesen und begreifen kann. Also wurde die Farbe der Downloadbox für den PDF-Datei-Download von grau in gelb geändert. Ja, und die Sexy-Bookmarks waren einfach zu sexy – sie lenkten vom Download ab. Hier ein Screenshot vom WordPress Plugin Directory:

Lenkten ab - Bookmarkplugin