doc: Add user and developers documentation scheme.

doc/dev/build.sh

@@ -0,0 +1,10 @@
+#! /bin/sh
+
+# Build the PDF
+
+emacs -Q -q -nw --batch                                 \
+      --eval "(require 'org)"                           \
+      --eval "(require 'ox-latex)"                      \
+      --eval "(load-file \"../tools/setup.el\")"        \
+      --file ./documentation.org                        \
+      -f org-latex-export-to-pdf

doc/dev/documentation.bib

@@ -0,0 +1 @@
+../tools/ref.bib

doc/dev/documentation.org

@@ -0,0 +1,55 @@
+# documentation.org -- Pamhyr developers documentation
+# Copyright (C) 2023  INRAE
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+# -*- coding: utf-8 -*-
+
+#+STARTUP: indent
+
+#+INCLUDE: ../tools/macro.org
+#+INCLUDE: ../tools/latex.org
+
+#+TITLE: Developers documentation
+#+SUBTITLE: Version: {{{version}}}
+#+AUTHOR: {{{INRAE}}}
+
+#+OPTIONS: toc:t
+#+LANGUAGE: UKenglish
+
+* TODO The environment
+* TODO Architecture
+** TODO Model
+** TODO Solver
+** TODO View
+** TODO Unit tests
+** TODO The debug mode
+* TODO Build the project
+** TODO Building packages
+*** TODO Linux
+*** TODO Windows
+* TODO Documentation files
+** TODO The environment
+** TODO Org-mode
+*** TODO Format
+*** TODO Macro
+*** TODO Footnote
+*** TODO References
+*** TODO Export
+* TODO How to contribute?
+** TODO Contribution rules
+** TODO Translate
+** TODO Code contribution
+
+{{{biblio}}}

doc/tools/PamhyrDoc.cls

@@ -0,0 +1,102 @@
+\ProvidesClass{Pamhyr}[Pamhyr class]
+\NeedsTeXFormat{LaTeX2e}
+\ProcessOptions\relax
+\LoadClass[11pt,a4paper]{article}
+
+\usepackage[hmargin=2cm, vmargin=3cm]{geometry}
+\usepackage[british,UKenglish,USenglish,english,american]{babel}
+\usepackage[T1]{fontenc}
+\usepackage{times}
+\usepackage[usenames,dvipsnames]{xcolor}
+\usepackage[absolute]{textpos}
+\usepackage{titlesec}
+\usepackage{amssymb}
+\usepackage{tcolorbox}
+
+\usepackage{enumitem}
+\setlist[enumerate]{itemsep=-0.5em}
+\setlist[itemize]{itemsep=-0.5em}
+
+%%
+%% Bibtex
+%%
+
+\bibliographystyle{plain}
+
+%%
+%% Colors
+%%
+
+\definecolor{primary}{HTML}{212121}
+\definecolor{lightheadings}{HTML}{5c5c5c}
+\definecolor{headings}{HTML}{212121}
+\definecolor{links}{HTML}{e12121}
+
+%%
+%% Title
+%%
+
+\setlength{\columnsep}{20pt}
+\setlength{\parskip}{0pt}      %% inter paragraph space
+
+\renewcommand{\maketitle}{
+    {
+      \centering
+      {
+        \fontsize{35}{40}
+        \selectfont
+        \scshape
+        Pamhyr2 \\
+        \medskip
+      }
+      {
+        %\centering
+        \scshape
+        \fontsize{20pt}{24pt}
+        \selectfont
+        A graphical user interface for 1D hydro-sedimentary modelling
+        of rivers \\
+        \medskip
+      }
+      \rule{3cm}{0.4pt}\\
+      \vspace{0.3cm}
+      {
+        %\centering
+        \scshape
+        \fontsize{26pt}{24pt}
+        \selectfont
+        \@title \\
+        \medskip
+      }
+      \vspace{0.3cm}
+      {
+        %\centering
+        %\scshape
+        \fontsize{14pt}{16pt}
+        \selectfont
+        © \@author \\
+        \medskip
+      }
+      {
+        %\centering
+        %\scshape
+        \fontsize{12pt}{14pt}
+        \selectfont
+        \@date
+        %\medskip
+      }\\
+      \vspace{0.3cm}
+      \rule{3cm}{0.4pt}\\
+      \vspace{0.3cm}
+      {
+        \begin{minipage}[h]{0.24\textwidth}
+          \includegraphics[width=4cm]{../../src/View/ui/ressources/Logo-INRAE.png}
+        \end{minipage}
+        \begin{minipage}[h]{0.24\textwidth}
+          \includegraphics[width=4cm]{../images/riverly.png}
+        \end{minipage}
+      }\\
+      \vspace{0.3cm}
+      %%\rule{\textwidth}{0.4pt}
+    }
+}

