Merge pull request #33 from arbCoding/devel

Fixed html documentation image links.
arbCoding · Dec 12, 2023 · f927246 · f927246
2 parents 1ef0bff + 05e3161
commit f927246
Show file tree

Hide file tree

Showing 23 changed files with 108 additions and 94 deletions.
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/sac-format_manual.pdf b/docs/sac-format_manual.pdf
diff --git a/screenshots/Windows/intro_install.png → docs/screenshots/Windows/intro_install.png b/screenshots/Windows/intro_install.png → docs/screenshots/Windows/intro_install.png
diff --git a/screenshots/Windows/location_install.png → .../screenshots/Windows/location_install.png b/screenshots/Windows/location_install.png → .../screenshots/Windows/location_install.png
diff --git a/screenshots/Windows/no_shortcuts_install.png → ...eenshots/Windows/no_shortcuts_install.png b/screenshots/Windows/no_shortcuts_install.png → ...eenshots/Windows/no_shortcuts_install.png
diff --git a/screenshots/Windows/successful_install.png → ...creenshots/Windows/successful_install.png b/screenshots/Windows/successful_install.png → ...creenshots/Windows/successful_install.png
diff --git a/screenshots/Windows/warning_1_install.png → ...screenshots/Windows/warning_1_install.png b/screenshots/Windows/warning_1_install.png → ...screenshots/Windows/warning_1_install.png
diff --git a/screenshots/Windows/warning_2_install.png → ...screenshots/Windows/warning_2_install.png b/screenshots/Windows/warning_2_install.png → ...screenshots/Windows/warning_2_install.png
diff --git a/screenshots/macOS/intro_install.png → docs/screenshots/macOS/intro_install.png b/screenshots/macOS/intro_install.png → docs/screenshots/macOS/intro_install.png
diff --git a/screenshots/macOS/successful_install.png → .../screenshots/macOS/successful_install.png b/screenshots/macOS/successful_install.png → .../screenshots/macOS/successful_install.png
diff --git a/screenshots/macOS/warning_install.png → docs/screenshots/macOS/warning_install.png b/screenshots/macOS/warning_install.png → docs/screenshots/macOS/warning_install.png
diff --git a/scripts/make_docs.el b/scripts/make_docs.el
@@ -21,12 +21,26 @@
          :base-extension "org"
          :publishing-directory "./docs/"
          :publishing-function org-html-publish-to-html)
+        ("png-windows"
+         :base-directory "./src/docs/screenshots/Windows"
+         :base-extension "png"
+         :publishing-directory "./docs/screenshots/Windows"
+         :publishing-function org-publish-attachment)
+        ("png-macos"
+         :base-directory "./src/docs/screenshots/macOS"
+         :base-extension "png"
+         :publishing-directory "./docs/screenshots/macOS"
+         :publishing-function org-publish-attachment)
         ("pdf"
          :base-directory "./src/docs"
          :base-extension "org"
          :publishing-directory "./docs/"
          :publishing-function org-latex-publish-to-pdf)
-        ("arbCoding.github.io/sac-format" :components ("html", "pdf"))))
+        ("arbCoding.github.io/sac-format"
+         :components ("html",
+                      "png-windows",
+                      "png-macos",
+                      "pdf"))))
 
 ;; Generate the site output
 (org-publish-all t)

diff --git a/src/docs/index.org b/src/docs/index.org
@@ -153,43 +153,43 @@ By default, Microsoft Defender will block the installer with a pop-up like that
 #+attr_org: :width 200px
 #+attr_html: :width 350px
 #+attr_latex: :width 200px
-[[file:~/my_git/sac-format/screenshots/Windows/warning_1_install.png]]
+[[file:./screenshots/Windows/warning_1_install.png]]
 
 To continue the install, click on the 'More Info' link and then the 'Run anyway'
 button as seen in the following image:
 
 #+attr_org: :width 200px
 #+attr_html: :width 350px
 #+attr_latex: :width 200px
-[[file:~/my_git/sac-format/screenshots/Windows/warning_2_install.png]]
+[[file:./screenshots/Windows/warning_2_install.png]]
 
 Then the installer will open and present you with the welcome screen:
 
 #+attr_org: :width 300px
 #+attr_html: :width 500px
 #+attr_latex: :width 300px
