Skip to content

GitLab

U
Uploader
Commit 2f9be28f authored by Matija Obreza's avatar Matija Obreza
Browse files
Options

Build Anno PDF manual

parent 46da3175
Hide whitespace changes
Inline Side-by-side
Showing with 200 additions and 56 deletions
anno-docs/pom.xml 0 → 100644
View file @ 2f9be28f
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.genesys-pgr</groupId>
<artifactId>anno</artifactId>
<version>1.1-SNAPSHOT</version>
</parent>
<artifactId>anno-docs</artifactId>
<name>Genesys Uploader documentation</name>
<description>.</description>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<asciidoctor.maven.plugin.version>1.5.6</asciidoctor.maven.plugin.version>
<asciidoctorj.pdf.version>1.5.0-alpha.16</asciidoctorj.pdf.version>
<asciidoctorj.version>1.5.6</asciidoctorj.version>
<jruby.version>9.1.8.0</jruby.version>
</properties>
<build>
<defaultGoal>process-resources</defaultGoal>
<plugins>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>buildnumber-maven-plugin</artifactId>
<version>1.3</version>
<executions>
<execution>
<id>create-buildNumber</id>
<phase>validate</phase>
<goals>
<goal>create</goal>
<goal>create-timestamp</goal>
</goals>
</execution>
</executions>
<configuration>
<!-- first check to see if you have locally modified files, and will
fail if there are any. -->
<doCheck>false</doCheck>
<doUpdate>false</doUpdate>
<shortRevisionLength>8</shortRevisionLength>
<timestampFormat>{0,date,d MMMM yyyy}</timestampFormat>
<timestampPropertyName>buildDate</timestampPropertyName>
</configuration>
</plugin>
<plugin>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>
<version>${asciidoctor.maven.plugin.version}</version>
<dependencies>
<dependency>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctorj-pdf</artifactId>
<version>${asciidoctorj.pdf.version}</version>
</dependency>
<!-- Comment this section to use the default jruby artifact provided by the plugin -->
<dependency>
<groupId>org.jruby</groupId>
<artifactId>jruby-complete</artifactId>
<version>${jruby.version}</version>
</dependency>
<!-- Comment this section to use the default AsciidoctorJ artifact provided by the plugin -->
<dependency>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctorj</artifactId>
<version>${asciidoctorj.version}</version>
</dependency>
</dependencies>
<configuration>
<sourceDirectory>src/docs/asciidoc</sourceDirectory>
<!-- Attributes common to all output formats -->
<attributes>
<sourcedir>${project.build.sourceDirectory}</sourcedir>
<buildNumber>${buildNumber}</buildNumber>
<buildDate>${buildDate}</buildDate>
<buildBranch>${scmBranch}</buildBranch>
<projectArtifact>${project.artifactId}</projectArtifact>
<projectVersion>${project.version}</projectVersion>
<snippets>${snippetsDirectory}</snippets>
</attributes>
</configuration>
<executions>
<!-- <execution>
<id>generate-pdf-doc-default-theme</id>
<phase>generate-resources</phase>
<goals>
<goal>process-asciidoc</goal>
</goals>
<configuration>
<backend>pdf</backend>
<outputDirectory>${project.build.directory}/generated-docs-default-theme</outputDirectory>
<sourceHighlighter>coderay</sourceHighlighter>
<doctype>book</doctype>
<attributes>
<icons>font</icons>
<pagenums/>
<toc/>
<idprefix/>
<idseparator>-</idseparator>
</attributes>
</configuration>
</execution> -->
<execution>
<id>generate-pdf-custom-theme</id>
<phase>generate-resources</phase>
<goals>
<goal>process-asciidoc</goal>
</goals>
<configuration>
<backend>pdf</backend>
<sourceDocumentName>manual.adoc</sourceDocumentName>
<outputFile>${project.build.directory}/anno-manual-${project.version}.pdf</outputFile>
<!-- <outputDirectory>${project.build.directory}/generated-docs-custom-theme</outputDirectory> -->
<sourceHighlighter>coderay</sourceHighlighter>
<doctype>book</doctype>
<attributes>
<pdf-stylesdir>${project.basedir}/src/theme</pdf-stylesdir>
<pdf-style>custom</pdf-style>
<icons>font</icons>
<pagenums/>
<toc/>
<idprefix/>
<idseparator>-</idseparator>
</attributes>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
anno-gui/src/main/asciidoc/index.adoc → anno-docs/src/docs/asciidoc/manual.adoc
View file @ 2f9be28f
Genesys Anno User Manual
========================
October 2017: Commit {buildNumber}
:revnumber: {projectVersion}
:revnumber: {projectVersion} {buildNumber}
:revremark: {buildNumber}
:revdate: {buildDate}
:doctype: book
:toc: left
:toclevels: 5
:icons: font
:numbered:
:chapter-label:
:source-highlighter: pygments
:pygments-css: class
:pygments-linenums-mode: table
:author: Genesys Helpdesk
:email: helpdesk@genesys-pgr.org
[[intro]]
Introduction
------------
*Anno* is a standalone Java application for managing accession-level data on
Genesys upload tool *Anno* is a standalone Java application for managing accession-level data on
Genesys PGR - global database on PGR in world's genebanks. Genesys database is
accessible at https://www.genesys-pgr.org .
......@@ -38,4 +43,4 @@ include::sections/datasources.adoc[]
include::sections/mapping.adoc[]
include::sections/push.adoc[]
include::sections/troubleshooting.adoc[]
include::sections/ack.adoc[]
// include::sections/ack.adoc[]
anno-gui/src/main/asciidoc/sections/ack.adoc → anno-docs/src/docs/asciidoc/sections/ack.adoc
View file @ 2f9be28f
......@@ -3,7 +3,4 @@
== Version information
* Matija Obreza, Crop Trust: Initial document, January 2016.
=== Acknowledgements
*TBD*
* Matija Obreza, Crop Trust: PDF version, October 2017.
anno-gui/src/main/asciidoc/sections/download.adoc → anno-docs/src/docs/asciidoc/sections/download.adoc
View file @ 2f9be28f
......@@ -15,14 +15,14 @@ WARNING: Disable Java in all Internet browsers on your computer. Nobody in their
If downloading pre-compiled binaries, make sure to download the latest version of Anno for your platform.
You probably have 64-bit CPU and JRE and should use the package labeled `x86_64`. `x86` is for the 32-bit JRE.
Download the package from the https://bitbucket.org/genesys2/anno-swt/downloads[downloads section]
Download the package from the https://goo.gl/r5QFns[downloads section]
extract if necessary and run the executable for your platform.
[cols="1,4"]
.Resources
|===
|Project page|https://gitlab.croptrust.org/genesys-pgr/anno
|Pre-compiled binaries|https://bitbucket.org/genesys2/anno-swt/downloads
|Pre-compiled binaries|https://goo.gl/r5QFns
|`git` repository URL|https://gitlab.croptrust.org/genesys-pgr/anno.git
|Issue tracker|https://gitlab.croptrust.org/genesys-pgr/anno/issues
|===
anno-docs/src/theme/custom-theme.yml 0 → 100644
View file @ 2f9be28f
# https://github.com/asciidoctor/asciidoctor-pdf/blob/master/docs/theming-guide.adoc
#
title_page:
align: left
background_image: anno-cover.png
page:
layout: portrait
margin: [0.75in, 1in, 0.75in, 1in]
size: A4
base:
font_color: #4d4c46
font_size: 10
line_height_length: 17
line_height: $base_line_height_length / $base_font_size
vertical_rhythm: $base_line_height_length
heading:
font_color: #4d4c46
font_style: bold
line_height: 1.2
margin_bottom: $vertical_rhythm
heading_h1:
font_size: $base_font_size * 1.8
heading_h2:
font_size: $base_font_size * 1.6
heading_h3:
font_size: $base_font_size * 1.4
link:
font_color: #006db4
outline_list:
indent: $base_font_size * 1.5
header:
height: 0.75in
line_height: 1
recto_content:
center: '{document-title}'
verso_content:
center: '{document-title}'
footer:
height: 0.75in
line_height: 1
recto_content:
right: '{page-number} / {page-count}' # {chapter-title} |
verso_content:
left: '{page-number} / {page-count}' # | {chapter-title}
image:
align: center
caption:
align: center
font_color: #4d4c46
font_size: 10
anno-gui/pom.xml
View file @ 2f9be28f
......@@ -188,51 +188,6 @@
<encoding>UTF-8</encoding>
</configuration>
</plugin>
<plugin>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>
<version>1.5.3</version>
<executions>
<execution>
<id>output-html</id>
<phase>generate-resources</phase>
<goals>
<goal>process-asciidoc</goal>
</goals>
<configuration>
<backend>html5</backend>
<doctype>book</doctype>
<sourceHighlighter>coderay</sourceHighlighter>
<attributes>
<copycss>true</copycss>
<!-- <linkcss /> -->
<toc>left</toc>
<icons>font</icons>
<sectanchors>true</sectanchors>
<idprefix />
<idseparator>-</idseparator>
<docinfo1>true</docinfo1>
</attributes>
</configuration>
</execution>
<!-- <execution> <id>output-docbook</id> <phase>generate-resources</phase>
<goals> <goal>process-asciidoc</goal> </goals> <configuration> <backend>docbook</backend>
<doctype>book</doctype> </configuration> </execution> -->
</executions>
<configuration>
<sourceDirectory>src/main/asciidoc</sourceDirectory>
<preserveDirectories>true</preserveDirectories>
<headerFooter>true</headerFooter>
<numbered>true</numbered>
<!-- <imagesDir>images</imagesDir> -->
<attributes>
<buildNumber>${buildNumber}</buildNumber>
<projectArtifact>${project.artifactId}</projectArtifact>
<projectVersion>${project.version}</projectVersion>
<snippets>${snippetsDirectory}</snippets>
</attributes>
</configuration>
</plugin>
</plugins>
</build>
</project>
pom.xml
View file @ 2f9be28f
......@@ -33,6 +33,7 @@
<modules>
<module>anno-gui</module>
<module>anno-docs</module>
<module>anno-gui-package</module>
<module>anno-gui-macosx</module>
</modules>
......@@ -54,4 +55,4 @@
</plugin>
</plugins>
</build>
</project>
\ No newline at end of file
</project>
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment