You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
image:https://github.com/isaqb-org/advanced-template/workflows/CI%20-%20Releases%20and%20Main/badge.svg?branch=main["CI – Releases and Main"]
image:https://github.com/isaqb-org/curriculum-agenta/workflows/CI%20-%20Releases%20and%20Main/badge.svg?branch=main["CI – Releases and Main"]
. Rename the repository to the name of your curriculum e.g. `curriculum-flex`
50
-
. Rename the file `docs/curriculum-template.adoc` to the name of your curriculum e.g. `curriculum-flex.adoc` (this is later on referred to as `curriculumFileName`)
51
-
. Open the file `docs/config/setup.adoc` to adjust configuration specific to your curriculum:
52
-
.. `:curriculum-short: MODULKUERZEL`: this is the abbreviation of your module. Replace MODULKUERZEL with your module name e.g. FLEX
53
-
.. `:curriculum-name: MODULNAME IN VOLLER LAENGE`: the full German title of your CPSA-A module. replace "MODULNAME IN VOLLER LAENGE" with your module name e.g. "Flexible Architecture Models - Microservices und Self-Contained Systems"
54
-
.. `:curriculum-name: FULL NAME OF MODULE`: the full English title of your CPSA-A module. replace "FULL NAME OF MODULE" with your module name e.g. "Flexible Architecture Models - Microservices and Self-Contained Systems"
55
-
. Open the file `build.gradle` to adjust attributes specific to your curriculum:
56
-
[loweralpha]
57
-
.. `curriculumFileName`: the name of the asciidoc root file of your curriculum e.g. `curriculum-flex` (see above! The `.adoc` suffix is added automatically, omit it here!)
58
-
. Open README.adoc and replace the string `curriculum-template` with the name of your Github repository e.g. `curriculum-flex`
59
-
. Build the project with http://www.gradle.com[gradle] (you need a locally installed JDK 17 or higher) via `./gradle-tools/gradlew buildDocs`.
60
-
. Once the "BUILD SUCCESSFUL" is shown, you can review the build result under `build/index.html`
61
-
62
-
== How to write iSAQB Advanced Level Curricula with AsciiDoc
63
-
64
-
=== Requirements and (our) solutions
65
-
66
-
[cols="1,2a",options="header"]
67
-
|===
68
-
|Requirement
69
-
|Solution
70
-
71
-
|Visually appealing pdf output
72
-
|We created an iSAQB pdf theme, located under the `/style` directory. The original is maintained in the `adoc2pdf` repository.
73
-
74
-
|Multiple people contribute content, review and comment
75
-
|highly modularized content: Small chunks, like learning-goals or subsections, are contained in their own asciidoc-files.
76
-
77
-
|Multiple languages, at least EN and DE (i18n)
78
-
|Every piece of text is enclosed in _tags_ like `tag::EN[]`. The build process collects all parts for the desired language.
79
-
80
-
|Simple conversion from asciidoc to pdf (and html)
81
-
|There is currently one option available:
82
-
83
-
* Gradle based build, requiring a local Java runtime.
84
-
|===
85
-
86
-
- - -
87
-
88
-
**TODO:** Add explanation for keywords and general procedure when creating a new Advanced Level Curriculum.
89
-
90
-
- - -
91
-
92
-
=== How to organize files?
93
-
94
-
==== Prerequisite: AsciiDoc include
95
-
You should know some details about the AsciiDoc include statement.
96
-
97
-
If the Asciidoctor processor encounters a statement like the one below:
98
-
99
-
[source,asciidoc]
100
-
----
101
-
include::directory/file.adoc[]
102
-
----
103
-
104
-
It will replace this include statement with the contents of `file.adoc`. That's easy and straightforward.
105
-
106
-
=== Content and Structure files
107
-
As we are writing i18n we need to strictly distiguish between two
108
-
kind of files:
109
-
110
-
* *content* files, they contain text, tables or diagrams that shall be included in the output.
111
-
* *structure* files, containing only include-statements, configuration information. Structure files include both content-files and other structure files.
112
-
113
-
For content files, specific parts will be included via the tag-syntax described above.
114
-
For that purpose we define a variable named `include_configuration` in the file `config/setup.adoc`.
115
-
116
-
==== Structure File Example
117
-
118
-
In theory, you can just use the `docs/curriculum-template.adoc` as is and just
119
-
edit the section documents in the subdirectories. If you want to create your own file,
120
-
we recommend to stick with the following:
121
-
122
-
From `docs/curriculum-template.adoc` (excerpts):
123
-
124
-
[source,asciidoc]
125
-
----
126
-
= Template Curriculum: CPSA Certified Professional for Software Architecture^(R)^
The international Software Architecture Qualification Board (link:https://isaqb.org[iSAQB]) defines curricula on several levels for software architects.
0 commit comments