-[[file:~/my_git/sac-format/screenshots/Windows/intro_install.png]]
+[[file:./screenshots/Windows/intro_install.png]]
 
 By default, sac-format installs in =C:/Program Files/sac-format= as seen in the screen below:
 
 #+attr_org: :width 300px
 #+attr_html: :width 500px
 #+attr_latex: :width 300px
-[[file:~/my_git/sac-format/screenshots/Windows/location_install.png]]
+[[file:./screenshots/Windows/location_install.png]]
 
 Because all programs in sac-format are command-line based feel free to disable Start Menu shortcuts:
 
 #+attr_org: :width 300px
 #+attr_html: :width 500px
 #+attr_latex: :width 300px
-[[file:~/my_git/sac-format/screenshots/Windows/no_shortcuts_install.png]]
+[[file:./screenshots/Windows/no_shortcuts_install.png]]
 
 Upon successful install of sac-format you will see this window:
 
 #+attr_org: :width 300px
 #+attr_html: :width 500px
 #+attr_latex: :width 300px
-[[file:~/my_git/sac-format/screenshots/Windows/successful_install.png]]
+[[file:./screenshots/Windows/successful_install.png]]
 
 *** macOS
 
@@ -206,19 +206,19 @@ By default, macOS will block the installer. To install, right-click on
 #+attr_org: :width 250px
 #+attr_html: :width 400px
 #+attr_latex: :width 250px
-[[file:~/my_git/sac-format/screenshots/macOS/warning_install.png]]
+[[file:./screenshots/macOS/warning_install.png]]
 
 Simply click 'Open' and the installer will begin from the first screen:
 #+attr_org: :width 400px
 #+attr_html: :width 600px
 #+attr_latex: :width 400px
-[[file:~/my_git/sac-format/screenshots/macOS/intro_install.png]]
+[[file:./screenshots/macOS/intro_install.png]]
 
 Upon successfull installation you will see:
 #+attr_org: :width 400px
 #+attr_html: :width 600px
 #+attr_latex: :width 400px
-[[file:~/my_git/sac-format/screenshots/macOS/successful_install.png]]
+[[file:./screenshots/macOS/successful_install.png]]
 
 **** Command line
 

diff --git a/src/docs/screenshots/Windows/intro_install.png b/src/docs/screenshots/Windows/intro_install.png
diff --git a/src/docs/screenshots/Windows/location_install.png b/src/docs/screenshots/Windows/location_install.png
diff --git a/src/docs/screenshots/Windows/no_shortcuts_install.png b/src/docs/screenshots/Windows/no_shortcuts_install.png
diff --git a/src/docs/screenshots/Windows/successful_install.png b/src/docs/screenshots/Windows/successful_install.png
diff --git a/src/docs/screenshots/Windows/warning_1_install.png b/src/docs/screenshots/Windows/warning_1_install.png
diff --git a/src/docs/screenshots/Windows/warning_2_install.png b/src/docs/screenshots/Windows/warning_2_install.png
diff --git a/src/docs/screenshots/macOS/intro_install.png b/src/docs/screenshots/macOS/intro_install.png
diff --git a/src/docs/screenshots/macOS/successful_install.png b/src/docs/screenshots/macOS/successful_install.png
diff --git a/src/docs/screenshots/macOS/warning_install.png b/src/docs/screenshots/macOS/warning_install.png
diff --git a/todo.org b/todo.org
@@ -63,13 +63,13 @@ leven(false) and iftype(<1), but data2 exists, clear it.
 **** TODO depmin/depmen/depmax
 *** TODO String setters should be limited in length
 Same rules apply as for the strings themselves.
-** TODO Installers
+** DONE Installers
 *** DONE Windows
 *** DONE macOS
-*** TODO Linux
+*** DONE Linux
 **** DONE Gzipped Tar Archive
-**** TODO RPM
-**** TODO DEB
+**** DONE RPM
+**** DONE DEB
 ** DONE Refactor Trace :refactor:
 *** DONE Remove boost dependency
 The only reason I need boost is for boost::algorithm::trim(); to remove leading