commit da4f1f13783b05c1db70ee57d372b56f2c99d65e parent bd976fc0cbfe248547978074c87819d1fa885d12 Author: Vincent Forest <vincent.forest@meso-star.com> Date: Thu, 16 Nov 2023 10:48:09 +0100 Major update to web page editing The navigation menu, historically positioned to the right of the page visited, is now located at the top of the page. The menu used to have 3 levels, but now has only 2, displayed horizontally rather than vertically. The 3rd level, when necessary, is replaced by a web page listing the links to the corresponding pages. This was already the case for the htrdr manual pages. This change, beyond its subjective aesthetic character, is motivated by navigation constraints. The side-mounted menu had a fixed size, which didn't sit well on a screen that was taller than it was wide, as is the default on cell phones. Only the web page could be resized, and then its display was particularly tight. A horizontal menu at the top of a page no longer suffers from this problem, and is much better displayed in a text browser. It's worth noting that the previous layout allowed information to be added directly to the menu, such as a project's funding history. This is no longer possible, and such information is now added to the overview pages, in a specific section called history. The second-level menu now allows you to choose the language of the pages which offers several translations. Last but not least, the CSS style has been refreshed without altering the overall appearance of the site, which retains the same graphic charter. Diffstat:
27 files changed, 400 insertions(+), 341 deletions(-)
diff --git a/convert_man.sh b/convert_man.sh @@ -34,8 +34,6 @@ man_section=$(echo "${input}" \ { print_header -s "${section}" -n "${man_name}" -r ../../../ - echo "<div style=\"font-variant: small-caps; float: right; color: #777777\">" - echo "${section} ${version}</div>"; echo "<header>" echo " <h1>${man_name}(${man_section})</h1>"; echo "</header>" diff --git a/htrdr/htrdr-docs.html.in b/htrdr/htrdr-docs.html.in @@ -10,53 +10,53 @@ <div class=column> <h3>Main commands</h3> <ul> - <li><a href=man/man1/htrdr.1.html>htrdr</a></li> - <li><a href=man/man1/htrdr-atmosphere.1.html>htrdr-atmosphere</a></li> - <li><a href=man/man1/htrdr-combustion.1.html>htrdr-combustion</a></li> - <li><a href=man/man1/htrdr-planeto.1.html>htrdr-planeto</a></li> + <li><a href=man/man1/htrdr.1.html>htrdr(1)</a></li> + <li><a href=man/man1/htrdr-atmosphere.1.html>htrdr-atmosphere(1)</a></li> + <li><a href=man/man1/htrdr-combustion.1.html>htrdr-combustion(1)</a></li> + <li><a href=man/man1/htrdr-planeto.1.html>htrdr-planeto(1)</a></li> </ul> <h3>Additional tools</h3> <ul> - <li><a href=man/man1/htpp.1.html>htpp</a></li> - <li><a href=man/man1/les2htcp.1.html>les2htcp</a></li> + <li><a href=man/man1/htpp.1.html>htpp(1)</a></li> + <li><a href=man/man1/les2htcp.1.html>les2htcp(1)</a></li> </ul> <h3>Common file formats</h3> <ul> - <li><a href=man/man5/htrdr-image.5.html>htrdr-image</a></li> - <li><a href=man/man5/htrdr-materials.5.html>htrdr-materials</a></li> - <li><a href=man/man5/htrdr-obj.5.html>htrdr-obj</a></li> - <li><a href=man/man5/mrumtl.5.html>mrumtl</a></li> - <li><a href=man/man5/sars.5.html>sars</a> - <li><a href=man/man5/sbuf.5.html>sbuf</a></li> - <li><a href=man/man5/sck.5.html>sck</a></li> - <li><a href=man/man5/smsh.5.html>smsh</a></li> + <li><a href=man/man5/htrdr-image.5.html>htrdr-image(5)</a></li> + <li><a href=man/man5/htrdr-materials.5.html>htrdr-materials(5)</a></li> + <li><a href=man/man5/htrdr-obj.5.html>htrdr-obj(5)</a></li> + <li><a href=man/man5/mrumtl.5.html>mrumtl(5)</a></li> + <li><a href=man/man5/sars.5.html>sars(5)</a> + <li><a href=man/man5/sbuf.5.html>sbuf(5)</a></li> + <li><a href=man/man5/sck.5.html>sck(5)</a></li> + <li><a href=man/man5/smsh.5.html>smsh(5)</a></li> </ul> </div> <div class=column> <h3>Describe a plane parallel atmosphere</h3> <ul> - <li><a href=man/man5/htmie.5.html>htmie</a></li> - <li><a href=man/man5/htcp.5.html>htcp</a></li> + <li><a href=man/man5/htmie.5.html>htmie(5)</a></li> + <li><a href=man/man5/htcp.5.html>htcp(5)</a></li> <li><a href="downloads/gas_opt_prop_en.pdf">htgop</a> [pdf]</li> </ul> <h3>Describe a combustion medium</h3> <ul> - <li><a href=man/man5/atrri.5.html>atrri</a></li> - <li><a href=man/man5/atrtp.5.html>atrtp</a></li> + <li><a href=man/man5/atrri.5.html>atrri(5)</a></li> + <li><a href=man/man5/atrtp.5.html>atrtp(5)</a></li> </ul> <h3>Describe a terrestrial planet</h3> <ul> - <li><a href=man/man5/rngt.5.html>rngt</a> - <li><a href=man/man5/rnpfi.5.html>rnpfi</a> - <li><a href=man/man5/rnrl.5.html>rnrl</a> - <li><a href=man/man5/rnsf.5.html>rnsf</a> - <li><a href=man/man5/rnsl.5.html>rnsl</a> - <li><a href=man/man5/rnsp.5.html>rnsp</a> + <li><a href=man/man5/rngt.5.html>rngt(5)</a> + <li><a href=man/man5/rnpfi.5.html>rnpfi(5)</a> + <li><a href=man/man5/rnrl.5.html>rnrl(5)</a> + <li><a href=man/man5/rnsf.5.html>rnsf(5)</a> + <li><a href=man/man5/rnsl.5.html>rnsl(5)</a> + <li><a href=man/man5/rnsp.5.html>rnsp(5)</a> </ul> </div> </div> diff --git a/htrdr/htrdr.html.in b/htrdr/htrdr.html.in @@ -407,4 +407,25 @@ that are good starting points to use <code>htrdr</code>. ${RELEASE_NOTES} +<h2>History</h2> + +<p><code>htrdr</code> has been funded by the <a +href="https://anr.fr/Projet-ANR-21-CE49-0020">ANR Rad-Net</a> since +2021. |Méso|Star> is subcontractor of the project.</p> + +<p><code>htrdr</code> was funded by the <a +href="https://anr.fr/Project-ANR-18-CE05-0015">ANR Astoria</a> from 2018 +to 2022. |Méso|Star> was sub-contractor of the project.</p> + +<p><code>htrdr</code> was funded by the <a +href="https://www.ademe.fr/">ADEME</a> (MODEVAL-URBA-2019) from 2019 to +2022. |Méso|Star> was partner of the project with <a +href="https://www.umr-cnrm.fr/">CNRM</a>.</p> + +<p><code>htrdr</code> was funded by the <a +href="https://anr.fr/Project-ANR-16-CE01-0010">ANR High-Tune</a> from +2016 to 2019. |Méso|Star> was sub-contractor of the project. Visit +the <a href="http://www.umr-cnrm.fr/high-tune/?lang=en"> High-Tune +project web site</a>.</p> + ${COPYING} diff --git a/htrdr/htrdr_build.sh b/htrdr/htrdr_build.sh @@ -167,7 +167,7 @@ atmspk() echo "<h2>Donwloads</h2>" - echo "<table>" + echo "<table class=\"list\">" echo " <tr>" echo " <th>Version</th>" echo " <th>Archive</th>" @@ -284,7 +284,7 @@ comspk() echo "<h2>Donwloads</h2>" - echo "<table>" + echo "<table class=\"list\">" echo " <tr>" echo " <th>Version</th>" echo " <th>Archive</th>" diff --git a/meso-menu.sh b/meso-menu.sh @@ -34,294 +34,274 @@ export stardis_man_pages="\ sgreen-input 5 sgreen-output 5" -print_home_sub_menu() { +print_home_sub_menu() +{ root=$1 name=$2 + lang=$3 - echo " <div id=\"sub-menu\">" - echo " <ul>" + echo "<div id=\"sub-menu\">" if [ "${name}" = "About" ]; then - echo " <li id=\"cur\">About</li>" + page="about" + echo " <span class=\"cur\">About</span>" else - echo " <li><a href=\"${root}misc/about-fr.html\">About</a></li>" + echo " <a href=\"${root}misc/about-fr.html\">About</a>" fi + echo "  . " if [ "${name}" = "PGP" ]; then - echo " <li id=\"cur\">PGP signatures</li>" + echo " <span class=\"cur\">PGP</span>" else - echo " <li><a href=\"${root}misc/pgp_signatures.html\">PGP signatures</a></li>" + echo " <a href=\"${root}misc/pgp_signatures.html\">PGP</a>" fi + echo "  . " if [ "${name}" = "Legal" ]; then - echo " <li id=\"cur\">Legal notices</li>" + page="legal" + echo " <span class=\"cur\">Legal notices</span>" else - echo " <li><a href=\"${root}misc/legal-fr.html\">Legal notices</a></li>" + echo " <a href=\"${root}misc/legal-fr.html\">Legal notices</a>" fi - echo " </ul>" - echo " </div>" + + if [ "${name}" = "About" ] \ + || [ "${name}" = "Legal" ]; then + echo "<span style=\"float: right;\">" + if [ "${lang}" = "fr" ]; then + echo "<span class=\"cur\">fr</span>" + else + echo "<a href=\"${root}misc/${page}-fr.html\">fr</a>" + fi + echo "/" + if [ "${lang}" = "en" ]; then + echo "<span class=\"cur\">en</span>" + else + echo "<a href=\"${root}misc/${page}-en.html\">en</a>" + fi + echo "</span>" + fi + echo "</div>" } -print_art_sub_menu() { +print_art_sub_menu() +{ root=$1 name=$2 - echo " <div id=\"sub-menu\">" - echo " <ul>" + echo "<div id=\"sub-menu\">" if [ "${name}" = "Overview" ]; then - echo ' <li id=cur>Overview</li>' + echo " <span class=\"cur\">Overview</span>" else - echo " <li><a href=\"${root}art/art.html\">Overview</a></li>" + echo " <a href=\"${root}art/art.html\">Overview</a>" fi - echo " <li>Codes" - echo " <ul class=\"lvl2\">" + echo "  . " if [ "${name}" = "Kspectrum" ]; then - echo " <li id=\"cur\">Kspectrum</li>" + echo " <span class=\"cur\">Kspectrum</span>" else - echo " <li><a href=\"${root}art/kspectrum.html\">Kspectrum</a></li>" + echo " <a href=\"${root}art/kspectrum.html\">Kspectrum</a>" fi + echo "  . " if [ "${name}" = "Kdistribution" ]; then - echo " <li id=\"cur\">Kdistribution</li>" + echo " <span class=\"cur\">Kdistribution</span>" else - echo " <li><a href=\"${root}art/kdistribution.html\">Kdistribution</a></li>" + echo " <a href=\"${root}art/kdistribution.html\">Kdistribution</a>" fi + echo "  . " if [ "${name}" = "HR_PPart" ]; then - echo " <li id=\"cur\">HR_PPart</li>" + echo " <span class=\"cur\">HR_PPart</span>" else - echo " <li><a href=\"${root}art/hr_ppart.html\">HR_PPart</a></li>" + echo " <a href=\"${root}art/hr_ppart.html\">HR_PPart</a>" fi + echo "  . " if [ "${name}" = "PPart_LW" ]; then - echo " <li id=\"cur\">PPart_LW</li>" + echo " <span class=\"cur\">PPart_LW</span>" else - echo " <li><a href=\"${root}art/ppart_lw.html\">PPart_LW</a></li>" + echo " <a href=\"${root}art/ppart_lw.html\">PPart_LW</a>" fi + echo "  . " if [ "${name}" = "PPart_SW" ]; then - echo " <li id=\"cur\">PPart_SW</li>" + echo " <span class=\"cur\">PPart_SW</span>" else - echo " <li><a href=\"${root}art/ppart_sw.html\">PPart_SW</a></li>" + echo " <a href=\"${root}art/ppart_sw.html\">PPart_SW</a>" fi + echo "  . " if [ "${name}" = "Karine" ]; then - echo " <li id=\"cur\">Karine</li>" + echo " <span class=\"cur\">Karine</span>" else - echo " <li><a href=\"${root}art/karine.html\">Karine</a></li>" + echo " <a href=\"${root}art/karine.html\">Karine</a>" fi - echo " </ul>" - echo " </li>" - echo " </ul>" - echo " </div>" + echo "</div>" } - -print_htrdr_sub_menu() { +print_htrdr_sub_menu() +{ root=$1 name=$2 - echo " <div id=\"sub-menu\">" - echo " <ul>" + echo "<div id=\"sub-menu\">" if [ "${name}" = "Overview" ]; then - echo " <li id=\"cur\">Overview</li>" + echo " <span class=\"cur\">Overview</span>" else - echo " <li><a href=\"${root}htrdr/htrdr.html\">Overview</a></li>" + echo " <a href=\"${root}htrdr/htrdr.html\">Overview</a>" fi + echo "  . " if [ "${name}" = "Mods" ]; then - echo " <li id=\"cur\">Modifications</li>" + echo " <span class=\"cur\">Modifications</span>" else - echo " <li><a href=\"${root}htrdr/htrdr-mods.html\">Modifications</a></li>" + echo " <a href=\"${root}htrdr/htrdr-mods.html\">Modifications</a>" fi + echo "  . " if [ "${name}" = "Documentations" ]; then - echo " <li id=\"cur\">Manual pages</li>" + echo " <span class=\"cur\">Manual pages</span>" else - echo " <li><a href=\"${root}htrdr/htrdr-docs.html\">Manual pages</a></li>" + echo " <a href=\"${root}htrdr/htrdr-docs.html\">Manual pages</a>" fi - echo " <li>Starter Pack" - echo " <ul class=\"lvl2\">" + echo "  . " if [ "${name}" = "Atmosphere-Starter-Pack" ]; then - echo " <li id=\"cur\">Atmosphere</li>" + echo " <span class=\"cur\">Atmosphere</span>" else - echo " <li><a href=\"${root}htrdr/htrdr-atmosphere-spk.html\">Atmosphere</a></li>" + echo " <a href=\"${root}htrdr/htrdr-atmosphere-spk.html\">Atmosphere</a>" fi + echo "  . " if [ "${name}" = "Combustion-Starter-Pack" ]; then - echo " <li id=\"cur\">Combustion</li>" - else - echo " <li><a href=\"${root}htrdr/htrdr-combustion-spk.html\">Combustion</a></li>" - fi -# if [ "${name}" = "Planeto-Starter-Pack" ]; then -# echo " <li id=\"cur\">Planeto</li>" -# else -# echo " <li><a href=\"${root}htrdr/htrdr-planeto-spk.html\">Planeto</a></li>" -# fi - echo " </ul>" - echo " </li>" - echo " <li><a href=\"https://gitlab.com/meso-star/htrdr\">Git repository</a></li>" - echo " </ul>" - echo " <div id=\"info\">" - echo " <p>htrdr has been funded by the <a" - echo " href=\"https://anr.fr/Projet-ANR-21-CE49-0020\">ANR Rad-Net</a> since" - echo " 2021. |Méso|Star> is subcontractor of the project.</p>" - echo " <p>htrdr was funded by the <a" - echo " href=\"https://anr.fr/Project-ANR-18-CE05-0015\">ANR Astoria</a> from 2018 to" - echo " 2022. |Méso|Star> was sub-contractor of the project.</p>" - echo " <p>htrdr was funded by the <a href=\"https://www.ademe.fr/\">ADEME</a>" - echo " (MODEVAL-URBA-2019) from 2019 to 2022. |Méso|Star> was partner of the" - echo " project with <a href=\"https://www.umr-cnrm.fr/\">CNRM</a>.</p>" - echo " <p>htrdr was funded by the <a" - echo " href=\"https://anr.fr/Project-ANR-16-CE01-0010\">ANR High-Tune</a> from" - echo " 2016 to 2019. |Méso|Star> was sub-contractor of the project. Visit" - echo " the <a href=\"http://www.umr-cnrm.fr/high-tune/?lang=en\"> High-Tune" - echo " project web site</a>.</p>" - echo " </div>" - echo " </div>" + echo " <span class=\"cur\">Combustion</span>" + else + echo " <a href=\"${root}htrdr/htrdr-combustion-spk.html\">Combustion</a>" + fi + #echo "  . " + #if [ "${name}" = "Planeto-Starter-Pack" ]; then + # echo " <span class=\"cur\">Planeto</span>" + #else + # echo " <a href=\"${root}htrdr/98190c985935c7677a43f15724e3212d100eb58da4afaa5efc87a0ffdfe2127a.html\">Planeto</a>" + #fi + echo "  . " + echo " <a href=\"https://gitlab.com/meso-star/htrdr\">Git</a>" + echo "</div>" } -print_schiff_sub_menu() { +print_schiff_sub_menu() +{ root=$1 name=$2 - echo " <div id=\"sub-menu\">" - echo " <ul>" + echo "<div id=\"sub-menu\">" if [ "${name}" = "Overview" ]; then - echo " <li id=\"cur\">Overview</li>" + echo " <span class=\"cur\">Overview</span>" else - echo " <li><a href=\"${root}schiff/schiff.html\">Overview</a></li>" + echo " <a href=\"${root}schiff/schiff.html\">Overview</a>" fi - echo " <li>Reference documentation" - echo " <ul class=\"lvl2\">" - printf "%s\n" "${schiff_man_pages}" | \ - while read -r i; do - man=$(printf "%s" "${i}" | awk '{print $1}') - section=$(printf "%s" "${i}" | awk '{print $2}') - if [ "${name}" = "${man}" ]; then - echo " <li id=\"cur\">${name}</li>" - else - link_path="${root}schiff/man/man${section}/${man}.${section}.html" - echo " <li><a href=\"${link_path}\">${man}</a></li>" - fi - done - echo " </ul>" - echo " </li>" + echo "  . " + if [ "${name}" = "Documentations" ]; then + echo " <span class=\"cur\">Manual pages</span>" + else + echo " <a href=\"${root}schiff/schiff-docs.html\">Manual pages</a>" + fi + echo "  . " if [ "${name}" = "Downloads" ]; then - echo " <li id=\"cur\">Downloads</li>" + echo " <span class=\"cur\">Downloads</span>" else - echo " <li><a href=\"${root}schiff/schiff-downloads.html\">Downloads</a></li>" + echo " <a href=\"${root}schiff/schiff-downloads.html\">Downloads</a>" fi - echo " <li><a href=\"https://gitlab.com/meso-star/schiff\">Git repository</a></li>" - echo " </ul>" - echo " </div>" + echo "  . " + echo " <a href=\"https://gitlab.com/meso-star/schiff\">Git</a>" + echo "</div>" } -print_solstice_sub_menu() { +print_solstice_sub_menu() +{ root=$1 name=$2 - echo " <div id=\"sub-menu\">" - echo " <ul>" + echo "<div id=\"sub-menu\">" if [ "${name}" = "Overview" ]; then - echo " <li id=\"cur\">Overview</li>" + echo " <span class=\"cur\">Overview</span>" else - echo " <li><a href=\"${root}solstice/solstice.html\">Overview</a></li>" + echo " <a href=\"${root}solstice/solstice.html\">Overview</a>" fi - echo " <li>Reference documentation" - echo " <ul class=\"lvl2\">" - - printf "%s\n" "${solstice_man_pages}" | \ - while read -r i; do - man=$(printf "%s" "${i}" | awk '{print $1}') - section=$(printf "%s" "${i}" | awk '{print $2}') - if [ "${name}" = "${man}" ]; then - echo " <li id=\"cur\">${name}</li>" - else - link_path="${root}solstice/man/man${section}/${man}.${section}.html" - echo " <li><a href=\"${link_path}\">${man}</a></li>" - fi - done - - echo " </ul>" - echo " </li>" + echo "  . " + if [ "${name}" = "Documentations" ]; then + echo " <span class=\"cur\">Manual pages</span>" + else + echo " <a href=\"${root}solstice/solstice-docs.html\">Manual pages</a>" + fi + echo "  . " if [ "${name}" = "Downloads" ]; then - echo " <li id=\"cur\">Downloads</li>" + echo " <span class=\"cur\">Downloads</span>" else - echo " <li><a href=\"${root}solstice/solstice-downloads.html\">Downloads</a></li>" + echo " <a href=\"${root}solstice/solstice-downloads.html\">Downloads</a>" fi + echo "  . " if [ "${name}" = "Resources" ]; then - echo " <li id=\"cur\">Additional resources</li>" + echo " <span class=\"cur\">Additional resources</span>" else - echo " <li><a href=\"${root}solstice/solstice-resources.html\">Additional resources</a></li>" + echo " <a href=\"${root}solstice/solstice-resources.html\">Additional resources</a>" fi - echo " <li><a href=\"https://gitlab.com/meso-star/solstice\">Git repository</a></li>" - echo " </ul>" - echo " <div id=\"info\">" - echo " <p>Solstice was funded by the LABEX Solstice from 2016 to 2017." - echo " Visit the <a href=\"https://www.labex-solstice.fr/solstice-software\">" - echo " LABEX Solstice web page</a> for complementary informations and examples.</p>" - echo " </div>" - echo " </div>" + echo "  . " + echo " <a href=\"https://gitlab.com/meso-star/solstice\">Git</a>" + echo "</div>" } -print_stardis_sub_menu() { +print_stardis_sub_menu() +{ root=$1 name=$2 + lang=$3 - echo " <div id=\"sub-menu\">" - echo " <ul>" + echo "<div id=\"sub-menu\">" if [ "${name}" = "Overview" ]; then - echo " <li id=\"cur\">Overview</li>" + echo " <span class=\"cur\">Overview</span>" else - echo " <li><a href=\"${root}stardis/stardis.html\">Overview</a></li>" + echo " <a href=\"${root}stardis/stardis.html\">Overview</a>" fi + echo "  . " if [ "${name}" = "Validation" ]; then - echo " <li id=\"cur\">Validation</li>" + echo " <span class=\"cur\">Validation</span>" else - echo " <li><a href=\"${root}stardis/validation.html\">Validation</a></li>" + echo " <a href=\"${root}stardis/validation.html\">Validation</a>" fi + echo "  . " if [ "${name}" = "Consortium" ]; then - echo " <li id=\"cur\">Consortium</li>" + echo " <span class=\"cur\">Consortium</span>" else - echo " <li><a href=\"${root}stardis/consortium-fr.html\">Consortium</a></li>" + echo " <a href=\"${root}stardis/consortium-fr.html\">Consortium</a>" fi - echo " <li>Reference documentation" - echo " <ul class=lvl2>" - - printf "%s\n" "${stardis_man_pages}" | \ - while read -r i; do - man=$(printf "%s" "${i}" | awk '{print $1}') - section=$(printf "%s" "${i}" | awk '{print $2}') - if [ "${name}" = "${man}" ]; then - echo " <li id=cur>${name}</li>" - else - link_path="${root}stardis/man/man${section}/${man}.${section}.html" - echo " <li><a href=\"${link_path}\">${man}</a></li>" - fi - done - echo " </ul>" - echo " </li>" - - if [ "${name}" = "Starter-Pack" ]; then - echo " <li id=cur>Starter Pack</li>" + echo "  . " + if [ "${name}" = "Documentations" ]; then + echo " <span class=\"cur\">Manual pages</span>" else - echo " <li><a href=${root}stardis/starter-pack.html>Starter Pack</a></li>" + echo " <a href=\"${root}stardis/stardis-docs.html\">Manual pages</a>" fi - echo " <li>Release notes" - echo " <ul class=lvl2>" - if [ "${name}" = "Stardis Solver Release Notes" ]; then - echo "<li id=cur>Stardis-Solver</li>" + echo "  . " + if [ "${name}" = "Starter-Pack" ]; then + echo " <span class=\"cur\">Starter Pack</span>" else - echo " <li><a href=\"${root}stardis/stardis-solver-release-notes.html\">Stardis-Solver</a></li>" + echo " <a href=${root}stardis/starter-pack.html>Starter Pack</a>" fi - if [ "${name}" = "Stardis Release Notes" ]; then - echo "<li id=cur>Stardis CLI</li>" + echo "  . " + if [ "${name}" = "Release notes" ]; then + echo " <span id=cur>Release notes</span>" else - echo " <li><a href=\"${root}stardis/stardis-release-notes.html\">Stardis CLI</a></li>" + echo " <a href=\"${root}stardis/release-notes.html\">Release notes</a>" fi - if [ "${name}" = "Stardis Green Release Notes" ]; then - echo "<li id=cur>Stardis Green</li>" - else - echo " <li><a href=\"${root}stardis/sgreen-release-notes.html\">Stardis-Green</a></li>" + + if [ "${name}" = "Consortium" ]; then + echo "<span style=\"float: right;\">" + if [ "${lang}" = "fr" ]; then + echo "<span class=\"cur\">fr</span>" + else + echo "<a href=\"${root}stardis/consortium-fr.html\">fr</a>" + fi + echo "/" + if [ "${lang}" = "en" ]; then + echo "<span class=\"cur\">en</span>" + else + echo "<a href=\"${root}stardis/consortium-en.html\">en</a>" + fi + echo "</span>" fi - echo " </ul>" - echo " </li>" - echo " </ul>" - echo " </div>" + echo "</div>" } -print_star_engine_sub_menu() { +print_star_engine_sub_menu() +{ root=$1 name=$2 components="\ @@ -336,7 +316,7 @@ print_star_engine_sub_menu() { echo " <div id=\"sub-menu\">" echo " <ul>" if [ "${name}" = "Overview" ]; then - echo " <li id=\"cur\">Overview</li>" + echo " <li class=\"cur\">Overview</li>" else echo " <li><a href=\"${root}star-engine/star-engine.html\">Overview</a></li>" fi @@ -348,7 +328,7 @@ print_star_engine_sub_menu() { page=$(printf "%s" "${i}" | awk '{print $1}') section=$(printf "%s" "${i}" | awk '{print $2}') if [ "${name}" = "${page}" ]; then - echo " <li id=\"cur\">${section}</li>" + echo " <li class=\"cur\">${section}</li>" else page_low=$(echo "${page}" | tr '[:upper:]' '[:lower:]') printf " <li><a href=\"%sstar-engine/%s.html\">%s</a></li>" \ @@ -359,7 +339,7 @@ print_star_engine_sub_menu() { echo " </ul>" echo " </li>" if [ "${name}" = "Downloads" ]; then - echo " <li id=\"cur\">Downloads</li>" + echo " <li class=\"cur\">Downloads</li>" else echo " <li><a href=\"${root}star-engine/star-engine-downloads.html\">Downloads</a></li>" fi @@ -375,7 +355,8 @@ print_star_engine_sub_menu() { echo " </div>" } -print_header() { +print_header() +{ usage="print_header -s section -n name -r root [-l lang]" section=; name=; lang=; root= while getopts s:n:l:r: opt; do @@ -409,55 +390,58 @@ print_header() { echo "" echo "<body>" - echo "<aside id=\"menu\"><nav>" + echo "<div id=\"menu\">" if [ "${section}" = "Home" ]; then - echo " <h2>Home</h2>" - print_home_sub_menu "${root}" "${name}" + echo " Home" else - echo " <h2><a href=\"${root}misc/about-fr.html\">Home</a></h2>" + echo " <a href=\"${root}misc/about-fr.html\">Home</a>" fi + echo "  | " if [ "${section}" = "ART" ]; then - echo " <h2>A.R.T.</h2>" - print_art_sub_menu "${root}" "${name}" + echo " A.R.T." else - echo " <h2><a href=\"${root}art/art.html\">A.R.T.</a></h2>" + echo " <a href=\"${root}art/art.html\">A.R.T.</a>" fi + echo "  | " if [ "${section}" = "htrdr" ]; then - echo " <h2 style=\"font-variant: none\"><code style=\"color: black\">htrdr</code></h2>" - print_htrdr_sub_menu "${root}" "${name}" + echo " <code style=\"color: black; font-variant: none;\">htrdr</code>" else - echo " <h2 style=\"font-variant: none\"><code><a href=\"${root}htrdr/htrdr.html\">htrdr</a></code></h2>" + echo " <code style=\"font-variant:none;\"><a href=\"${root}htrdr/htrdr.html\">htrdr</a></code>" fi + echo "  | " if [ "${section}" = "Schiff" ]; then - echo ' <h2>Schiff</h2>' - print_schiff_sub_menu "${root}" "${name}" + echo " Schiff" else - echo " <h2><a href=\"${root}schiff/schiff.html\">Schiff</a></h2>" + echo " <a href=\"${root}schiff/schiff.html\">Schiff</a>" fi + echo "  | " if [ "${section}" = "Solstice" ]; then - echo " <h2>Solstice</h2>" - print_solstice_sub_menu "${root}" "${name}" + echo " Solstice" else - echo " <h2><a href=\"${root}solstice/solstice.html\">Solstice</a></h2>" + echo " <a href=\"${root}solstice/solstice.html\">Solstice</a>" fi + echo "  | " if [ "${section}" = "Stardis" ]; then - echo " <h2>Stardis</h2>" - print_stardis_sub_menu "${root}" "${name}" + echo " Stardis" else - echo " <h2><a href=\"${root}stardis/stardis.html\">Stardis</a></h2>" + echo " <a href=\"${root}stardis/stardis.html\">Stardis</a>" fi - if [ "${section}" = "Star-Engine" ]; then - echo " <h2>Star-Engine</h2>" - print_star_engine_sub_menu "${root}" "${name}" - else - echo " <h2><a href=\"${root}star-engine/star-engine.html\">Star-Engine</a></h2>" - fi - echo "<br>" # Enable CSS overflow here - echo "</nav></aside>" + echo "</div>" + echo "<hr>" + case "${section}" in + Home) print_home_sub_menu "${root}" "${name}" "${lang}";; + ART) print_art_sub_menu "${root}" "${name}" ;; + htrdr) print_htrdr_sub_menu "${root}" "${name}" ;; + Schiff) print_schiff_sub_menu "${root}" "${name}" ;; + Solstice) print_solstice_sub_menu "${root}" "${name}" ;; + Stardis) print_stardis_sub_menu "${root}" "${name}" "${lang}";; + *) ;; + esac echo "<div id=\"content\">" } -print_footer() { +print_footer() +{ echo "</div>" # content echo "<div id=\"footer\">" echo " @@ -472,7 +456,8 @@ print_footer() { echo "</body>" } -print_downloads() { +print_downloads() +{ prefix=$1 if [ $# -lt 2 ]; then windows=1 diff --git a/meso.css b/meso.css @@ -4,17 +4,16 @@ } body { - background-color: #e0e0e0; - color: #000000; + background-color: #fff; + color: #000; font-family: "Liberation Sans",sans-serif; margin: 1em auto; /*auto;*/ text-align: left; - /*font-size: 10pt;*/ - max-width: 72em; + font-size: 1em; + max-width: 50em; } h1 { - /*text-align: right; */ padding-bottom: 0.3em; } @@ -26,7 +25,6 @@ h1 { } h2 { - /*border-bottom: 1px solid #aaaaaa;*/ padding-top: 0.3em; padding-bottom: 0.3em; } @@ -37,20 +35,17 @@ h4 { code { font-family: "Liberation Mono",monospace; - /* color: #666666 */ } pre { display: block; font-family: "Liberation Mono",monospace; - /*color: #666666*/ } pre.code { padding-left: 2em; display: block; font-family: "Liberation Mono",monospace; - /*color: #666666*/ } img { @@ -95,11 +90,11 @@ hr { * Select ******************************************************************************/ #select { - font-variant: small-caps; float: right; } #select a { + font-weight: normal; color: #AAAAAA; text-decoration: none; } @@ -112,21 +107,10 @@ hr { * Menu ******************************************************************************/ #menu { - text-align: left; - width: 17em; - /*position: fixed;*/ - float: right; - max-height: 100%; - - margin-left: 2em; - /*overflow: auto;*/ -} - -#menu h2 { + width: 100%; font-variant: small-caps; - border-bottom: none; - padding-top: 0; - margin: 0.5em 0 0.5em 0; + font-size: 120%; + font-weight: bold; } #menu a { @@ -141,58 +125,31 @@ hr { /******************************************************************************* * Sub-menu ******************************************************************************/ -#sub-menu ul { - list-style-type: none; - font-weight: bold; - padding: 0 0 0 0; - margin: 0; -} - -#sub-menu li { - padding: 0.2em 0 0.2em 0; -} - -#sub-menu ul.lvl2 { - padding: 0 0 0 2em; - font-weight: normal; - font-size: 90%; -} - -#sub-menu ul.lvl2 a { - font-weight: normal; +.cur { + color: #f44d27 } -#sub-menu li#cur { - color: #f44d27 +#sub-menu { + padding-bottom: 1em; } #sub-menu a { text-decoration: none; + font-weight: normal; color: #000000; } #sub-menu a:hover { color: #777777; -} - -#sub-menu h2 { - color: #000000; -} - -#sub-menu { - border-top: 1px solid #aaaaaa; - border-bottom: 1px solid #aaaaaa; + font-weight: normal; } /******************************************************************************* * Content & news ******************************************************************************/ #content { - padding: 1em 1.5em 1em 1.5em; - background-color: #ffffff; text-align: left; max-width: 50em; - /*float: left;*/ overflow: hidden; } @@ -207,7 +164,7 @@ hr { clear: right; margin: 0 0 0.5em 1em; padding: 0 0 0 0.5em; - background-color: #e0e0e0; + background-color: #f5f5f5; width: 15em; text-align: left; } @@ -249,7 +206,7 @@ hr { #title { float: left; font-family: "Courier Prime"; - padding: 2.0em 2.0em 0.5em 1.5em; + padding: 0.0em 2.0em 0.5em 1.5em; margin: 0; text-align: center; font-size: 1.5em; @@ -284,7 +241,7 @@ hr { #footer { text-align: left; color: #777; - padding: 1.0em 0em 0em 2em; + padding: 2.0em 0em 0em 2em; font-size: 80%; } @@ -311,7 +268,7 @@ th.list { } .list tr:nth-child(2n+1) { - background-color: #F7F6F1; + background-color: #f5f5f5; } td.list { @@ -469,6 +426,7 @@ code.In, code.Nm, .Cm, .Fd, .Fl, .Fn, .Ic { /* Tables */ table.head, table.foot { width: 100%; border-spacing: 0; } +table.head { padding-top: 2em } td.head-rtitle, td.foot-os { text-align: right; } td.head-vol { text-align: center; } td.head-ltitle { margin: 0em; padding: 0em; text-align: left; } diff --git a/misc/about-en.html.in b/misc/about-en.html.in @@ -1,11 +1,6 @@ -<div id=select> - <span style="color: #f44d27;">English</span> - / <a href=about-fr.html>Français</a> -</div> - <div id=title> <h1>|Méso|Star></h1> - <div style="font-size: 10pt">Understanding complex systems</div> + <div style="font-size: 1em">Understanding complex systems</div> <hr> </div> diff --git a/misc/about-fr.html.in b/misc/about-fr.html.in @@ -1,8 +1,3 @@ -<div id=select> - <a href=about-en.html>English</a> - / <span style="color: #f44d27;">Français</span> -</div> - <div id=title> <h1>|Méso|Star></h1> <div style="font-size: 10pt">Understanding complex systems</div> diff --git a/misc/legal-en.html.in b/misc/legal-en.html.in @@ -1,8 +1,3 @@ -<div id=select> - <span style="color: #f44d27;">English</span> - / <a href=legal-fr.html>Français</a> -</div> - <header> <h1>Legal notices</h1> </header> diff --git a/misc/legal-fr.html.in b/misc/legal-fr.html.in @@ -1,8 +1,3 @@ -<div id=select> - <a href=legal-en.html>English</a> - / <span style="color: #f44d27;">Français</span> -</div> - <header> <h1>Mentions légales</h1> </header> diff --git a/schiff/.gitignore b/schiff/.gitignore @@ -1,3 +1,4 @@ schiff.html +schiff-docs.html schiff-downloads.html Schiff-*-GNU-Linux64/ diff --git a/schiff/Makefile b/schiff/Makefile @@ -37,7 +37,7 @@ MAN=\ $(SCHIFF_DIR)/share/man/man5/schiff-output.5 IMG = particles.png -HTML = schiff.html schiff-downloads.html +HTML = schiff.html schiff-docs.html schiff-downloads.html build: .sig .man @$(MAKE) -fMakefile -f .sig -f .man build_all @@ -74,6 +74,13 @@ schiff.html: schiff.html.in $(IMG) schiff_build.sh @$(SHELL) schiff_build.sh overview $(SCHIFF_VERSION) > $@ ################################################################################ +# Manual pages +################################################################################ +schiff-docs.html: schiff-docs.html.in schiff_build.sh + @echo "Building $@" + @$(SHELL) schiff_build.sh documentations > $@ + +################################################################################ # Downloads ################################################################################ schiff-downloads.html: $(SCHIFF_SIG) $(SCHIFF_README) schiff_build.sh diff --git a/schiff/schiff-docs.html.in b/schiff/schiff-docs.html.in @@ -0,0 +1,13 @@ +<header> + <h1>Schiff + <span class=subtitle> + Reference documentation + </span> + </h1> +</header> + +<ul> + <li><a href=man/man1/schiff.1.html>schiff(1)</a></li> + <li><a href=man/man5/schiff-geometry.5.html>schiff-geometry(5)</a></li> + <li><a href=man/man5/schiff-output.5.html>schiff-output(5)</a></li> +</ul> diff --git a/schiff/schiff_build.sh b/schiff/schiff_build.sh @@ -29,6 +29,13 @@ overview() print_footer } +documentations() +{ + print_header -s Schiff -n Documentations -r ../ + cat schiff-docs.html.in + print_footer +} + downloads() { if [ $# -lt 1 ]; then diff --git a/solstice/.gitignore b/solstice/.gitignore @@ -1,4 +1,5 @@ solstice.html +solstice-docs.html solstice-downloads.html solstice-resources.html solstice-release-notes.html.in diff --git a/solstice/Makefile b/solstice/Makefile @@ -70,6 +70,7 @@ MAN=\ IMG=solaris.jpg themis.png HTML=\ solstice.html\ + solstice-docs.html\ solstice-downloads.html\ solstice-resources.html @@ -116,9 +117,16 @@ solstice.html: solstice.html.in themis.png solstice_build.sh Makefile @$(SHELL) solstice_build.sh overview $(SOLSTICE_VERSION) > $@ ################################################################################ +# Reference documentation +################################################################################ +solstice-docs.html: solstice-docs.html.in solstice_build.sh + @echo "Building $@" + @$(SHELL) solstice_build.sh documentations > $@ + +################################################################################ # Downloads web page ################################################################################ -solstice-downloads.html: $(SOLSTICE_SIG) $(SOLSTICE_README) solstice_build.sh +solstice-downloads.html: $(SOLSTICE_SIG) $(SOLSTICE_README) solstice_build.sh @echo "Building $@" @$(SHELL) solstice_build.sh downloads $(SOLSTICE_README) > $@ diff --git a/solstice/solstice-abg.html.in b/solstice/solstice-abg.html.in @@ -8,7 +8,7 @@ Solstice resources on which it relies - i.e. input files - are available in a separate archive. </p> -<table> +<table class="list"> <tr> <th>Beginner's guide</th> <th>Resources</th> diff --git a/solstice/solstice-docs.html.in b/solstice/solstice-docs.html.in @@ -0,0 +1,14 @@ +<header> + <h1>Solstice + <span class=subtitle> + Reference documentation + </span> + </h1> +</header> + +<ul> + <li><a href=man/man1/solstice.1.html>solstice(1)</a></li> + <li><a href=man/man5/solstice-input.5.html>solstice-input(5)</a></li> + <li><a href=man/man5/solstice-output.5.html>solstice-output(5)</a></li> + <li><a href=man/man5/solstice-receiver.5.html>solstice-receiver(5)</a></li> +</ul> diff --git a/solstice/solstice.html.in b/solstice/solstice.html.in @@ -148,6 +148,12 @@ $ man solstice-receiver Guide</a> to learn fundamentals of Solstice; it relies on practical examples to introduce the functionalities of the program.</p> +<h2>History</h2> + +<p>Solstice was funded by the LABEX Solstice from 2016 to 2017. Visit +the <a href="https://www.labex-solstice.fr/solstice-software">LABEX +Solstice web page</a> for complementary informations and examples.</p> + <h2>License</h2> <p>Copyright © 2018, 2019, 2021 <a diff --git a/solstice/solstice_build.sh b/solstice/solstice_build.sh @@ -30,6 +30,13 @@ overview() print_footer } +documentations() +{ + print_header -s Solstice -n Documentations -r ../ + cat solstice-docs.html.in + print_footer +} + # Build the downloads page downloads() { @@ -50,7 +57,7 @@ downloads() print_pp_downloads() { - echo "<table>" + echo "<table class=\"list\">" echo " <tr>" echo " <th>Version</th>" echo " <th>Sources</th>" diff --git a/stardis/.gitignore b/stardis/.gitignore @@ -1,5 +1,7 @@ consortium*.html +release-notes.html stardis.html +stardis-docs.html starter-pack.html stardis-release-notes.html stardis-solver-release-notes.html diff --git a/stardis/Makefile b/stardis/Makefile @@ -83,8 +83,10 @@ VALIDATION_IMG=\ HTML=\ consortium-fr.html\ consortium-en.html\ + release-notes.html\ sgreen-release-notes.html\ stardis.html\ + stardis-docs.html\ stardis-solver-release-notes.html\ stardis-release-notes.html\ starter-pack.html\ @@ -159,8 +161,19 @@ consortium-en.html: consortium-en.html.in edf_logo.svg stardis_build.sh @$(SHELL) stardis_build.sh consortium en > $@ ################################################################################ +# Reference documentation +################################################################################ +stardis-docs.html: stardis-docs.html.in stardis_build.sh + @echo "Building $@" + @$(SHELL) stardis_build.sh documentations > $@ + +################################################################################ # Release notes ################################################################################ +release-notes.html: release-notes.html.in stardis_build.sh + @echo "Building $@" + @$(SHELL) stardis_build.sh release_notes_list > $@ + stardis-release-notes.html: $(STARDIS_README) stardis_build.sh @echo "Building $@" @$(SHELL) stardis_build.sh release_notes stardis\ diff --git a/stardis/consortium-en.html.in b/stardis/consortium-en.html.in @@ -1,8 +1,3 @@ -<div id=select> - <span style="color: #f44d27;">English</span> - / <a href=consortium-fr.html>Français</a> -</div> - <header> <h1>The Stardis consortium</h1> </header> diff --git a/stardis/consortium-fr.html.in b/stardis/consortium-fr.html.in @@ -1,8 +1,3 @@ -<div id=select> - <a href=consortium-en.html>English</a> - / <span style="color: #f44d27;">Français</span> -</div> - <header> <h1>Le consortium Stardis</h1> </header> diff --git a/stardis/release-notes.html.in b/stardis/release-notes.html.in @@ -0,0 +1,13 @@ +<header> + <h1>Stardis + <span class=subtitle> + Release notes + </span> + </h1> +</header> + +<ul> + <li><a href=stardis-release-notes.html>Stardis CLI</a></li> + <li><a href=sgreen-release-notes.html>Stardis Green</a></li> + <li><a href=stardis-solver-release-notes.html>Stardis Solver</a></li> +</ul> diff --git a/stardis/stardis-docs.html.in b/stardis/stardis-docs.html.in @@ -0,0 +1,21 @@ +<header> + <h1>Stardis + <span class=subtitle> + Reference documentation + </span> + </h1> +</header> + +<h3>Stardis</h3> +<ul> + <li><a href=man/man1/stardis.1.html>stardis(1)</a></li> + <li><a href=man/man5/stardis-input.5.html>stardis-input(5)</a></li> + <li><a href=man/man5/stardis-output.5.html>stardis-output(5)</a></li> +</ul> + +<h3>Stardis Green</h3> +<ul> + <li><a href=man/man1/sgreen.1.html>sgreen(1)</a></li> + <li><a href=man/man5/sgreen-input.5.html>sgreen-input(5)</a></li> + <li><a href=man/man5/sgreen-output.5.html>sgreen-output(5)</a></li> +</ul> diff --git a/stardis/stardis_build.sh b/stardis/stardis_build.sh @@ -48,6 +48,20 @@ consortium() print_footer } +documentations() +{ + print_header -s Stardis -n Documentations -r ../ + cat stardis-docs.html.in + print_footer +} + +release_notes_list() +{ + print_header -s Stardis -n "Release notes" -r ../ + cat release-notes.html.in + print_footer +} + release_notes() { if [ $# -lt 2 ]; then @@ -158,7 +172,7 @@ starter_pack() echo "<h2>Downloads</h2>" - echo "<table>" + echo "<table class=\"list\">" echo " <tr>" echo " <th>Version</th>" echo " <th>Archive</th>"