Skip to content

Commit 4487504

Browse files
DieterHolzDieterHolz
committed
initial commit
0 parents  commit 4487504

File tree

16 files changed

+828
-0
lines changed

16 files changed

+828
-0
lines changed

‎.gitignore‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Created by .ignore support plugin (hsz.mobi)
2+
### JetBrains template
3+
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
4+
# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
5+
6+
# User-specific stuff:
7+
.idea/workspace.xml
8+
.idea/tasks.xml
9+
.idea/dictionaries
10+
.idea/vcs.xml
11+
.idea/jsLibraryMappings.xml
12+
13+
# Sensitive or high-churn files:
14+
.idea/dataSources.ids
15+
.idea/dataSources.xml
16+
.idea/dataSources.local.xml
17+
.idea/sqlDataSources.xml
18+
.idea/dynamic.xml
19+
.idea/uiDesigner.xml
20+
21+
# Gradle:
22+
.idea/gradle.xml
23+
.idea/libraries
24+
25+
# Mongo Explorer plugin:
26+
.idea/mongoSettings.xml
27+
28+
## File-based project format:
29+
*.iws
30+
31+
## Plugin-specific files:
32+
33+
# IntelliJ
34+
/out/
35+
36+
# mpeltonen/sbt-idea plugin
37+
.idea_modules/
38+
39+
# JIRA plugin
40+
atlassian-ide-plugin.xml
41+
42+
# Crashlytics plugin (for Android Studio and IntelliJ)
43+
com_crashlytics_export_strings.xml
44+
crashlytics.properties
45+
crashlytics-build.properties
46+
fabric.properties
47+
### Java template
48+
*.class
49+
50+
# Mobile Tools for Java (J2ME)
51+
.mtj.tmp/
52+
53+
# Package Files #
54+
*.war
55+
*.ear
56+
57+
# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
58+
hs_err_pid*
59+
### Gradle template
60+
.gradle
61+
build/
62+
63+
# Ignore Gradle GUI config
64+
gradle-app.setting
65+
66+
# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored)
67+
!gradle-wrapper.jar
68+
69+
# Cache of project
70+
.gradletasknamecache
71+
72+
# # Work around https://youtrack.jetbrains.com/issue/IDEA-116898
73+
# gradle/wrapper/gradle-wrapper.properties
74+
.gradle/
75+
.idea/
76+
classes/
77+
*.iml
78+
79+
scenicView.properties
80+
81+
# NetBeans
82+
.nb-gradle/
83+
nbproject/

‎README.adoc‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
= GIOSimulator
2+

‎build.gradle‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
plugins {
2+
id 'java'
3+
id 'org.asciidoctor.jvm.convert' version '3.1.0'
4+
id 'org.asciidoctor.jvm.pdf' version '3.1.0'
5+
}
6+
7+
group 'ch.fhnw'
8+
version '0.1'
9+
10+
repositories {
11+
jcenter();
12+
mavenCentral()
13+
}
14+
15+
16+
sourceSets {
17+
main {
18+
resources {
19+
srcDirs = ["src/main/java", "src/main/resources"]
20+
}
21+
}
22+
}
23+
24+
compileJava {
25+
options.encoding = 'UTF-8'
26+
sourceCompatibility = JavaVersion.VERSION_11
27+
targetCompatibility = JavaVersion.VERSION_11
28+
}
29+
30+
dependencies {
31+
testImplementation('org.junit.jupiter:junit-jupiter:5.6.0')
32+
}
33+
34+
test {
35+
useJUnitPlatform()
36+
testLogging {
37+
events "passed", "skipped", "failed"
38+
}
39+
}
40+
41+
42+
asciidoctorj {
43+
modules {
44+
diagram.version '1.5.18'
45+
}
46+
}
47+
48+
asciidoctor {
49+
sourceDir file('docs')
50+
sources {
51+
include 'documentation.adoc','syntax.adoc'
52+
}
53+
outputDir file('build/docs')
54+
attributes 'source-highlighter': 'coderay',
55+
'coderay-linenums-mode': 'table',
56+
'sourcedir': "${projectDir}/src/main/java",
57+
'targeted-env': 'Sample'
58+
}
59+
60+
asciidoctorPdf {
61+
sourceDir 'docs'
62+
63+
asciidoctorj {
64+
attributes 'source-highlighter' : 'coderay',
65+
'sourcedir': "${projectDir}/src/main/java",
66+
'targeted-env': 'PDF Sample'
67+
}
68+
}

‎docs/documentation.adoc‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
= Sample Documentation
2+
:icons: font
3+
:toc: left
4+
:revnumber: 1.0
5+
6+
[TIP]
7+
Check out AsciiDocFx
8+
9+
Some sample documentaiton to show AsciiDoctor capabilities.
10+
11+
Build for: {targeted-env}
12+
13+
== Section
14+
15+
.Important Links
16+
* https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/[Quick reference]
17+
* https://asciidoctor.org/docs/asciidoc-vs-markdown/[AsciiDoc vs Markdown]
18+
* https://asciidoctor.org/docs/asciidoc-writers-guide/[AsciiDoc Writers Guide]
19+
20+
21+
22+
== Syntax Highlighting
23+
24+
[source,java]
25+
----
26+
public class Presenter{ <1>
27+
28+
@GET <2>
29+
@Transactional
30+
public List<Appointment> list() {
31+
return Appointment.listAll(); <3>
32+
}
33+
34+
35+
}
36+
----
37+
<1> class definition
38+
<2> HTTP method mapping
39+
<3> response
40+
41+
42+
== Diagram Example with Mermaid
43+
44+
include::{includedir}/service-diagram.adoc[]
45+
46+
47+
== Includes
48+
49+
[format="csv", options="header"]
50+
|===
51+
base,outcome
52+
53+
include::{includedir}/test.csv[]
54+
|===
55+
56+
[source,java]
57+
.gpiosimulator/SomeClass.java
58+
----
59+
include::{sourcedir}/gpiosimulator/SomeClass.java[tags=calculateKeyFigureMethod]
60+
----

‎docs/service-diagram.adoc‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
2+
.flow chat diagram (with mermaid)
3+
["mermaid", "glove mode flowchart", "svg"]
4+
------------------------------------------------------------
5+
sequenceDiagram
6+
Alice->John: Hello John, how are you?
7+
loop Reply every minute
8+
John-->Alice: Great!
9+
end
10+
------------------------------------------------------------
11+
12+
.component diagram (needs graphviz)
13+
[plantuml,"{plantUMLDir}testPlant2",png]
14+
----
15+
[c]->[d]
16+
----
17+
18+
.component diagram with jdot
19+
[plantuml, "{plantUMLDir}demoPlantUML", png]
20+
----
21+
'!pragma graphviz_dot jdot
22+
class BlockProcessor
23+
class DiagramBlock
24+
class DitaaBlock
25+
class PlantUmlBlock
26+
27+
BlockProcessor <|-- DiagramBlock
28+
DiagramBlock <|-- DitaaBlock
29+
DiagramBlock <|-- PlantUmlBlock
30+
----

0 commit comments

Comments
 (0)