Merge branch 'feature/44-evaluate-typst-for-documentation' into 'develop/0.3.0'
Resolve "Evaluate Typst for documentation" Closes #44 See merge request tpeetz/kontor!42
This commit was merged in pull request #86.
This commit is contained in:
@@ -0,0 +1,12 @@
|
|||||||
|
#
|
||||||
|
# https://help.github.com/articles/dealing-with-line-endings/
|
||||||
|
#
|
||||||
|
# Linux start script should use lf
|
||||||
|
/gradlew text eol=lf
|
||||||
|
|
||||||
|
# These are Windows script files and should use crlf
|
||||||
|
*.bat text eol=crlf
|
||||||
|
|
||||||
|
# Binary files should be left untouched
|
||||||
|
*.jar binary
|
||||||
|
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
# Ignore Gradle project-specific cache directory
|
||||||
|
.gradle
|
||||||
|
|
||||||
|
# Ignore Gradle build output directory
|
||||||
|
build
|
||||||
|
|
||||||
|
# Ignore Kotlin plugin data
|
||||||
|
.kotlin
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
/*
|
||||||
|
* This file was generated by the Gradle 'init' task.
|
||||||
|
*
|
||||||
|
* This is a general purpose Gradle build.
|
||||||
|
* Learn more about Gradle by exploring our Samples at https://docs.gradle.org/9.4.1/samples
|
||||||
|
*/
|
||||||
|
plugins {
|
||||||
|
id("base")
|
||||||
|
id("de.infolektuell.typst") version "0.8.0"
|
||||||
|
}
|
||||||
|
|
||||||
|
typst.version = "v0.14.2"
|
||||||
|
|
||||||
|
typst.sourceSets {
|
||||||
|
// Sources in src/main
|
||||||
|
val main by registering {
|
||||||
|
// The files to compile (without .typ extension) in src/main/typst
|
||||||
|
documents = listOf("kontor") // src/main/typst/document.typst
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
# This file was generated by the Gradle 'init' task.
|
||||||
|
# https://docs.gradle.org/current/userguide/build_environment.html#sec:gradle_configuration_properties
|
||||||
|
|
||||||
|
org.gradle.configuration-cache=true
|
||||||
|
|
||||||
@@ -0,0 +1,2 @@
|
|||||||
|
# This file was generated by the Gradle 'init' task.
|
||||||
|
# https://docs.gradle.org/current/userguide/version_catalogs.html#sec::toml-dependencies-format
|
||||||
BIN
Binary file not shown.
@@ -0,0 +1,7 @@
|
|||||||
|
distributionBase=GRADLE_USER_HOME
|
||||||
|
distributionPath=wrapper/dists
|
||||||
|
distributionUrl=https\://services.gradle.org/distributions/gradle-9.4.1-bin.zip
|
||||||
|
networkTimeout=10000
|
||||||
|
validateDistributionUrl=true
|
||||||
|
zipStoreBase=GRADLE_USER_HOME
|
||||||
|
zipStorePath=wrapper/dists
|
||||||
+248
@@ -0,0 +1,248 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
|
||||||
|
#
|
||||||
|
# Copyright © 2015 the original authors.
|
||||||
|
#
|
||||||
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
# you may not use this file except in compliance with the License.
|
||||||
|
# You may obtain a copy of the License at
|
||||||
|
#
|
||||||
|
# https://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
#
|
||||||
|
# Unless required by applicable law or agreed to in writing, software
|
||||||
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
# See the License for the specific language governing permissions and
|
||||||
|
# limitations under the License.
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
|
#
|
||||||
|
|
||||||
|
##############################################################################
|
||||||
|
#
|
||||||
|
# Gradle start up script for POSIX generated by Gradle.
|
||||||
|
#
|
||||||
|
# Important for running:
|
||||||
|
#
|
||||||
|
# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
|
||||||
|
# noncompliant, but you have some other compliant shell such as ksh or
|
||||||
|
# bash, then to run this script, type that shell name before the whole
|
||||||
|
# command line, like:
|
||||||
|
#
|
||||||
|
# ksh Gradle
|
||||||
|
#
|
||||||
|
# Busybox and similar reduced shells will NOT work, because this script
|
||||||
|
# requires all of these POSIX shell features:
|
||||||
|
# * functions;
|
||||||
|
# * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
|
||||||
|
# «${var#prefix}», «${var%suffix}», and «$( cmd )»;
|
||||||
|
# * compound commands having a testable exit status, especially «case»;
|
||||||
|
# * various built-in commands including «command», «set», and «ulimit».
|
||||||
|
#
|
||||||
|
# Important for patching:
|
||||||
|
#
|
||||||
|
# (2) This script targets any POSIX shell, so it avoids extensions provided
|
||||||
|
# by Bash, Ksh, etc; in particular arrays are avoided.
|
||||||
|
#
|
||||||
|
# The "traditional" practice of packing multiple parameters into a
|
||||||
|
# space-separated string is a well documented source of bugs and security
|
||||||
|
# problems, so this is (mostly) avoided, by progressively accumulating
|
||||||
|
# options in "$@", and eventually passing that to Java.
|
||||||
|
#
|
||||||
|
# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
|
||||||
|
# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
|
||||||
|
# see the in-line comments for details.
|
||||||
|
#
|
||||||
|
# There are tweaks for specific operating systems such as AIX, CygWin,
|
||||||
|
# Darwin, MinGW, and NonStop.
|
||||||
|
#
|
||||||
|
# (3) This script is generated from the Groovy template
|
||||||
|
# https://github.com/gradle/gradle/blob/2d6327017519d23b96af35865dc997fcb544fb40/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
|
||||||
|
# within the Gradle project.
|
||||||
|
#
|
||||||
|
# You can find Gradle at https://github.com/gradle/gradle/.
|
||||||
|
#
|
||||||
|
##############################################################################
|
||||||
|
|
||||||
|
# Attempt to set APP_HOME
|
||||||
|
|
||||||
|
# Resolve links: $0 may be a link
|
||||||
|
app_path=$0
|
||||||
|
|
||||||
|
# Need this for daisy-chained symlinks.
|
||||||
|
while
|
||||||
|
APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path
|
||||||
|
[ -h "$app_path" ]
|
||||||
|
do
|
||||||
|
ls=$( ls -ld "$app_path" )
|
||||||
|
link=${ls#*' -> '}
|
||||||
|
case $link in #(
|
||||||
|
/*) app_path=$link ;; #(
|
||||||
|
*) app_path=$APP_HOME$link ;;
|
||||||
|
esac
|
||||||
|
done
|
||||||
|
|
||||||
|
# This is normally unused
|
||||||
|
# shellcheck disable=SC2034
|
||||||
|
APP_BASE_NAME=${0##*/}
|
||||||
|
# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
|
||||||
|
APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit
|
||||||
|
|
||||||
|
# Use the maximum available, or set MAX_FD != -1 to use that value.
|
||||||
|
MAX_FD=maximum
|
||||||
|
|
||||||
|
warn () {
|
||||||
|
echo "$*"
|
||||||
|
} >&2
|
||||||
|
|
||||||
|
die () {
|
||||||
|
echo
|
||||||
|
echo "$*"
|
||||||
|
echo
|
||||||
|
exit 1
|
||||||
|
} >&2
|
||||||
|
|
||||||
|
# OS specific support (must be 'true' or 'false').
|
||||||
|
cygwin=false
|
||||||
|
msys=false
|
||||||
|
darwin=false
|
||||||
|
nonstop=false
|
||||||
|
case "$( uname )" in #(
|
||||||
|
CYGWIN* ) cygwin=true ;; #(
|
||||||
|
Darwin* ) darwin=true ;; #(
|
||||||
|
MSYS* | MINGW* ) msys=true ;; #(
|
||||||
|
NONSTOP* ) nonstop=true ;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# Determine the Java command to use to start the JVM.
|
||||||
|
if [ -n "$JAVA_HOME" ] ; then
|
||||||
|
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
|
||||||
|
# IBM's JDK on AIX uses strange locations for the executables
|
||||||
|
JAVACMD=$JAVA_HOME/jre/sh/java
|
||||||
|
else
|
||||||
|
JAVACMD=$JAVA_HOME/bin/java
|
||||||
|
fi
|
||||||
|
if [ ! -x "$JAVACMD" ] ; then
|
||||||
|
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
|
||||||
|
|
||||||
|
Please set the JAVA_HOME variable in your environment to match the
|
||||||
|
location of your Java installation."
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
JAVACMD=java
|
||||||
|
if ! command -v java >/dev/null 2>&1
|
||||||
|
then
|
||||||
|
die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
|
||||||
|
|
||||||
|
Please set the JAVA_HOME variable in your environment to match the
|
||||||
|
location of your Java installation."
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Increase the maximum file descriptors if we can.
|
||||||
|
if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
|
||||||
|
case $MAX_FD in #(
|
||||||
|
max*)
|
||||||
|
# In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
|
||||||
|
# shellcheck disable=SC2039,SC3045
|
||||||
|
MAX_FD=$( ulimit -H -n ) ||
|
||||||
|
warn "Could not query maximum file descriptor limit"
|
||||||
|
esac
|
||||||
|
case $MAX_FD in #(
|
||||||
|
'' | soft) :;; #(
|
||||||
|
*)
|
||||||
|
# In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
|
||||||
|
# shellcheck disable=SC2039,SC3045
|
||||||
|
ulimit -n "$MAX_FD" ||
|
||||||
|
warn "Could not set maximum file descriptor limit to $MAX_FD"
|
||||||
|
esac
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Collect all arguments for the java command, stacking in reverse order:
|
||||||
|
# * args from the command line
|
||||||
|
# * the main class name
|
||||||
|
# * -classpath
|
||||||
|
# * -D...appname settings
|
||||||
|
# * --module-path (only if needed)
|
||||||
|
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
|
||||||
|
|
||||||
|
# For Cygwin or MSYS, switch paths to Windows format before running java
|
||||||
|
if "$cygwin" || "$msys" ; then
|
||||||
|
APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
|
||||||
|
|
||||||
|
JAVACMD=$( cygpath --unix "$JAVACMD" )
|
||||||
|
|
||||||
|
# Now convert the arguments - kludge to limit ourselves to /bin/sh
|
||||||
|
for arg do
|
||||||
|
if
|
||||||
|
case $arg in #(
|
||||||
|
-*) false ;; # don't mess with options #(
|
||||||
|
/?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath
|
||||||
|
[ -e "$t" ] ;; #(
|
||||||
|
*) false ;;
|
||||||
|
esac
|
||||||
|
then
|
||||||
|
arg=$( cygpath --path --ignore --mixed "$arg" )
|
||||||
|
fi
|
||||||
|
# Roll the args list around exactly as many times as the number of
|
||||||
|
# args, so each arg winds up back in the position where it started, but
|
||||||
|
# possibly modified.
|
||||||
|
#
|
||||||
|
# NB: a `for` loop captures its iteration list before it begins, so
|
||||||
|
# changing the positional parameters here affects neither the number of
|
||||||
|
# iterations, nor the values presented in `arg`.
|
||||||
|
shift # remove old arg
|
||||||
|
set -- "$@" "$arg" # push replacement arg
|
||||||
|
done
|
||||||
|
fi
|
||||||
|
|
||||||
|
|
||||||
|
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
|
||||||
|
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
|
||||||
|
|
||||||
|
# Collect all arguments for the java command:
|
||||||
|
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
|
||||||
|
# and any embedded shellness will be escaped.
|
||||||
|
# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
|
||||||
|
# treated as '${Hostname}' itself on the command line.
|
||||||
|
|
||||||
|
set -- \
|
||||||
|
"-Dorg.gradle.appname=$APP_BASE_NAME" \
|
||||||
|
-jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \
|
||||||
|
"$@"
|
||||||
|
|
||||||
|
# Stop when "xargs" is not available.
|
||||||
|
if ! command -v xargs >/dev/null 2>&1
|
||||||
|
then
|
||||||
|
die "xargs is not available"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Use "xargs" to parse quoted args.
|
||||||
|
#
|
||||||
|
# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
|
||||||
|
#
|
||||||
|
# In Bash we could simply go:
|
||||||
|
#
|
||||||
|
# readarray ARGS < <( xargs -n1 <<<"$var" ) &&
|
||||||
|
# set -- "${ARGS[@]}" "$@"
|
||||||
|
#
|
||||||
|
# but POSIX shell has neither arrays nor command substitution, so instead we
|
||||||
|
# post-process each arg (as a line of input to sed) to backslash-escape any
|
||||||
|
# character that might be a shell metacharacter, then use eval to reverse
|
||||||
|
# that process (while maintaining the separation between arguments), and wrap
|
||||||
|
# the whole thing up as a single "set" statement.
|
||||||
|
#
|
||||||
|
# This will of course break if any of these variables contains a newline or
|
||||||
|
# an unmatched quote.
|
||||||
|
#
|
||||||
|
|
||||||
|
eval "set -- $(
|
||||||
|
printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
|
||||||
|
xargs -n1 |
|
||||||
|
sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
|
||||||
|
tr '\n' ' '
|
||||||
|
)" '"$@"'
|
||||||
|
|
||||||
|
exec "$JAVACMD" "$@"
|
||||||
Vendored
+93
@@ -0,0 +1,93 @@
|
|||||||
|
@rem
|
||||||
|
@rem Copyright 2015 the original author or authors.
|
||||||
|
@rem
|
||||||
|
@rem Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
@rem you may not use this file except in compliance with the License.
|
||||||
|
@rem You may obtain a copy of the License at
|
||||||
|
@rem
|
||||||
|
@rem https://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
@rem
|
||||||
|
@rem Unless required by applicable law or agreed to in writing, software
|
||||||
|
@rem distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
@rem See the License for the specific language governing permissions and
|
||||||
|
@rem limitations under the License.
|
||||||
|
@rem
|
||||||
|
@rem SPDX-License-Identifier: Apache-2.0
|
||||||
|
@rem
|
||||||
|
|
||||||
|
@if "%DEBUG%"=="" @echo off
|
||||||
|
@rem ##########################################################################
|
||||||
|
@rem
|
||||||
|
@rem Gradle startup script for Windows
|
||||||
|
@rem
|
||||||
|
@rem ##########################################################################
|
||||||
|
|
||||||
|
@rem Set local scope for the variables with windows NT shell
|
||||||
|
if "%OS%"=="Windows_NT" setlocal
|
||||||
|
|
||||||
|
set DIRNAME=%~dp0
|
||||||
|
if "%DIRNAME%"=="" set DIRNAME=.
|
||||||
|
@rem This is normally unused
|
||||||
|
set APP_BASE_NAME=%~n0
|
||||||
|
set APP_HOME=%DIRNAME%
|
||||||
|
|
||||||
|
@rem Resolve any "." and ".." in APP_HOME to make it shorter.
|
||||||
|
for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
|
||||||
|
|
||||||
|
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
|
||||||
|
set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
|
||||||
|
|
||||||
|
@rem Find java.exe
|
||||||
|
if defined JAVA_HOME goto findJavaFromJavaHome
|
||||||
|
|
||||||
|
set JAVA_EXE=java.exe
|
||||||
|
%JAVA_EXE% -version >NUL 2>&1
|
||||||
|
if %ERRORLEVEL% equ 0 goto execute
|
||||||
|
|
||||||
|
echo. 1>&2
|
||||||
|
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2
|
||||||
|
echo. 1>&2
|
||||||
|
echo Please set the JAVA_HOME variable in your environment to match the 1>&2
|
||||||
|
echo location of your Java installation. 1>&2
|
||||||
|
|
||||||
|
goto fail
|
||||||
|
|
||||||
|
:findJavaFromJavaHome
|
||||||
|
set JAVA_HOME=%JAVA_HOME:"=%
|
||||||
|
set JAVA_EXE=%JAVA_HOME%/bin/java.exe
|
||||||
|
|
||||||
|
if exist "%JAVA_EXE%" goto execute
|
||||||
|
|
||||||
|
echo. 1>&2
|
||||||
|
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2
|
||||||
|
echo. 1>&2
|
||||||
|
echo Please set the JAVA_HOME variable in your environment to match the 1>&2
|
||||||
|
echo location of your Java installation. 1>&2
|
||||||
|
|
||||||
|
goto fail
|
||||||
|
|
||||||
|
:execute
|
||||||
|
@rem Setup the command line
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
@rem Execute Gradle
|
||||||
|
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %*
|
||||||
|
|
||||||
|
:end
|
||||||
|
@rem End local scope for the variables with windows NT shell
|
||||||
|
if %ERRORLEVEL% equ 0 goto mainEnd
|
||||||
|
|
||||||
|
:fail
|
||||||
|
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
|
||||||
|
rem the _cmd.exe /c_ return code!
|
||||||
|
set EXIT_CODE=%ERRORLEVEL%
|
||||||
|
if %EXIT_CODE% equ 0 set EXIT_CODE=1
|
||||||
|
if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
|
||||||
|
exit /b %EXIT_CODE%
|
||||||
|
|
||||||
|
:mainEnd
|
||||||
|
if "%OS%"=="Windows_NT" endlocal
|
||||||
|
|
||||||
|
:omega
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
/*
|
||||||
|
* This file was generated by the Gradle 'init' task.
|
||||||
|
*
|
||||||
|
* The settings file is used to specify which projects to include in your build.
|
||||||
|
* For more detailed information on multi-project builds, please refer to https://docs.gradle.org/9.4.1/userguide/multi_project_builds.html in the Gradle documentation.
|
||||||
|
*/
|
||||||
|
|
||||||
|
rootProject.name = "kontor-doc"
|
||||||
@@ -0,0 +1,25 @@
|
|||||||
|
= Anforderungen der Domäne
|
||||||
|
|
||||||
|
== Systemfunktionen
|
||||||
|
|
||||||
|
=== Anwendungsfälle
|
||||||
|
|
||||||
|
=== Akteure
|
||||||
|
|
||||||
|
=== Zielgruppen
|
||||||
|
|
||||||
|
== Anforderungen
|
||||||
|
|
||||||
|
=== Anforderungen an externe Schnittstellen
|
||||||
|
|
||||||
|
=== Funktionale Anforderungen
|
||||||
|
|
||||||
|
=== Qualitätsanforderungen
|
||||||
|
|
||||||
|
=== Randbedingungen
|
||||||
|
|
||||||
|
=== Weitere Anforderungen
|
||||||
|
|
||||||
|
=== Wartungs- und Supportinformationen
|
||||||
|
|
||||||
|
== Verifikation
|
||||||
@@ -0,0 +1,99 @@
|
|||||||
|
//#set page("a4")
|
||||||
|
#import "@preview/basic-report:0.4.0": *
|
||||||
|
#import "@preview/in-dexter:0.7.2": *
|
||||||
|
#import "@preview/pintorita:0.1.4"
|
||||||
|
|
||||||
|
#set text(fill: white)
|
||||||
|
#show raw.where(lang: "pintora"): it => pintorita.render(it.text)
|
||||||
|
|
||||||
|
#show: it => basic-report(
|
||||||
|
doc-category: "Entwicklungs- und Projekthandbuch",
|
||||||
|
doc-title: "Projekt kontor",
|
||||||
|
author: "Thomas Peetz",
|
||||||
|
//affiliation: "MouseTec, Entenhausen",
|
||||||
|
//logo: image("assets/aerospace-engineering.png", width: 2cm),
|
||||||
|
// <a href="https://www.flaticon.com/free-icons/aerospace" title="aerospace icons">Aerospace icons created by gravisio - Flaticon</a>
|
||||||
|
language: "de",
|
||||||
|
compact-mode: false,
|
||||||
|
it
|
||||||
|
)
|
||||||
|
|
||||||
|
= Allgemeines
|
||||||
|
|
||||||
|
#figure(
|
||||||
|
table(
|
||||||
|
columns: 4,
|
||||||
|
[Version], [Datum], [Autor], [Änderungsgrund / Bemerkungen],
|
||||||
|
[1.0.0], [16.05.2022], [Thomas Peetz], [Ersterstellung],
|
||||||
|
),
|
||||||
|
caption: [Dokumenthistorie],
|
||||||
|
)
|
||||||
|
|
||||||
|
== Zweck des Dokumentes
|
||||||
|
|
||||||
|
Das Entwicklungshandbuch beschreibt die Werkzeuge und die Vorgehensweise bei der Entwicklung
|
||||||
|
im Projekt kontor-spring und der Erstellung der Dokumentation.
|
||||||
|
|
||||||
|
== Verwendete Tools
|
||||||
|
|
||||||
|
=== Gitea
|
||||||
|
|
||||||
|
Für die Verwaltung des Sourcecode kommt Gitea #index[Gitea]@gitea zum Einsatz.
|
||||||
|
Mit Gitea werden auch die Projektaufgaben verwaltet.
|
||||||
|
|
||||||
|
Das Projekt und das dazugehörige Git Repository sind unter der Adresse @gitea-kontor zu finden.
|
||||||
|
|
||||||
|
= Erstellung der Dokumentation
|
||||||
|
|
||||||
|
Die Dokumentation des Projektes wird mit Asciidoctor #index[Asciidoctor]@asciidoctor geschrieben.
|
||||||
|
Die Dokumente erhalten ihre Namen nach dem jeweiligen Hauptdokument.
|
||||||
|
|
||||||
|
== Quellcode Verwaltung
|
||||||
|
|
||||||
|
Die Asciidoctor-Dateien haben die Endung `.adoc`.
|
||||||
|
|
||||||
|
== Buildsystem
|
||||||
|
|
||||||
|
Zur Erstellung der PDF-Dateien aus den Asciidoctor-Dateien wird das Buildsystem Gradle #index[Gradle]@gradle verwendet.
|
||||||
|
Die Dateien für die Dokumente liegen im Verzeichnis `src/docs/asciidoc`.
|
||||||
|
|
||||||
|
Der Gradle Build wird über die Datei `build.gradle` definiert.
|
||||||
|
|
||||||
|
#pagebreak()
|
||||||
|
= Einführung
|
||||||
|
|
||||||
|
== Zweck
|
||||||
|
|
||||||
|
== Stakeholder des Systems
|
||||||
|
|
||||||
|
== Systemumfang
|
||||||
|
|
||||||
|
=== Zielsetzung des Systems
|
||||||
|
|
||||||
|
#pagebreak()
|
||||||
|
#include "system.typ"
|
||||||
|
|
||||||
|
#include "domain.typ"
|
||||||
|
|
||||||
|
#include "projekt.typ"
|
||||||
|
|
||||||
|
= Verschiedenes
|
||||||
|
|
||||||
|
== Erreichbarkeiten
|
||||||
|
|
||||||
|
= Referenzen
|
||||||
|
|
||||||
|
#bibliography("reference.yaml", title: none, full: true)
|
||||||
|
|
||||||
|
= Glossar
|
||||||
|
|
||||||
|
= Index
|
||||||
|
#make-index(title: none, outlined: true, use-page-counter: true)
|
||||||
|
|
||||||
|
= Verzeichnisse
|
||||||
|
|
||||||
|
== Abbildungsverzeichnis
|
||||||
|
#outline(title: none, target: figure.where(kind: image))
|
||||||
|
|
||||||
|
== Tabellenverzeichnis
|
||||||
|
#outline(title: none, target: figure.where(kind: table))
|
||||||
@@ -0,0 +1,46 @@
|
|||||||
|
= Projektbeschreibung
|
||||||
|
|
||||||
|
== Ausgangslage
|
||||||
|
|
||||||
|
//==== Rechtliche Vorgaben und Rahmenbedingungen
|
||||||
|
//=== Rahmenbedingungen
|
||||||
|
|
||||||
|
//==== Vorhandene Regelungen
|
||||||
|
|
||||||
|
== Projektziele
|
||||||
|
|
||||||
|
== Projektabgrenzung
|
||||||
|
|
||||||
|
//=== Voraussichtliche Kosten
|
||||||
|
|
||||||
|
//=== Projektrisiken
|
||||||
|
|
||||||
|
//==== Produktivität
|
||||||
|
|
||||||
|
//==== Finanzielle Risiken
|
||||||
|
|
||||||
|
//==== Akzeptanz
|
||||||
|
|
||||||
|
= Projektorganisation
|
||||||
|
|
||||||
|
== Projekt-Aufbauorganisation
|
||||||
|
|
||||||
|
== Rollendefinition
|
||||||
|
|
||||||
|
//==== Projektauftraggeber
|
||||||
|
|
||||||
|
//==== Projektausschuss
|
||||||
|
|
||||||
|
//==== Beratung / Qualitätssicherung
|
||||||
|
|
||||||
|
=== Projekteiter
|
||||||
|
|
||||||
|
=== Projektteam
|
||||||
|
|
||||||
|
=== Liste der Stakeholder
|
||||||
|
|
||||||
|
== Projektablauforganisation
|
||||||
|
|
||||||
|
=== Projekt-Phasen
|
||||||
|
|
||||||
|
== Erstellung der Projektdokumentation
|
||||||
@@ -0,0 +1,15 @@
|
|||||||
|
asciidoctor:
|
||||||
|
type: web
|
||||||
|
url: http://asciidoctor.org
|
||||||
|
gitea:
|
||||||
|
type: web
|
||||||
|
url: http://www.gitea.org
|
||||||
|
gradle:
|
||||||
|
type: web
|
||||||
|
url: http://www.gradle.org
|
||||||
|
jenkins:
|
||||||
|
type: web
|
||||||
|
url: http://jenkins-ci.org
|
||||||
|
gitea-kontor:
|
||||||
|
type: web
|
||||||
|
url: https://gitea.thpeetz.de/kontor/kontor-spring
|
||||||
@@ -0,0 +1,336 @@
|
|||||||
|
= Systemübersicht
|
||||||
|
|
||||||
|
== Systemkontext
|
||||||
|
|
||||||
|
== Systemarchitektur
|
||||||
|
|
||||||
|
== Systemschnittstellen
|
||||||
|
|
||||||
|
=== Realisierte Schnittstellen
|
||||||
|
|
||||||
|
=== Verwendete Schnittstellen
|
||||||
|
|
||||||
|
== Logisches Datenmodell
|
||||||
|
|
||||||
|
#figure(
|
||||||
|
kind: image,
|
||||||
|
```pintora
|
||||||
|
erDiagram
|
||||||
|
USER {
|
||||||
|
string id PK
|
||||||
|
datetime created_date
|
||||||
|
datetime last_modified_date
|
||||||
|
int version
|
||||||
|
string email
|
||||||
|
boolean enabled
|
||||||
|
string firstName
|
||||||
|
string lastName
|
||||||
|
string password
|
||||||
|
string token
|
||||||
|
boolean tokenExpired
|
||||||
|
string userName UNIQUE
|
||||||
|
}
|
||||||
|
USER ||--o{ AUTHORIZATION_MATRIX : "matrix"
|
||||||
|
ROLE {
|
||||||
|
string id PK
|
||||||
|
datetime created_date
|
||||||
|
datetime last_modified_date
|
||||||
|
int version
|
||||||
|
string name
|
||||||
|
}
|
||||||
|
ROLE ||--o{ AUTHORIZATION_MATRIX : "matrix"
|
||||||
|
AUTHORIZATION_MATRIX {
|
||||||
|
string id PK
|
||||||
|
datetime created_date
|
||||||
|
datetime last_modified_date
|
||||||
|
int version
|
||||||
|
string user_id FK
|
||||||
|
string role_id FK
|
||||||
|
}
|
||||||
|
```,
|
||||||
|
caption: [Benutzer ER-Diagramm]
|
||||||
|
)
|
||||||
|
|
||||||
|
#figure(
|
||||||
|
kind: image,
|
||||||
|
```pintora
|
||||||
|
erDiagram
|
||||||
|
comic {
|
||||||
|
string id PK
|
||||||
|
datetime created_date
|
||||||
|
datetime last_modified_date
|
||||||
|
int version
|
||||||
|
boolean completed
|
||||||
|
boolean currentOrder
|
||||||
|
string title
|
||||||
|
string publisher_id FK
|
||||||
|
}
|
||||||
|
comic ||--o{ comic_work : "1"
|
||||||
|
comic ||--o{ issue : "1"
|
||||||
|
comic ||--o{ volume : "1"
|
||||||
|
comic ||--o{ story_arc : "1"
|
||||||
|
comic ||--o{ trade_paperback : "1"
|
||||||
|
volume {
|
||||||
|
string id PK
|
||||||
|
datetime created_date
|
||||||
|
datetime last_modified_date
|
||||||
|
int version
|
||||||
|
string name
|
||||||
|
string comic_id FK
|
||||||
|
}
|
||||||
|
volume ||--o{ issue : "1"
|
||||||
|
issue {
|
||||||
|
string id PK
|
||||||
|
datetime created_date
|
||||||
|
datetime last_modified_date
|
||||||
|
int version
|
||||||
|
boolean in_stock
|
||||||
|
boolean is_read
|
||||||
|
string issue_number
|
||||||
|
string comic_id FK
|
||||||
|
string volume_id FK
|
||||||
|
}
|
||||||
|
publisher {
|
||||||
|
string id PK
|
||||||
|
datetime created_date
|
||||||
|
datetime last_modified_date
|
||||||
|
int version
|
||||||
|
string name
|
||||||
|
}
|
||||||
|
publisher ||--o{ comic : "1"
|
||||||
|
artist {
|
||||||
|
string id PK
|
||||||
|
datetime created_date
|
||||||
|
datetime last_modified_date
|
||||||
|
int version
|
||||||
|
string name
|
||||||
|
}
|
||||||
|
artist ||--o{ comic_work : "1"
|
||||||
|
story_arc {
|
||||||
|
string id PK
|
||||||
|
datetime created_date
|
||||||
|
datetime last_modified_date
|
||||||
|
int version
|
||||||
|
string name
|
||||||
|
string comic_id FK
|
||||||
|
}
|
||||||
|
trade_paperback {
|
||||||
|
string id PK
|
||||||
|
datetime created_date
|
||||||
|
datetime last_modified_date
|
||||||
|
int version
|
||||||
|
int issueStart
|
||||||
|
int issueEnd
|
||||||
|
string name
|
||||||
|
string comic_id FK
|
||||||
|
}
|
||||||
|
worktype {
|
||||||
|
string id PK
|
||||||
|
datetime created_date
|
||||||
|
datetime last_modified_date
|
||||||
|
int version
|
||||||
|
string name
|
||||||
|
}
|
||||||
|
worktype ||--o{ comic-work : "1"
|
||||||
|
comic_work {
|
||||||
|
string id PK
|
||||||
|
datetime created_date
|
||||||
|
datetime last_modified_date
|
||||||
|
int version
|
||||||
|
string artist_id FK
|
||||||
|
string comic_id FK
|
||||||
|
string worktype_id FK
|
||||||
|
}
|
||||||
|
```,
|
||||||
|
caption: [Comics ER-Diagramm]
|
||||||
|
)
|
||||||
|
|
||||||
|
#figure(
|
||||||
|
kind: image,
|
||||||
|
```pintora
|
||||||
|
erDiagram
|
||||||
|
sport {
|
||||||
|
string id PK
|
||||||
|
datetime created_date
|
||||||
|
datetime last_modified_date
|
||||||
|
int version
|
||||||
|
string name
|
||||||
|
}
|
||||||
|
team {
|
||||||
|
string id PK
|
||||||
|
datetime created_date
|
||||||
|
datetime last_modified_date
|
||||||
|
int version
|
||||||
|
string name
|
||||||
|
string short_name
|
||||||
|
string sport_id FK
|
||||||
|
}
|
||||||
|
field_position {
|
||||||
|
string id PK
|
||||||
|
datetime created_date
|
||||||
|
datetime last_modified_date
|
||||||
|
int version
|
||||||
|
string name
|
||||||
|
string short_name
|
||||||
|
string sport_id FK
|
||||||
|
}
|
||||||
|
rooster {
|
||||||
|
string id PK
|
||||||
|
datetime created_date
|
||||||
|
datetime last_modified_date
|
||||||
|
int version
|
||||||
|
int year
|
||||||
|
string player_id FK
|
||||||
|
string position_id FK
|
||||||
|
string team_id FK
|
||||||
|
}
|
||||||
|
player {
|
||||||
|
string id PK
|
||||||
|
datetime created_date
|
||||||
|
datetime last_modified_date
|
||||||
|
int version
|
||||||
|
string first_name
|
||||||
|
string last_name
|
||||||
|
}
|
||||||
|
vendor {
|
||||||
|
string id PK
|
||||||
|
datetime created_date
|
||||||
|
datetime last_modified_date
|
||||||
|
int version
|
||||||
|
string name
|
||||||
|
}
|
||||||
|
card_set {
|
||||||
|
string id PK
|
||||||
|
datetime created_date
|
||||||
|
datetime last_modified_date
|
||||||
|
int version
|
||||||
|
boolean insert_set
|
||||||
|
string name
|
||||||
|
boolean parallel_set
|
||||||
|
string vendor_id FK
|
||||||
|
}
|
||||||
|
card {
|
||||||
|
string id PK
|
||||||
|
datetime created_date
|
||||||
|
datetime last_modified_date
|
||||||
|
int version
|
||||||
|
int cardNumber
|
||||||
|
int year
|
||||||
|
string card_set FK
|
||||||
|
string rooster_id FK
|
||||||
|
string vendor_id FK
|
||||||
|
}
|
||||||
|
sport ||--o{ team : "1"
|
||||||
|
sport ||--o{ field_position : "1"
|
||||||
|
field_position ||--o{ rooster : "1"
|
||||||
|
player ||--o{ rooster : "1"
|
||||||
|
team ||--o{ rooster : "1"
|
||||||
|
vendor ||--o{ card : "1"
|
||||||
|
card_set ||--o{ card : "1"
|
||||||
|
rooster ||--o{ card : "1"
|
||||||
|
```,
|
||||||
|
caption: [TYSC ER-Diagramm]
|
||||||
|
)
|
||||||
|
|
||||||
|
#figure(
|
||||||
|
kind: image,
|
||||||
|
```pintora
|
||||||
|
erDiagram
|
||||||
|
book {
|
||||||
|
string id PK
|
||||||
|
datetime created_date
|
||||||
|
datetime last_modified_date
|
||||||
|
int version
|
||||||
|
string isbn UNIQUE
|
||||||
|
string title
|
||||||
|
int year
|
||||||
|
string publisher_id FK
|
||||||
|
}
|
||||||
|
bookshelf_publisher {
|
||||||
|
string id PK
|
||||||
|
datetime created_date
|
||||||
|
datetime last_modified_date
|
||||||
|
int version
|
||||||
|
string name UNIQUE
|
||||||
|
}
|
||||||
|
author {
|
||||||
|
string id PK
|
||||||
|
datetime created_date
|
||||||
|
datetime last_modified_date
|
||||||
|
int version
|
||||||
|
string first_name
|
||||||
|
string last_name
|
||||||
|
}
|
||||||
|
article {
|
||||||
|
string id PK
|
||||||
|
datetime created_date
|
||||||
|
datetime last_modified_date
|
||||||
|
int version
|
||||||
|
string title
|
||||||
|
}
|
||||||
|
article_author {
|
||||||
|
string id PK
|
||||||
|
datetime created_date
|
||||||
|
datetime last_modified_date
|
||||||
|
int version
|
||||||
|
string article_id FK
|
||||||
|
string author_id FK
|
||||||
|
}
|
||||||
|
book_author {
|
||||||
|
string id PK
|
||||||
|
datetime created_date
|
||||||
|
datetime last_modified_date
|
||||||
|
int version
|
||||||
|
string book_id FK
|
||||||
|
string author_id FK
|
||||||
|
}
|
||||||
|
bookshelf_publisher ||--o{ book : "1"
|
||||||
|
article ||--o{ article_author : "1"
|
||||||
|
author ||--o{ article_author : "1"
|
||||||
|
book ||--o{ book_author : "1"
|
||||||
|
author ||--o{ book_author : "1"
|
||||||
|
```,
|
||||||
|
caption: [Bookshelf ER-Diagramm]
|
||||||
|
)
|
||||||
|
|
||||||
|
#figure(
|
||||||
|
kind: image,
|
||||||
|
```pintora
|
||||||
|
erDiagram
|
||||||
|
mail {
|
||||||
|
string id PK
|
||||||
|
datetime created_date
|
||||||
|
datetime last_modified_date
|
||||||
|
int version
|
||||||
|
string subject
|
||||||
|
string content
|
||||||
|
datetime received_date
|
||||||
|
datetime sent_date
|
||||||
|
}
|
||||||
|
mail_account {
|
||||||
|
string id PK
|
||||||
|
datetime created_date
|
||||||
|
datetime last_modified_date
|
||||||
|
int version
|
||||||
|
string host
|
||||||
|
string password
|
||||||
|
int port
|
||||||
|
string protocol
|
||||||
|
boolean start_tls
|
||||||
|
string user_name
|
||||||
|
}
|
||||||
|
mail_address {
|
||||||
|
string id PK
|
||||||
|
datetime created_date
|
||||||
|
datetime last_modified_date
|
||||||
|
int version
|
||||||
|
string internet_address UNIQUE
|
||||||
|
string personal
|
||||||
|
string user_id FK
|
||||||
|
}
|
||||||
|
user ||--o{ mail_address : "1"
|
||||||
|
```,
|
||||||
|
caption: [Mail ER-Diagramm]
|
||||||
|
)
|
||||||
|
|
||||||
|
=== Einschränkungen
|
||||||
@@ -30,6 +30,7 @@ plugins {
|
|||||||
alias(libs.plugins.asciidoctorPdf)
|
alias(libs.plugins.asciidoctorPdf)
|
||||||
alias(libs.plugins.asciidoctorConvert)
|
alias(libs.plugins.asciidoctorConvert)
|
||||||
alias(libs.plugins.asciidoctorGems)
|
alias(libs.plugins.asciidoctorGems)
|
||||||
|
id "de.infolektuell.typst" version "0.8.0"
|
||||||
}
|
}
|
||||||
|
|
||||||
repositories {
|
repositories {
|
||||||
|
|||||||
Reference in New Issue
Block a user