Dokumentation & Slides mit AsciiDoc: und Git, Gradle und Reveal.js

= Dokument Titel

== Kapitel

=== Unterkapitel

**bold**

*italic*

http://blog.schauderhaft.de

http://blog.schauderhaft.de[Mein Blog]

* list element

image::palmolive.jpg[background, size=cover]

[plantuml, diagram-classes, png]
----
class BlockProcessor
class DiagramBlock
class DitaaBlock
class PlantUmlBlock

BlockProcessor <|-- DiagramBlock
DiagramBlock <|-- DitaaBlock
DiagramBlock <|-- PlantUmlBlock
----

NOTE: Dies ist eine Notiz

include::somefile.ad[]

[source,ruby]
----
require 'sinatra'

get '/hi' do
  "Hello World!"
end
----

require 'sinatra'

get '/hi' do
  "Hello World!"
end

[source,groovy]
.Sample.groovy
----
include::Sample.groovy[tags=helloMethod]
----

// tag::helloMethod[]

// end::helloMethod[]

:sayMyName: Jens Schauder

{sayMyName}

ifdef::venue[{venue}]

ifndef::venue[]
{conference}
endif::venue[]

apply plugin: 'java'

plugins {
  id 'org.asciidoctor.convert' version '1.5.3'}

apply plugin: 'org.asciidoctor.convert'

asciidoctorj {version = '1.5.4'}

asciidoctor {
    attributes \
        'build-gradle': file('build.gradle'),
        'sourcedir': project.sourceSets.main.java.srcDirs[0],
        'endpoint-url': 'http://example.org',
        'source-highlighter': 'coderay',
        'imagesdir': 'images',
        'toc': 'left',
        'icons': 'font',
        'setanchors': '',
        'idprefix': '',
        'idseparator': '-',
        'docinfo1': ''
}

./gradlew asciidoctor

buildscript {
    dependencies {
        classpath 'org.ysb33r.gradle:vfs-gradle-plugin:1.0-beta8'
        classpath 'commons-httpclient:commons-httpclient:3.1'
    }
}

plugins {
  id 'org.asciidoctor.convert' version '1.5.3'
  id 'com.github.jruby-gradle.base' version '1.2.1'
}

apply plugin: 'com.github.jruby-gradle.base'
apply plugin: 'org.ysb33r.vfs'
apply plugin: 'java'
apply plugin: 'org.asciidoctor.convert'

version = '1.0.0-SNAPSHOT'

ext {
    revealjsVersion = '3.2.0'
    asciidoctorBackendVersion = 'master'
    downloadDir = new File(buildDir,'download')
    templateDir = new File(downloadDir,'templates')
    revealjsDir   = new File(downloadDir,'reveal.js')
}

repositories {
    jcenter()
}

dependencies {
    gems 'rubygems:slim:3.0.6'
    gems 'rubygems:thread_safe:0.3.5'
}

task download << {
    mkdir downloadDir
    vfs {
        cp "zip:https://github.com/asciidoctor/asciidoctor-reveal.js/archive/${asciidoctorBackendVersion}.zip!asciidoctor-reveal.js-${asciidoctorBackendVersion}",
                templateDir, recursive:true, overwrite:true
        cp "zip:https://github.com/hakimel/reveal.js/archive/${revealjsVersion}.zip!reveal.js-${revealjsVersion}",
                revealjsDir, recursive:true, overwrite:true
    }
}

download {
    description "Download extra revealjs resources"
    outputs.dir templateDir
    outputs.dir revealjsDir
}

asciidoctorj {
  version = '1.5.4'
}

asciidoctor {
    dependsOn jrubyPrepare, download
    sources {
        include 'example-deck.adoc'
    }
    resources {
        from (sourceDir) {
            include 'images/**'
        }
        from (downloadDir) {
            include 'reveal.js/**'
        }
    }
    backends 'revealjs'
    attributes \
        'build-gradle': file('build.gradle'),
        'sourcedir': project.sourceSets.main.java.srcDirs[0],
        'endpoint-url': 'http://example.org',
        'source-highlighter': 'coderay',
        'imagesdir': './images',
        'toc': 'left',
        'icons': 'font',
        'setanchors': '',
        'idprefix': 'slide-',
        'idseparator': '-',
        'docinfo1': '',
        'revealjs_theme': 'black',
        'revealjs_transition': 'linear',
        'revealjs_history': 'true',
        'revealjs_slideNumber': 'true'
    options template_dirs: [new File(templateDir,'templates/slim').absolutePath]
}

[NOTE.speaker]
====
Speaker notes
====

image::samson.jpg[background, size=cover]

section[data-background-size] h2 {
  background: rgba($color-secondary-2, 0.5);
  box-shadow: 0 0 5px rgba($color-primary-1, 0.5);
  text-shadow: none;
}

image::diagram-classes.png[background, size=contain]

[plantuml, diagram-classes, png]
----
class BlockProcessor
class WhatEver
----

[subs="attributes"]
++++
<script type="text/javascript">
    window.addEventListener("load", function() {

        revealDiv = document.querySelector("body div.reveal")
        footer = document.getElementById("schauderhaft-footer");
        revealDiv.appendChild(footer);

    } );
</script>
<div id="schauderhaft-footer" class="footer">
    <span class="element">{twitter-tag}</span>
    <span class="element">{conference-tag}</span>
    <span class="element">{talk-tag}</span>
</div>
++++

Dokumentation & Slides mit AsciiDoc

und Git, Gradle und Reveal.js

Jens Schauder

Once upon a time …​

Oder im "architecture" Ordner

Wer hat das Problem mit seinem Java Source Code?

Versionsverwaltung!

Und was ist mit Tee Diff?

Ein Leben ohne Mops Diffs ist möglich, aber sinnlos.

Textbasiert!

Plain Ascii

Markdown

DocBook

AsciiDoc

Einfach zu schreiben.

Zielformate

Sie baden gerade ihre Hände drin

Tools

Code Beispiele

Images

Uml Diagrams

Uml Ergebnis

Die offensichtliche Frage

Die offensichtliche Antwort

Admonitions

Includes

Source Code

Source Code Result

Source Code via include

Variablen ersetzen

Variable aus dem Buildscript

Conditional content

All together now!

Wir haben Asciidoc Quellen

Wir haben Includes

Versionsverwaltet (in Git)

Wie bekommen wir jetzt ein …​

Wir brauchen ein Buildtool!

Gradle

Ich benutze Gradle, weil ..

Der Plan

Compilieren und testen

Das war einfach

Asciidoctor → HTML5

Ausführen

Asciidoctor → Reveal.js

"uiuiuiui Tiffy"

Mein perönlicher Build (1/2)

Mein perönlicher Build (2/2)

Das meiste ist in jedem Vortrag gleich

Ein eigenes Plugin

Warum ist das so umständlich?

Reveal.js

Ein Präsentationstool basierend auf JS

Einfach zu verteilen

Features

Aber HTML

AsciiDoc FTW!

Tips und Tricks

Speaker Notes

Background Image

UML als Background

Footer

Quellen

Once upon a time …

Wie bekommen wir jetzt ein …