Merge branch 'dev'

Author: hauke96

.github/ISSUE_TEMPLATE/bug_report.md

@@ -36,3 +36,10 @@ Steps to reproduce the behavior:
 3. All configurations you used
 4. See error
 
+## Additional information
+
+**The used wiki2book version (or commit-hash)**
+
+**Used output driver (when using `pandoc` output driver: The used pandoc version)**
+
+**Any other useful and/or related information**

.gitignore

@@ -2,6 +2,7 @@
 src/src
 src/wiki2book
 wiki2book
+wiki2book-*
 .wiki2book
 *.exe
 *.exe~

README.md

@@ -28,25 +28,26 @@ But wiki2book has exactly this functionality called "projects" as described belo
 # Installation
 
 * Arch Linux: AUR package [`wiki2book`](https://aur.archlinux.org/packages/wiki2book).
-  * Default style and configs can be found in ` /usr/share/wiki2book`.
-* Others: See the [build instructions](./src#build-project).
+  * Default style and configs can be found in `/usr/share/wiki2book`.
+* Others: See the [current releases](https://github.com/hauke96/wiki2book/releases) or [build instructions](./src#build-project).
 
 # Usage
 
-Currently only a CLI version of wiki2book exists.
+Currently only a CLI (_command line interface_) version of wiki2book exists, so nothing with a GUI.
+Wiki2book need a configuration file (s. the [configs](./configs) folder), currently only a German config file exists.
 
 ## Preliminaries
 
 You need the following tools and fonts:
 
 1. ImageMagick (to have the `convert` command)
-2. Pandoc (to have the `pandoc` command). See notes on pandoc versions 2 and 3 below.
-3. *Optional:* DejaVu fonts in `/usr/share/fonts/TTF/DejaVuSans*.ttf`
-    * The DejaVuSans font is used by the default style in this repo but can be replaced to any other font.
+2. *Optional:*
+   * Pandoc (when using the `pandoc` output driver). See notes on pandoc versions 2 and 3 below.
+   * DejaVu fonts in `/usr/share/fonts/TTF/DejaVuSans*.ttf` (is used by the default style in this repo but can be replaced to any other font).
 
 ## CLI
 
-The current CLI is pretty simple and has three sub-commands:
+The CLI contains three sub-commands that generate an EPUB file from different sources (s. below for examples and details on each sub-command):
 
 1. Project: `wiki2book project ./path/to/project.json`
 2. Article: `wiki2book article "article name"`
@@ -56,63 +57,12 @@ Use `wiki2book -h` for more information and `wiki2book <command> -h` for informa
 
 ### Configuration
 
-Next to the project file (s. below), the application reads technical, project-independent and basic configurations from a JSON file (e.g. the templates to ignore), which can be specified with `--config, -c <file>`.
-See [configs/de.json](configs/de.json) for an example and [src/config/config.go](src/config/config.go) for all technical details on each possible value including their defaults.
-
-Some properties can be configured in both, the project and configuration file (such as the Wikipedia URL).
-Entries from the project file are used in case a property is given in both files.
-
-Also take a look at the [config.go](src/config/config.go) source file, which contains a lot of documentation on each config entry.
-
-### Project file
-
-When using a project, the above-mentioned `project.json` is a configuration for this project, containing e.g. the title, cover image and list of articles, and may look like this:
-
-```json
-{
-  "metadata": {
-    "title": "My great book",
-    "author": "Wikipedia contributors",
-    "license": "Creative Commons Non-Commercial Share Alike 3.0",
-    "language": "de-DE",
-    "date": "2021-12-27"
-  },
-  "cache-dir": "./path/to/cache/",
-  "wikipedia-instance": "de",
-  "output-file": "my-book.epub",
-  "output-type": "epub3",
-  "cover": "cover.png",
-  "style": "style.css",
-  "pandoc-data-dir": "./pandoc/data",
-  "articles": [
-    "Hamburg",
-    "Hamburger",
-    "Pannfisch"
-  ],
-  "font-files": [
-    "/path/to/font.ttf",
-    "/path/to/fontBold.ttf",
-    "/path/to/fontItalic.ttf"
-  ]
-}
-```
-
-There are some optional entries:
-
-* `cache-dir` (has the default value `.wiki2book`)
-* `output-type` (has the default value `epub2`)
-* `font-files`
-* `wikipedia-instance` (this value overrides the general configuration (s. above) when given)
-
-#### Use a different Wikipedia instance
-
-Per default, the english wikipedia (`en`) is used.
-However, you can change the `wikipedia-instance` entry in your projects or config file (s. above; project entries take precedence over configuration entries).
-Notice, that you also have to adjust the list of ignore templates and all other language-specific configurations.
-Take a look at the [German config file](configs/de.json) and some [German project files](projects/de/) to get an idea of a switch to a different Wikipedia instance.
+See the [config documentation](./doc/configuration.md).
 
 ### Pandoc version 2 and 3
 
+_Only relevant when using the `pandoc` output driver._
+
 Pandoc version 2 might internally use CSS3 parameters by default, such as the `gap` property.
 This might cause problems on certain eBook readers (e.g. Tolino ones).
 To overcome this, pass the argument `--pandoc-data-dir ./pandoc/data` to wiki2book, which uses a template from this repo without such problematic `gap` parameter.
@@ -146,9 +96,18 @@ Use the following command to render the file
 
 `./wiki2book standalone -c configs/de.json -s projects/style.css ./integration-tests/test-real-article-Erde.mediawiki`
 
-# Development
+# Contribute
+
+## Issues, bugs, ideas
+
+Feel free to open [a new issue](https://github.com/hauke96/wiki2book/issues/new/choose).
+But keep in mind:
+This is a hobby-project and my time is limited.
+Things with less or no use for me personally will get a lower priority.
+
+## Development
 
-For building, running, testing, etc. take a look at the `src` folder and `src/README.md`.
+For building, running, testing, etc. take a look at [`src/README.md`](src/README.md).
 
 # Long-term goals
 

build.sh

@@ -1,21 +1,21 @@
 #!/bin/bash
 
 # Get latest tag for this commit
-VERSION=$(git describe --tags --abbrev=0)
+VERSION=$(grep --color=never "VERSION = " src/main.go | grep --color=never -Po "v[\d\.]+")
 
 # Some default value
-OS=linux
+OS=all
 ARCH=amd64
 
 function usage()
 {
 	cat <<EOF
-Usage: $0 -a <arch> -o <os> [-f <output-file>]
+Usage: $0 -a <arch> -o <os> [-f <output-file>] [-h]
 
 Parameter:
   -a  Architecture of the system as golang uses them (e.g. amd64, arm64). Default: amd64.
-  -o  Operating system as golang uses them (e.g. windows, linux, darwin). Default: linux.
-  -f  Optional: Output file. If not given, then a filename including the version, arch and os is chosen.
+  -o  Operating system as golang uses them (e.g. windows, linux, darwin). Or use "all" to build for all operating systems. Default: all.
+  -f  Optional: Output file. If not given, then a filename including the version, arch and os is chosen. Will be ignored when operating system is "all".
   -h  Prints this message.
 EOF
 }
@@ -25,13 +25,14 @@ function build()
 	OS=$1
 	ARCH=$2
 	OUTPUT=$3
-	SUFFIX=""
 
 	if [[ $OS == "windows" ]]
 	then
 		OUTPUT="$OUTPUT.exe"
 	fi
 
+	echo "Build for $OS with $ARCH arch to $(realpath --relative-to=. $OUTPUT)"
+
 	# The -ldflags "-s -w" parameter makes the binary smaller by not generating symbol table and debugging information.
 	GOOS=$OS GOARCH=$ARCH go build -ldflags "-s -w" -o $OUTPUT .
 }
@@ -74,9 +75,14 @@ else
 	OUTPUT=$(realpath "wiki2book-$VERSION-$OS-$ARCH")
 fi
 
-echo "Build for $OS with $ARCH arch to $(realpath --relative-to=. $OUTPUT)"
-
 (
 	cd src
-	build $OS $ARCH $OUTPUT
+	if [[ $OS == "all" ]]
+	then
+		build "windows" $ARCH $(realpath "wiki2book-$VERSION-windows-$ARCH")
+		build "linux" $ARCH $(realpath "wiki2book-$VERSION-linux-$ARCH")
+		build "darwin" $ARCH $(realpath "wiki2book-$VERSION-darwin-$ARCH")
+	else
+		build $OS $ARCH $OUTPUT
+	fi
 )

configs/de.json

@@ -69,6 +69,9 @@
     "wikisource",
     "wiktionary"
   ],
+  "trailing-templates": [
+    "gesundheitshinweis"
+  ],
   "ignored-image-params": [
     "alt",
     "alternativtext",

doc/README.md

@@ -1,8 +1,12 @@
 This is the documentation of the codebase for *wiki2book*.
 
-# Content
+## User documentation
 
-1. [Structure & Architecture](architecture.md): Description of the overall architecture, layers and packages.
-2. [Rendering math](rendering-math.md): Documentation on how to render math code (TeX code) using the Wikipedia API.
-3. [Caches](caches.md): This tool uses its own caching infrastructure, this is why and how.
-4. [Parsing strategies](parsing.md): Descriptions of the used parsing strategies.
+* [Configuration](configuration.md): Documentation of config file, project file and CLI arguments.
+
+## Technical and internal documentation
+
+* [Structure & Architecture](architecture.md): Description of the overall architecture, layers and packages.
+* [Rendering math](rendering-math.md): Documentation on how to render math code (TeX code) using the Wikipedia API.
+* [Caches](caches.md): This tool uses its own caching infrastructure, this is why and how.
+* [Parsing strategies](parsing.md): Descriptions of the used parsing strategies.