Skip to content

Fix tasks for multipage formats #56

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dominikgoertz wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix tasks for multipage formats #56

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b91b3c2
Fix tasks for multipage formats
dominikgoertz Oct 13, 2025
a241430
Ignore .deb files in vesion control
dominikgoertz Oct 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ gradle-app.setting
.nb-gradle-properties
src_gen
.idea
*.deb

# Ignore Mac DS_Store files
**/.DS_Store
6 changes: 6 additions & 0 deletions build-arc42.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,13 @@ git pull
cd ..
echo "build arc42 template"
./gradlew createTemplatesFromGoldenMaster
echo "convert to other singlepage formats"
./gradlew arc42
echo "generate docbook multipage format"
./gradlew generateDocbookMP
echo "convert docbook multipage to other multipage formats"
./gradlew arc42MP
echo "create distributions"
./gradlew createDistribution
echo "please check the results in arc42-template/dist"
echo "and if ok, add, commit and push it"
131 changes: 66 additions & 65 deletions subBuild.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,12 +229,11 @@ task convert2MarkdownStrict (
task convert2MarkdownMPStrict (
dependsOn: [copyImages, generateDocbookMP ]
) {
doLast {
def i = 0
def sourceFolder = file(localBuildDir.docbook + 'MP/.')
def sourceFolder = file(localBuildDir.docbook + 'MP/.')
if (sourceFolder.exists()) {
sourceFolder.eachFile { myFile ->
if (myFile.name.endsWith('.xml')) {
def taskName = 'convert2MarkdownStrict_file' + i++
def taskName = 'convert2MarkdownMPStrict_file_' + myFile.name-'.xml'
new File(localBuildDir.markdownMPStrict + '/').mkdirs()
def theTask = tasks.create(name: taskName, type: Exec, dependsOn: [copyImages, generateDocbookMP]) {
//commandLine "pandoc -r arc42-template.xml -o arc42-template.docx "
Expand All @@ -244,20 +243,19 @@ task convert2MarkdownMPStrict (
'-o', localBuildDir.markdownMPStrict + '/' + myFile.name-'xml'+'md',
myFile.canonicalPath]
}
theTask.mustRunAfter(it)
it.finalizedBy(theTask)
}
}
}
}
task convert2MarkdownMP (
dependsOn: [copyImages, generateDocbookMP ]
) {
doLast {
def i = 0
def sourceFolder = file(localBuildDir.docbook + 'MP/.')
def sourceFolder = file(localBuildDir.docbook + 'MP/.')
if (sourceFolder.exists()) {
sourceFolder.eachFile { myFile ->
if (myFile.name.endsWith('.xml')) {
def taskName = 'convert2Markdown_file' + i++
def taskName = 'convert2MarkdownMP_file' + myFile.name-'.xml'
new File(localBuildDir.markdownMP + '/').mkdirs()
def theTask = tasks.create(name: taskName, type: Exec, dependsOn: [copyImages, generateDocbookMP]) {
//commandLine "pandoc -r arc42-template.xml -o arc42-template.docx "
Expand All @@ -267,7 +265,7 @@ task convert2MarkdownMP (
'-o', localBuildDir.markdownMP + '/' + myFile.name-'xml'+'md',
myFile.canonicalPath]
}
theTask.mustRunAfter(it)
it.finalizedBy(theTask)
}
}
}
Expand All @@ -286,25 +284,25 @@ task convert2GitHubMarkdown (
task convert2GitHubMarkdownMP (
dependsOn: [copyImages, generateDocbookMP ]
) {
doLast {
def i = 0
def sourceFolder = file(localBuildDir.docbook + 'MP/.')

def sourceFolder = file(localBuildDir.docbook + 'MP/.')
if (sourceFolder.exists()) {
sourceFolder.eachFile { myFile ->
if (myFile.name.endsWith('.xml')) {
def taskName = 'convert2GitHubMarkdown_file' + i++
def taskName = 'convert2GitHubMarkdownMP_' + myFile.name - '.xml'
new File(localBuildDir.gitHubmarkdownMP + '/').mkdirs()
def theTask = tasks.create(name: taskName, type: Exec, dependsOn: [copyImages, generateDocbookMP]) {
//commandLine "pandoc -r arc42-template.xml -o arc42-template.docx "
executable = "pandoc"
args = ['-r', 'docbook',
'-t', 'gfm',
'-o', localBuildDir.gitHubMarkdownMP + '/' + myFile.name-'xml'+'md',
myFile.canonicalPath]
}
theTask.mustRunAfter(it)
it.finalizedBy(theTask)
}
}
}

}
task convert2Mkdocs (
dependsOn: [copyImages, generateDocbook ],
Expand Down Expand Up @@ -369,13 +367,13 @@ task convert2Mkdocs (
task convert2MkdocsMP (
dependsOn: [copyImages, generateDocbookMP ]
) {
doLast {
def i = 0
def sourceFolder = file(localBuildDir.docbook + 'MP/.')
def lastFileTask = null
def sourceFolder = file(localBuildDir.docbook + 'MP/.')
def lastFileTask = null
def fileTasks = []
if(sourceFolder.exists()) {
sourceFolder.eachFile { myFile ->
if (myFile.name.endsWith('.xml')) {
def taskName = 'convert2Mkdocs_file' + i++
def taskName = 'convert2MkdocsMP_file_' + myFile.name - '.xml'
new File(localBuildDir.mkdocsMP + '/docs/').mkdirs()
new File(localBuildDir.mkdocsMP + '/mkdocs.yml')
.write(""" |site_name: Arc42 Template
Expand Down Expand Up @@ -403,65 +401,58 @@ task convert2MkdocsMP (
| - navigation.indexes
| - toc.follow
|""".stripMargin())
def outfile = myFile.name-'xml'+'md'
if (myFile.name == "arc42-template.xml") {
outfile = 'index.md'
}
def theTask = tasks.create(name: taskName, type: Exec, dependsOn: [copyImages, generateDocbookMP]) {
//commandLine "pandoc -r arc42-template.xml -o arc42-template.docx "
def outfile = myFile.name-'xml'+'md'
if (myFile.name == "arc42-template.xml") {
outfile = 'index.md'
}

// FIXME remove this and keep the next block
def sout = new StringBuilder(), serr = new StringBuilder()
def proc = ('pandoc -r docbook -t markdown_phpextra --toc --wrap=none --reference-links -o ' + localBuildDir.mkdocsMP + '/docs/' + outfile + ' ' + myFile.canonicalPath).execute()
proc.consumeProcessOutput(sout, serr)
proc.waitForOrKill(1000)

// was not working for me in any MP task
// FIXME keep this block and remove previous one
/*executable = "pandoc"
executable = "pandoc"
args = ['-r', 'docbook',
'-t', 'markdown_phpextra',
'--toc', // Include table of contents
'--wrap=none', // No text wrapping
'--reference-links', // Use reference-style links
'-o', localBuildDir.mkdocsMP + '/docs/' + outfile,
myFile.canonicalPath]*/
myFile.canonicalPath]
}
lastFileTask = theTask
theTask.mustRunAfter(it)
it.finalizedBy(theTask)
fileTasks.add(theTask)
}
}
def thePostTask = tasks.create(name: "convert2Mkdocs_post", type: Exec, dependsOn: [copyImages, generateDocbookMP]) {
new File(localBuildDir.mkdocsMP + '/docs/config.md').delete()
new File(localBuildDir.mkdocsMP + '/docs/about-arc42.md').delete()
def indexFile = new File(localBuildDir.mkdocsMP + '/docs/index.md')
def indexHeader = indexFile.getText('UTF-8').split(">.").first().substring(1).trim() + ">.\n\n"
indexFile.withWriter('UTF-8') { out ->
out.write(indexHeader)
new File(localBuildDir.mkdocsMP + "/docs/.").eachFile {
if (it.name != "index.md") {
def title = new File(localBuildDir.mkdocsMP + "/docs/" + it.name).withReader { it.readLine() }
if (title.startsWith("#")) {
title = title.split("[#{]+")[1].trim()
out.write("\n0. [${title}](${it.name})\n")
def thePostTask = tasks.create(name: "convert2Mkdocs_post", dependsOn: [copyImages, generateDocbookMP]) {
doLast {
new File(localBuildDir.mkdocsMP + '/docs/config.md').delete()
new File(localBuildDir.mkdocsMP + '/docs/about-arc42.md').delete()
def indexFile = new File(localBuildDir.mkdocsMP + '/docs/index.md')
def indexHeader = indexFile.getText('UTF-8').split(">.").first().substring(1).trim() + ">.\n\n"
indexFile.withWriter('UTF-8') { out ->
out.write(indexHeader)
new File(localBuildDir.mkdocsMP + "/docs/.").eachFile {
if (it.name != "index.md") {
def title = new File(localBuildDir.mkdocsMP + "/docs/" + it.name).withReader { it.readLine() }
if (title.startsWith("#")) {
title = title.split("[#{]+")[1].trim()
out.write("\n0. [${title}](${it.name})\n")
}
}
}
}
}
}
thePostTask.mustRunAfter(lastFileTask)
thePostTask.mustRunAfter(fileTasks)
lastFileTask.finalizedBy(thePostTask)
}
}

task convert2Textile (
dependsOn: [copyImages, generateDocbookMP ]
) {
doLast {
def i = 0
def sourceFolder = file(localBuildDir.docbook + 'MP/.')
def sourceFolder = file(localBuildDir.docbook + 'MP/.')
if(sourceFolder.exists()) {
sourceFolder.eachFile { myFile ->
if (myFile.name.endsWith('.xml')) {
def taskName = 'convert2Textile_file' + i++
def taskName = 'convert2Textile_file' + myFile.name-'.xml'
new File(localBuildDir.textile + '/').mkdirs()
def theTask = tasks.create(name: taskName, type: Exec, dependsOn: [copyImages, generateDocbookMP]) {
//commandLine "pandoc -r arc42-template.xml -o arc42-template.docx "
Expand All @@ -471,17 +462,16 @@ task convert2Textile (
'-o', localBuildDir.textile + '/'+myFile.name-'xml'+'textile',
myFile.canonicalPath]
}
theTask.mustRunAfter(it)
it.finalizedBy(theTask)
}
}
}
}
task convert2Textile2 (
dependsOn: [copyImages, generateDocbookMP ]
) {
doLast {
def i = 0
def sourceFolder = file(localBuildDir.docbook + 'MP/.')
def sourceFolder = file(localBuildDir.docbook + 'MP/.')
if(sourceFolder.exists()) {
sourceFolder.eachFile { myFile ->
if (myFile.name.endsWith('.xml')) {
//rewrite file without <col elements
Expand All @@ -495,9 +485,9 @@ task convert2Textile2 (
}
}
new File(myFile.canonicalPath+"2").write(newFile)
def taskName = 'convert2Textile2_file' + i++
def taskName = 'convert2Textile2_file_' + myFile.name-'.xml'
new File(localBuildDir.textile2 + '/').mkdirs()
println rootDir.canonicalPath+'/width-filter-docBook.lua'
//println rootDir.canonicalPath+'/width-filter-docBook.lua'
def theTask = tasks.create(name: taskName, type: Exec, dependsOn: [copyImages, generateDocbookMP]) {
//commandLine "pandoc -r arc42-template.xml -o arc42-template.docx "
executable = "pandoc"
Expand All @@ -506,7 +496,7 @@ task convert2Textile2 (
'-o', localBuildDir.textile2 + '/'+myFile.name-'xml'+'textile',
myFile.canonicalPath+'2']
}
theTask.mustRunAfter(it)
it.finalizedBy(theTask)
}
}
}
Expand All @@ -517,12 +507,23 @@ task export2Confluence (

}
task arc42(
dependsOn: [copyImages, generateHTML, export2Confluence, convert2Latex, convert2Docx, convert2Epub, convert2Rst, convert2Markdown, convert2MarkdownMP, convert2MarkdownStrict, convert2MarkdownMPStrict, convert2GitHubMarkdown, convert2GitHubMarkdownMP, convert2Mkdocs, convert2MkdocsMP, convert2Textile, convert2Textile2, copyAsciidoc],
description: 'collects all required tasks for creating arc42 documentation',
dependsOn: [copyImages, generateHTML, generateDocbook, copyAsciidoc, export2Confluence, convert2Latex, convert2Docx, convert2Epub, convert2Rst, convert2Markdown, convert2MarkdownStrict, convert2GitHubMarkdown, convert2Mkdocs, generateDocbookMP],
description: 'collects all required tasks for creating arc42 single page documentation',
group: 'arc42-template'
) {
doLast {
println "globalBuildDir = ${globalBuildDir}"
println "localBuildDir = ${localBuildDir}"
}
}
task arc42MP(
dependsOn: [convert2MarkdownMP, convert2MarkdownMPStrict, convert2GitHubMarkdownMP, convert2MkdocsMP, convert2Textile, convert2Textile2],
description: 'collects all required tasks for creating arc42 multipage documentation. Requires "generateDocbookMP" task to have been run beforehand!',
group: 'arc42-template'
) {
doLast {
println "globalBuildDir = ${globalBuildDir}"
println "localBuildDir = ${localBuildDir}"
}
}