Merge branch '2-add-description-help-text-for-input-parameters-in-readme' into 'main'

Resolve "Add description/help text for input parameters in README"

Closes #2

See merge request !2

README.md

@@ -8,3 +8,15 @@ Usage:
 
 1. Create a [new project](https://git-st.inf.tu-dresden.de/projects/new). Note the URL to clone the project.
 2. Run `cookiecutter https://git-st.inf.tu-dresden.de/jastadd/project-templates/relast` and put in your information, especially the URL from step 1 as `project_url`.
+
+## Input parameters
+
+| Parameter Name | Default | Description | Used in/for |
+|---|---|---|---|
+| `repo_name` |  `"test_repo"` | Name used in the URL of the project | Initialize `project_url`, `repo_url`, Generated project directory, last part of the Java package, prefix of version file, name of the published artifact |
+| `project_name` |  `"My New Relational RAG Project"` | (Long) name of the project | Title in README, pages |
+| `project_short_name` |  `"NewRelAST"` | (Short) name of the project | Name of the grammar, partly name of the test |
+| `namespace` |  `"jastadd"` | Namespace of the gitlab repository | Namespace used in the URL of the project |
+| `project_url` |  `"git@git-st.inf.tu-dresden.de:{{cookiecutter.namespace}}/{{cookiecutter.repo_name}}.git"` | (pre-computed) URL to clone the project using SSH | Setting git `origin` remote |
+| `repo_url` |  `"https://git-st.inf.tu-dresden.de/{{cookiecutter.namespace}}/{{cookiecutter.repo_name}}"` | (pre-computed) URL of the project | Back-link to repository in pages |
+| `version` |  `"0.0.1"` | Initial version of the project | version file |

cookiecutter.json

@@ -2,10 +2,9 @@
   "repo_name": "test_repo",
   "project_name": "My New Relational RAG Project",
   "project_short_name": "NewRelAST",
-  "project_slug": "{{cookiecutter.project_name|replace(' ','_')|lower}}",
-  "package": "jastadd",
-  "project_url": "git@git-st.inf.tu-dresden.de:{{cookiecutter.package}}/{{cookiecutter.repo_name}}.git",
-  "repo_url": "https://git-st.inf.tu-dresden.de/{{cookiecutter.package}}/{{cookiecutter.repo_name}}",
+  "namespace": "jastadd",
+  "project_url": "git@git-st.inf.tu-dresden.de:{{cookiecutter.namespace}}/{{cookiecutter.repo_name}}.git",
+  "repo_url": "https://git-st.inf.tu-dresden.de/{{cookiecutter.namespace}}/{{cookiecutter.repo_name}}",
   "version": "0.0.1",
   "_copy_without_render": [
     "pages/custom_theme/footer.html"

{{cookiecutter.repo_name}}/README.md

 # {{cookiecutter.project_name}}
 
-For documentation, please see https://{{cookiecutter.package}}.pages.st.inf.tu-dresden.de/{{cookiecutter.project_slug}}
+For documentation, please see https://{{cookiecutter.namespace}}.pages.st.inf.tu-dresden.de/{{cookiecutter.repo_name}}

{{cookiecutter.repo_name}}/build.gradle

@@ -9,7 +9,7 @@ plugins {
 group 'de.tudresden.inf.st'
 
 ext {
-    mainClassName = 'de.tudresden.inf.st.{{cookiecutter.project_slug}}.Main'
+    mainClassName = 'de.tudresden.inf.st.{{cookiecutter.repo_name}}.Main'
 }
 
 // set the main class name for `gradle run`
@@ -43,7 +43,7 @@ dependencies {
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: "${jupyter_version}"
 }
 
-def versionFile = 'src/main/resources/{{cookiecutter.project_slug}}Version.properties'
+def versionFile = 'src/main/resources/{{cookiecutter.repo_name}}Version.properties'
 def oldProps = new Properties()
 
 try {
@@ -156,11 +156,11 @@ jastadd {
 
     // TODO uncomment of parser is used
     // parser.name = '{{cookiecutter.project_short_name}}Parser'
-    // scanner.genDir = 'src/gen/java/de/tudresden/inf/st/{{cookiecutter.project_slug}}/scanner'
-    // parser.genDir = 'src/gen/java/de/tudresden/inf/st/{{cookiecutter.project_slug}}/parser'
+    // scanner.genDir = 'src/gen/java/de/tudresden/inf/st/{{cookiecutter.repo_name}}/scanner'
+    // parser.genDir = 'src/gen/java/de/tudresden/inf/st/{{cookiecutter.repo_name}}/parser'
 
     module = 'relast-module'
-    astPackage = 'de.tudresden.inf.st.{{cookiecutter.project_slug}}.ast'
+    astPackage = 'de.tudresden.inf.st.{{cookiecutter.repo_name}}.ast'
     genDir = 'src/gen/java'
     buildInfoDir = 'src/gen-res'
 
@@ -173,9 +173,9 @@ jastadd {
 publishing {
     publications {
         maven(MavenPublication) {
-            artifactId = '{{cookiecutter.project_slug}}'
+            artifactId = '{{cookiecutter.repo_name}}'
             // from components.java
-            artifact("build/libs/{{cookiecutter.project_slug}}-${version}.jar") {
+            artifact("build/libs/{{cookiecutter.repo_name}}-${version}.jar") {
                 extension 'jar'
             }
         }

{{cookiecutter.repo_name}}/pages/main.py

-{{cookiecutter.project_slug}}VersionFileName = '../src/main/resources/{{cookiecutter.project_slug}}Version.properties'
+{{cookiecutter.repo_name}}VersionFileName = '../src/main/resources/{{cookiecutter.repo_name}}Version.properties'
 
 
 def get_version():
-    with open({{cookiecutter.project_slug}}VersionFileName) as {{cookiecutter.project_slug}}VersionFile:
-        versionFileContent = {{cookiecutter.project_slug}}VersionFile.read()
+    with open({{cookiecutter.repo_name}}VersionFileName) as {{cookiecutter.repo_name}}VersionFile:
+        versionFileContent = {{cookiecutter.repo_name}}VersionFile.read()
     return versionFileContent[versionFileContent.rindex('version=') + 8:].strip()
 
 
@@ -17,7 +17,7 @@ def define_env(env):
     env.conf['site_name'] = '{{cookiecutter.project_name}} ' + get_version()
 
     @env.macro
-    def {{cookiecutter.project_slug}}_version():
+    def {{cookiecutter.repo_name}}_version():
         return get_version()
 
 

{{cookiecutter.repo_name}}/settings.gradle

-rootProject.name = '{{cookiecutter.project_slug}}'
+rootProject.name = '{{cookiecutter.repo_name}}'
 

{{cookiecutter.repo_name}}/src/main/java/de/tudresden/inf/st/{{cookiecutter.project_slug}}/Main.java → {{cookiecutter.repo_name}}/src/main/java/de/tudresden/inf/st/{{cookiecutter.repo_name}}/Main.java

-package de.tudresden.inf.st.{{cookiecutter.project_slug}};
+package de.tudresden.inf.st.{{cookiecutter.repo_name}};
 
-import de.tudresden.inf.st.{{cookiecutter.project_slug}}.ast.*;
+import de.tudresden.inf.st.{{cookiecutter.repo_name}}.ast.*;
 
 public class Main {
 

{{cookiecutter.repo_name}}/src/test/java/de/tudresden/inf/st/{{cookiecutter.project_slug}}/{{cookiecutter.project_short_name}}Test.java → {{cookiecutter.repo_name}}/src/test/java/de/tudresden/inf/st/{{cookiecutter.repo_name}}/{{cookiecutter.project_short_name}}Test.java

-package de.tudresden.inf.st.{{cookiecutter.project_slug}};
+package de.tudresden.inf.st.{{cookiecutter.repo_name}};
 
-import de.tudresden.inf.st.{{cookiecutter.project_slug}}.ast.*;
+import de.tudresden.inf.st.{{cookiecutter.repo_name}}.ast.*;
 
 import org.junit.jupiter.api.Test;
 import static org.assertj.core.api.Assertions.assertThat;