diff --git a/doc/com.minres.scviewer.doc/src/asciidoc/Overview.adoc b/doc/com.minres.scviewer.doc/src/asciidoc/Overview.adoc index 3599325..14dbff3 100644 --- a/doc/com.minres.scviewer.doc/src/asciidoc/Overview.adoc +++ b/doc/com.minres.scviewer.doc/src/asciidoc/Overview.adoc @@ -1,5 +1,3 @@ -// ///////////////////////////////////////////////////////////////////////////////////////////////////// OVERVIEW /////////////////////////////////////////////////////// - [#_introduction] == Introduction diff --git a/doc/com.minres.scviewer.doc/src/asciidoc/Reference.adoc b/doc/com.minres.scviewer.doc/src/asciidoc/Reference.adoc index dccba11..d32f393 100644 --- a/doc/com.minres.scviewer.doc/src/asciidoc/Reference.adoc +++ b/doc/com.minres.scviewer.doc/src/asciidoc/Reference.adoc @@ -1,5 +1,3 @@ -// ///////////////////////////////////////////////////////////////////////////////////////////////////// Reference ////////////////////////////////////////////////////// - [#_reference] == Reference @@ -54,4 +52,4 @@ Legend: | Key PgDown | | ZoomBar | scroll window to the right (fast) | Key Pos1 | | ZoomBar | scroll to begin | Key End | | ZoomBar | scroll to end - +|=== diff --git a/doc/com.minres.scviewer.doc/src/asciidoc/SCViewerHelp.adoc b/doc/com.minres.scviewer.doc/src/asciidoc/SCViewerHelp.adoc index 3c3e6e9..279c0d0 100644 --- a/doc/com.minres.scviewer.doc/src/asciidoc/SCViewerHelp.adoc +++ b/doc/com.minres.scviewer.doc/src/asciidoc/SCViewerHelp.adoc @@ -1,5 +1,6 @@ [#_start] = SCViewer User Guide +:title-logo-image: image:Minres_logo_docs.png[width=750, align="right"] :doctype: book :source-highlighter: coderay :coderay-linenums-mode: inline @@ -8,21 +9,31 @@ :icons: font //add table-of-contents (toc) and set its depth :toc: -:toclevels: 6 +:toclevels: 3 +:data-uri: +:sectnums: +:toc-title: Contents +:homepage: https://www.minres.com/ +:keywords: +:title-page: +:xrefstyle: short +:table-caption: Table +:figure-caption: Figure +:appendix-caption: Appendix +:section-refsig: Chapter //set directories :imagesdir: ./images :iconsdir: ./icons :stylesdir: ./styles :scriptsdir: ./js -:title-logo-image: image:Minres_logo_square.png[] -//add math support, also do via cmd-line a 'gem install asciimath' -:stem: +:pdf-themesdir: ./themes +:pdf-theme: mnrs-doc +:pdf-fontsdir: ./fonts + // unset toc, otherwise it appears in table cells -> known bug, should be fixed in later versions! :toc!: -// ///////////////////////////////////////////////////////////////////////////////////////////////////// OVERVIEW /////////////////////////////////////////////////////// include::Overview.adoc[] -// ///////////////////////////////////////////////////////////////////////////////////////////////////// Reference ////////////////////////////////////////////////////// include::Reference.adoc[] diff --git a/doc/com.minres.scviewer.doc/src/asciidoc/fonts/OFL.txt b/doc/com.minres.scviewer.doc/src/asciidoc/fonts/OFL.txt new file mode 100644 index 0000000..4a44b9b --- /dev/null +++ b/doc/com.minres.scviewer.doc/src/asciidoc/fonts/OFL.txt @@ -0,0 +1,93 @@ +Copyright (c) 2009-2011 by Accademia di Belle Arti di Urbino and students of MA course of Visual design. Some rights reserved. + +This Font Software is licensed under the SIL Open Font License, Version 1.1. +This license is copied below, and is also available with a FAQ at: +http://scripts.sil.org/OFL + + +----------------------------------------------------------- +SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007 +----------------------------------------------------------- + +PREAMBLE +The goals of the Open Font License (OFL) are to stimulate worldwide +development of collaborative font projects, to support the font creation +efforts of academic and linguistic communities, and to provide a free and +open framework in which fonts may be shared and improved in partnership +with others. + +The OFL allows the licensed fonts to be used, studied, modified and +redistributed freely as long as they are not sold by themselves. The +fonts, including any derivative works, can be bundled, embedded, +redistributed and/or sold with any software provided that any reserved +names are not used by derivative works. The fonts and derivatives, +however, cannot be released under any other type of license. The +requirement for fonts to remain under this license does not apply +to any document created using the fonts or their derivatives. + +DEFINITIONS +"Font Software" refers to the set of files released by the Copyright +Holder(s) under this license and clearly marked as such. This may +include source files, build scripts and documentation. + +"Reserved Font Name" refers to any names specified as such after the +copyright statement(s). + +"Original Version" refers to the collection of Font Software components as +distributed by the Copyright Holder(s). + +"Modified Version" refers to any derivative made by adding to, deleting, +or substituting -- in part or in whole -- any of the components of the +Original Version, by changing formats or by porting the Font Software to a +new environment. + +"Author" refers to any designer, engineer, programmer, technical +writer or other person who contributed to the Font Software. + +PERMISSION & CONDITIONS +Permission is hereby granted, free of charge, to any person obtaining +a copy of the Font Software, to use, study, copy, merge, embed, modify, +redistribute, and sell modified and unmodified copies of the Font +Software, subject to the following conditions: + +1) Neither the Font Software nor any of its individual components, +in Original or Modified Versions, may be sold by itself. + +2) Original or Modified Versions of the Font Software may be bundled, +redistributed and/or sold with any software, provided that each copy +contains the above copyright notice and this license. These can be +included either as stand-alone text files, human-readable headers or +in the appropriate machine-readable metadata fields within text or +binary files as long as those fields can be easily viewed by the user. + +3) No Modified Version of the Font Software may use the Reserved Font +Name(s) unless explicit written permission is granted by the corresponding +Copyright Holder. This restriction only applies to the primary font name as +presented to the users. + +4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font +Software shall not be used to promote, endorse or advertise any +Modified Version, except to acknowledge the contribution(s) of the +Copyright Holder(s) and the Author(s) or with their explicit written +permission. + +5) The Font Software, modified or unmodified, in part or in whole, +must be distributed entirely under this license, and must not be +distributed under any other license. The requirement for fonts to +remain under this license does not apply to any document created +using the Font Software. + +TERMINATION +This license becomes null and void if any of the above conditions are +not met. + +DISCLAIMER +THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT +OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE +COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL +DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM +OTHER DEALINGS IN THE FONT SOFTWARE. diff --git a/doc/com.minres.scviewer.doc/src/asciidoc/fonts/TitilliumWeb-Black.ttf b/doc/com.minres.scviewer.doc/src/asciidoc/fonts/TitilliumWeb-Black.ttf new file mode 100644 index 0000000..ec5b093 Binary files /dev/null and b/doc/com.minres.scviewer.doc/src/asciidoc/fonts/TitilliumWeb-Black.ttf differ diff --git a/doc/com.minres.scviewer.doc/src/asciidoc/fonts/TitilliumWeb-Bold.ttf b/doc/com.minres.scviewer.doc/src/asciidoc/fonts/TitilliumWeb-Bold.ttf new file mode 100644 index 0000000..b51a4d6 Binary files /dev/null and b/doc/com.minres.scviewer.doc/src/asciidoc/fonts/TitilliumWeb-Bold.ttf differ diff --git a/doc/com.minres.scviewer.doc/src/asciidoc/fonts/TitilliumWeb-BoldItalic.ttf b/doc/com.minres.scviewer.doc/src/asciidoc/fonts/TitilliumWeb-BoldItalic.ttf new file mode 100644 index 0000000..d0fe23b Binary files /dev/null and b/doc/com.minres.scviewer.doc/src/asciidoc/fonts/TitilliumWeb-BoldItalic.ttf differ diff --git a/doc/com.minres.scviewer.doc/src/asciidoc/fonts/TitilliumWeb-ExtraLight.ttf b/doc/com.minres.scviewer.doc/src/asciidoc/fonts/TitilliumWeb-ExtraLight.ttf new file mode 100644 index 0000000..a590b73 Binary files /dev/null and b/doc/com.minres.scviewer.doc/src/asciidoc/fonts/TitilliumWeb-ExtraLight.ttf differ diff --git a/doc/com.minres.scviewer.doc/src/asciidoc/fonts/TitilliumWeb-ExtraLightItalic.ttf b/doc/com.minres.scviewer.doc/src/asciidoc/fonts/TitilliumWeb-ExtraLightItalic.ttf new file mode 100644 index 0000000..8fe0256 Binary files /dev/null and b/doc/com.minres.scviewer.doc/src/asciidoc/fonts/TitilliumWeb-ExtraLightItalic.ttf differ diff --git a/doc/com.minres.scviewer.doc/src/asciidoc/fonts/TitilliumWeb-Italic.ttf b/doc/com.minres.scviewer.doc/src/asciidoc/fonts/TitilliumWeb-Italic.ttf new file mode 100644 index 0000000..266d5cb Binary files /dev/null and b/doc/com.minres.scviewer.doc/src/asciidoc/fonts/TitilliumWeb-Italic.ttf differ diff --git a/doc/com.minres.scviewer.doc/src/asciidoc/fonts/TitilliumWeb-Light.ttf b/doc/com.minres.scviewer.doc/src/asciidoc/fonts/TitilliumWeb-Light.ttf new file mode 100644 index 0000000..fbba05d Binary files /dev/null and b/doc/com.minres.scviewer.doc/src/asciidoc/fonts/TitilliumWeb-Light.ttf differ diff --git a/doc/com.minres.scviewer.doc/src/asciidoc/fonts/TitilliumWeb-LightItalic.ttf b/doc/com.minres.scviewer.doc/src/asciidoc/fonts/TitilliumWeb-LightItalic.ttf new file mode 100644 index 0000000..3783f8d Binary files /dev/null and b/doc/com.minres.scviewer.doc/src/asciidoc/fonts/TitilliumWeb-LightItalic.ttf differ diff --git a/doc/com.minres.scviewer.doc/src/asciidoc/fonts/TitilliumWeb-Regular.ttf b/doc/com.minres.scviewer.doc/src/asciidoc/fonts/TitilliumWeb-Regular.ttf new file mode 100644 index 0000000..a54ad4b Binary files /dev/null and b/doc/com.minres.scviewer.doc/src/asciidoc/fonts/TitilliumWeb-Regular.ttf differ diff --git a/doc/com.minres.scviewer.doc/src/asciidoc/fonts/TitilliumWeb-SemiBold.ttf b/doc/com.minres.scviewer.doc/src/asciidoc/fonts/TitilliumWeb-SemiBold.ttf new file mode 100644 index 0000000..49109f8 Binary files /dev/null and b/doc/com.minres.scviewer.doc/src/asciidoc/fonts/TitilliumWeb-SemiBold.ttf differ diff --git a/doc/com.minres.scviewer.doc/src/asciidoc/fonts/TitilliumWeb-SemiBoldItalic.ttf b/doc/com.minres.scviewer.doc/src/asciidoc/fonts/TitilliumWeb-SemiBoldItalic.ttf new file mode 100644 index 0000000..22243ff Binary files /dev/null and b/doc/com.minres.scviewer.doc/src/asciidoc/fonts/TitilliumWeb-SemiBoldItalic.ttf differ diff --git a/doc/com.minres.scviewer.doc/src/asciidoc/fonts/titilliumtext22l001-webfont.ttf b/doc/com.minres.scviewer.doc/src/asciidoc/fonts/titilliumtext22l001-webfont.ttf new file mode 100644 index 0000000..9fc52e5 Binary files /dev/null and b/doc/com.minres.scviewer.doc/src/asciidoc/fonts/titilliumtext22l001-webfont.ttf differ diff --git a/doc/com.minres.scviewer.doc/src/asciidoc/fonts/titilliumtext22l002-webfont.ttf b/doc/com.minres.scviewer.doc/src/asciidoc/fonts/titilliumtext22l002-webfont.ttf new file mode 100644 index 0000000..b05b52d Binary files /dev/null and b/doc/com.minres.scviewer.doc/src/asciidoc/fonts/titilliumtext22l002-webfont.ttf differ diff --git a/doc/com.minres.scviewer.doc/src/asciidoc/fonts/titilliumtext22l003-webfont.ttf b/doc/com.minres.scviewer.doc/src/asciidoc/fonts/titilliumtext22l003-webfont.ttf new file mode 100644 index 0000000..26e2d68 Binary files /dev/null and b/doc/com.minres.scviewer.doc/src/asciidoc/fonts/titilliumtext22l003-webfont.ttf differ diff --git a/doc/com.minres.scviewer.doc/src/asciidoc/fonts/titilliumtext22l003.ttf b/doc/com.minres.scviewer.doc/src/asciidoc/fonts/titilliumtext22l003.ttf new file mode 100644 index 0000000..1df2687 Binary files /dev/null and b/doc/com.minres.scviewer.doc/src/asciidoc/fonts/titilliumtext22l003.ttf differ diff --git a/doc/com.minres.scviewer.doc/src/asciidoc/fonts/titilliumtext22l004-webfont.ttf b/doc/com.minres.scviewer.doc/src/asciidoc/fonts/titilliumtext22l004-webfont.ttf new file mode 100644 index 0000000..fa1ee55 Binary files /dev/null and b/doc/com.minres.scviewer.doc/src/asciidoc/fonts/titilliumtext22l004-webfont.ttf differ diff --git a/doc/com.minres.scviewer.doc/src/asciidoc/fonts/titilliumtext22l005-webfont.ttf b/doc/com.minres.scviewer.doc/src/asciidoc/fonts/titilliumtext22l005-webfont.ttf new file mode 100644 index 0000000..901be70 Binary files /dev/null and b/doc/com.minres.scviewer.doc/src/asciidoc/fonts/titilliumtext22l005-webfont.ttf differ diff --git a/doc/com.minres.scviewer.doc/src/asciidoc/fonts/titilliumtext22l006-webfont.ttf b/doc/com.minres.scviewer.doc/src/asciidoc/fonts/titilliumtext22l006-webfont.ttf new file mode 100644 index 0000000..5adb209 Binary files /dev/null and b/doc/com.minres.scviewer.doc/src/asciidoc/fonts/titilliumtext22l006-webfont.ttf differ diff --git a/doc/com.minres.scviewer.doc/src/asciidoc/images/Minres_logo.png b/doc/com.minres.scviewer.doc/src/asciidoc/images/Minres_logo.png new file mode 100644 index 0000000..35240a8 Binary files /dev/null and b/doc/com.minres.scviewer.doc/src/asciidoc/images/Minres_logo.png differ diff --git a/doc/com.minres.scviewer.doc/src/asciidoc/images/Minres_logo_docs.png b/doc/com.minres.scviewer.doc/src/asciidoc/images/Minres_logo_docs.png new file mode 100644 index 0000000..4cc6339 Binary files /dev/null and b/doc/com.minres.scviewer.doc/src/asciidoc/images/Minres_logo_docs.png differ diff --git a/doc/com.minres.scviewer.doc/src/asciidoc/themes/mnrs-doc-theme.yml b/doc/com.minres.scviewer.doc/src/asciidoc/themes/mnrs-doc-theme.yml new file mode 100644 index 0000000..9446bfe --- /dev/null +++ b/doc/com.minres.scviewer.doc/src/asciidoc/themes/mnrs-doc-theme.yml @@ -0,0 +1,55 @@ +page: + layout: portrait + margin: [2.3cm, 2cm, 2cm, 2.2cm] + size: A4 +base: + font-color: #000000 + font-color-mnrs-grey: #6a747c + font-color-mnrs-blue: #197788 + font-family: titillium + font-size: 12 + line-height-length: 16 + line-height: $base-line-height-length / $base-font-size + align: justify + vertical-spacing: $base-line-height-length +heading: + font-color: $base-font-color-mnrs-grey + font-size: $base-font-size * 1.25 + font-style: bold + line-height: $base-line-height * 1.2 + margin-bottom: $vertical-spacing +link: + font-color: $base_font-color-mnrs-blue +outline-list: + indent: $base-font-size * 1.5 +footer: + height: $base-line-height-length * 3.0 + font-color: $base-font-color-mnrs-grey + font-size: $base-font-size * 0.9 + line-height: 1 + recto: + left: + content: '{description} v{revision}, © 2021 MINRES' + right: + content: '{page-number}' + verso: + left: + content: $footer_recto_right_content + right: + content: $footer_recto_left_content +table: + border_color: $base-font-color + border_width: 0.1 +title-page: + align: right + font-color: $base-font-color-mnrs-grey + font-size: $base-font-size * 1.80 + font-style: bold +font: + fallbacks: titilliumtext22l002-webfont.ttf + catalog: + titillium: + normal: titilliumtext22l002-webfont.ttf + bold: titilliumtext22l005-webfont.ttf + italic: TitilliumWeb-Italic.ttf + bold_italic: TitilliumWeb-BoldItalic.ttf diff --git a/doc/com.minres.scviewer.doc/src/docbkx/images/.gitignore b/doc/com.minres.scviewer.doc/src/docbkx/images/.gitignore index 824134a..b44ef38 100644 --- a/doc/com.minres.scviewer.doc/src/docbkx/images/.gitignore +++ b/doc/com.minres.scviewer.doc/src/docbkx/images/.gitignore @@ -1 +1 @@ -/Minres_logo_square.png +/*.png