Differences

This shows you the differences between two versions of the page.

--- kb:common:asciidoctor [2022/03/17 14:08] – created joerg.hampel
+++ kb:common:asciidoctor [2025/03/12 12:55] (current) – [Asciidoctor] alexander.elbert
@@ Line 1: / Line 1: @@
 ====== Asciidoctor ======
+===== Manual Installation =====
+==== Ruby ====
+On Windows:
+  * https://rubyinstaller.org/downloads/
+    * as of 2025-03-12: ''rubyinstaller-3.4.2-1-x64'' (without devkit)
+    * **install for local user only**
+    * install MSYS2 base installation
+    * **reboot computer!**
+On RHEL:
+Disable default Ruby AppStream module on your system
+    $ sudo dnf module reset ruby -y
+To specify the module version, use the command:
+    $ sudo yum install @ruby:3.1
+==== Asciidoctor ====
+//Asciidoctor is a Ruby tool and is therefore installed via Ruby's packet manager ''gem''//
+  * https://asciidoctor.org/
+  * https://asciidoctor.org/docs/asciidoctor-diagram/
+  * https://asciidoctor.org/docs/asciidoctor-pdf/
+In the windows menu look for ''Start Command Prompt with Ruby'' and execute the following commands:
+     $ gem install asciidoctor
+     $ gem install asciidoctor-diagram                     OR:       gem install asciidoctor-kroki
+     $ gem install asciidoctor-pdf
+<WRAP left round download 100%>
+For RAT: Generation of the diagrams will either take place via the ruby gem asciidoctor-diagram or asciidoctor-kroki. This can be configured via [[code:commercial:rat:tools:documentr#configuration|a documentr variable]].
+asciidoctor-diagram requires java and graphviz and asciidoctor-kroki requires communication to a kroki server.
+</WRAP>
+== Offline Installation of gems ==
+If no direct network connection is available, you can use [[https://bundler.io|Bundler.io]] to export packages and their dependencies from an online PC.
+. [[https://rubygems.org/gems/bundler|Download bundler from rubygems]] (latest version at the moment is v2.5.7) and install it locally via
+    $ gem install --force --local bundler-2.5.7.gem
+. Download our ready-made [[https://download.hampel-soft.com/ProjectSend/download.php?id=140&token=7jHDJKiK7dpRNKqBZyudhk6rrZM3681o|Bundler package for local (offline) installation]] containing all necessary gems. Extract the archive to a local directory.
+. Run the following command from the above directory where the ''Gemfile'', ''Gemfile.lock'' and the ''/vendor/cache/'' subdirectory are available:
+    $ bundle install --local
+====== Package based Installation (Linux) ======
+Example based on Red Hat Enterprise Linux 8.7.
+   $ sudo dnf install asciidoc
+<note important>It's not yet clear if further steps are necessary to install ''asciidoctor-diagram'' and ''asciidoctor-pdf''.</note>
+=== PlantUML / GraphViz ===
+See [[kb:common:plantuml|PlantUML]]