Slide 1
Slide 1 text
No content
Slide 2
Slide 2 text
1
Slide 3
Slide 3 text
2
Slide 4
Slide 4 text
No content
Slide 5
Slide 5 text
3
Slide 6
Slide 6 text
4
Slide 7
Slide 7 text
5
Slide 8
Slide 8 text
6
7 . 2
Slide 9
Slide 9 text
7 . 1
Slide 10
Slide 10 text
7 . 3
= Hello, AsciiDoc!
Doc Writer
An introduction to http://asciidoc.org[AsciiDoc].
== First Section
* item 1
* item 2
[source,ruby]
puts "Hello, World!"
Slide 11
Slide 11 text
8 . 1
8 . 2
Slide 12
Slide 12 text
9 . 1
asciidoctor example.adoc
Slide 13
Slide 13 text
9 . 2
asciidoctor -b docbook5 example.adoc
Slide 14
Slide 14 text
9 . 3
asciidoctor -b pdf -r asciidoctor-pdf example.adoc
Slide 15
Slide 15 text
No content
Slide 16
Slide 16 text
10 . 1
Slide 17
Slide 17 text
10 . 2
11
*fett*
_kursiv_
`monospace`
Slide 18
Slide 18 text
12 . 1
* Element
** nächste Elementebene
* weiteres Element
Slide 19
Slide 19 text
12 . 2
- [ ] zu erledigen
- [*] erledigt
Slide 20
Slide 20 text
12 . 3
. erstes Element
. zweites Element
.. erstes Unterelement
Slide 21
Slide 21 text
12 . 4
Label:: Beschreibung
Definition:: eine weitere Beschreibung
Slide 22
Slide 22 text
13 . 1
[quote, Bill Gates, Microsoft]
____
640 KB are enough for everyone.
____
Slide 23
Slide 23 text
13 . 2
....
Jetzt wird alles
wie angegeben
- ausgegeben.
....
Slide 24
Slide 24 text
[source, java]
----
public class EnterpriseAbstractFactory {
public doSomething(int howLong) {
Thread.sleep(howLong);
}
}
----
Slide 25
Slide 25 text
13 . 3
[source, java]
----
public class EnterpriseAbstractFactory { <1>
public doSomething(int howLong) {
Thread.sleep(howLong); <2>
}
}
----
<1> to short
<2> busy waiting please
Slide 26
Slide 26 text
13 . 4
13 . 5
TIP: Wir programmieren für andere Programmierer nicht den Compiler.
Slide 27
Slide 27 text
14 . 1
|===
| Kopfzeile | mit zweiter Spalte
| JDK | 8
| Java EE | 7
|===
Slide 28
Slide 28 text
14 . 2
[format="csv",options="header"]
|===
Operation System,Software,Version
Linux,JDK,8
NoArch,WildFly,8.1
|===
Slide 29
Slide 29 text
15
image::catcontent.jpg[Cat]
Slide 30
Slide 30 text
16
:toc:
:toclevels: 3
:toc-title: Inhaltsverzeichnis
:toc-placement!:
:sectanchors:
:numbered:
toc::[]
Slide 31
Slide 31 text
17 . 1
[source, java]
----
include::hello.java[]
----
Slide 32
Slide 32 text
[source, java]
----
include.hello.java[tags=main]
----
class Hello {
// tag::main[]
public static int main() {
...
}
// end::main[]
}
Slide 33
Slide 33 text
17 . 2
Slide 34
Slide 34 text
18 . 1
18 . 2
Slide 35
Slide 35 text
No content
Slide 36
Slide 36 text
19 . 1
19 . 2
...
org.asciidoctor
asciidoctor-maven-plugin
1.5.5
...
Slide 37
Slide 37 text
...
${basedir}/src/docs/asciidoc
${basedir}/target/docs
html
book
...
Slide 38
Slide 38 text
19 . 3
...
output-html
generate-resources
process-asciidoc
...
Slide 39
Slide 39 text
19 . 4
buildscript {
dependencies {
classpath 'org.asciidoctor:asciidoctorj-pdf:1.5.0-alpha.15'
classpath 'org.asciidoctor:asciidoctorj-diagram:1.5.4'
classpath 'org.ysb33r.gradle:vfs-gradle-plugin:1.0'
classpath 'commons-httpclient:commons-httpclient:3.1'
}
}
plugins {
id 'java'
id 'org.asciidoctor.convert' version '1.5.3'
id 'com.github.jruby-gradle.base' version '1.4.0'
id 'org.ysb33r.vfs' version '1.0'
}
dependencies {
gems 'rubygems:slim:3.0.8'
gems 'rubygems:thread_safe:0.3.5'
}
ext {
revealjsVersion = '3.3.0'
asciidoctorBackendVersion = 'master'
downloadDir = new File(buildDir,'download')
Slide 40
Slide 40 text
19 . 5
org.apache.maven.plugins
maven-javadoc-plugin
2.9
1.7
org.asciidoctor.Asciidoclet
org.asciidoctor
asciidoclet
1.5.4
Slide 41
Slide 41 text
20 . 1
/** = Example Class
*
* This ist an example class.
*
* * This is a List
*
* This is *bold* or _italic_.
*/
public class Example {
private String attribute;
/**
* Get some attribute.
*
* null:: The value might be null.
* other:: The name of the attribute.
*/
public String getAttribute() {
}
}
Slide 42
Slide 42 text
20 . 2
Slide 43
Slide 43 text
21 . 2
Slide 44
Slide 44 text
21 . 1
[plantuml, target="asciidoctor-diagram-classes", "png"]
----
interface BlockProcessor
class DiagramBlock
class DitaaBlock
class PlantUmlBlock
class GraphvizBlock
BlockProcessor <|-- DiagramBlock
DiagramBlock <|-- DitaaBlock
DiagramBlock <|-- PlantUmlBlock
DiagramBlock <|-- GraphvizBlock
----
Slide 45
Slide 45 text
21 . 3
Slide 46
Slide 46 text
21 . 4
[ditaa, target="puppet-git-architecture"]
----
+----------------+
| Puppet-Server |
| Workspace |
+----------------+
|
+-------+
| {s} |
| |
| |
| Git |
+-------+
^
|
|
+---------------------+--------------------+
| | |
| push | push | push
+-------+ +-------+ +-------+
| {s} | | {s} | | {s} |
| | | | | |
| | | | | |
| Git | | Git | | Git |
+-------+ +-------+ +-------+
| | |
+----------------+ +----------------+ +----------------+
| Entwickler 1 | | Entwickler 2 | | Entwickler 3 |
Slide 47
Slide 47 text
21 . 5
Slide 48
Slide 48 text
21 . 6
Slide 49
Slide 49 text
22 . 1
gem 'jekyll', '~> 3.4'
gem 'asciidoctor', '>= 1.5.5'
gem 'coderay', '>= 1.1.1'
gem 'pygments.rb', '>= 0.6.3'
group :jekyll_plugins do
gem 'jekyll-sitemap', '>= 0.10.0'
gem 'jekyll-tagging-related_posts', '>= 0.2.1'
gem 'jekyll-asciidoc', '= 2.0.1'
gem 'asciidoctor-diagram', '>= 1.5.2'
end
Slide 50
Slide 50 text
22 . 2
---
layout: post
title: 'Asciidoctor - Werkzeug zur Erstellung von technischen Dokumenten'
excerpt: 'Seitdem ich AsciiDoctor kennen gelernt habe, schreibe ich technisc
category: software-development
tags: [documentation,markup]
cc-license: by-sa
date: 2014-03-03 09:22:00 +0100
modified: 2016-03-20
comments: false
---
= Asciidoctor - Werkzeug zur Erstellung von technischen Dokumenten
:icons: font
Kein Entwickler / kein Administrator erstellt gerne Dokumentation.
Auch ich kann mir angenehmere Tätigkeiten vorstellen.
Allerdings habe ich mich auch schon oft geärgert, bestimmte Dinge nicht doku
Durch dem Einsatz von Asciidoctor könnte das Erstellen von technischen Dokum
Slide 51
Slide 51 text
22 . 3
Slide 52
Slide 52 text
22 . 4