doc/tools/latex.org

@@ -0,0 +1,19 @@
+# latex.org -- Pamhyr documentation latex config
+# Copyright (C) 2023  INRAE
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+# -*- coding: utf-8 -*-
+
+#+LaTeX_CLASS: PamhyrDoc

doc/tools/macro.org

@@ -0,0 +1,35 @@
+# macro.org -- Pamhyr documentation macro
+# Copyright (C) 2023  INRAE
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+# -*- coding: utf-8 -*-
+
+# Constant name
+#+MACRO: oldPamhyr     PAMHyR
+#+MACRO: Pamhyr        Pamhyr2
+#+MACRO: Mage          Mage
+#+MACRO: Rubarbe       RubarBE
+#+MACRO: Inrae         INRAE
+
+# Information
+#+MACRO: version       (eval (pamhyr-version))
+#+MACRO: current-file  (eval (pamhyr-current-file))
+
+# Special format
+#+MACRO: file          =$1=
+
+# Biblio
+#+MACRO: cite          \cite{$1}
+#+MACRO: biblio        \bibliography{documentation}

doc/tools/setup.el

@@ -0,0 +1,30 @@
+(require 'org)
+(require 'subr-x)
+
+(add-to-list
+ 'org-latex-classes
+ '("PamhyrDoc"
+   "\\documentclass{../tools/PamhyrDoc}"
+   ("\\section{%s}" . "\\section*{%s}")
+   ("\\subsection{%s}" . "\\subsection*{%s}")
+   ("\\subsubsection{%s}" . "\\subsubsection*{%s}")
+   ("\\paragraph{%s}" . "\\paragraph*{%s}")
+   ("\\subparagraph{%s}" . "\\subparagraph*{%s}")))
+
+
+(setq org-latex-pdf-process
+      '("pdflatex -shell-escape -interaction nonstopmode -output-directory %o %f"
+        "bibtex documentation"
+        "pdflatex -shell-escape -interaction nonstopmode -output-directory %o %f"
+        "pdflatex -shell-escape -interaction nonstopmode -output-directory %o %f"))
+
+
+(defun pamhyr-version ()
+  "Return the contents of the pamhyr version file."
+  (with-temp-buffer
+    (insert-file-contents "../../VERSION")
+    (buffer-string)))
+
+(defun pamhyr-current-file ()
+  (let ((lst (split-string (buffer-file-name) "/")))
+    (string-join (nthcdr (- (length lst) 3) lst) "/")))

doc/users/build.sh

@@ -0,0 +1,10 @@
+#! /bin/sh
+
+# Build the PDF
+
+emacs -Q -q -nw --batch                                 \
+      --eval "(require 'org)"                           \
+      --eval "(require 'ox-latex)"                      \
+      --eval "(load-file \"../tools/setup.el\")"        \
+      --file ./documentation.org                        \
+      -f org-latex-export-to-pdf

doc/users/documentation.bib

@@ -0,0 +1 @@
+../tools/ref.bib

doc/users/documentation.org

@@ -0,0 +1,20 @@
+#+STARTUP: indent
+
+#+INCLUDE: ../tools/macro.org
+#+INCLUDE: ../tools/latex.org
+
+#+TITLE: User documentation
+#+SUBTITLE: Version: {{{version}}}
+#+AUTHOR: {{{INRAE}}}
+
+#+OPTIONS: toc:t
+#+LANGUAGE: UKenglish
+
+* TODO Over view
+* TODO Get started
+** Installation
+*** Linux
+*** Windows
+* TODO Usage
+
+{{{biblio}}}