Repository files navigation

The documentation is written in AsciiDoc format. Source files, images and includes are located in thecontent directory in the following subdirectories:

• manual - Developer's Manual
• polymer - Polymer UI Tutorial
• release_notes - latest release notes
• other subdirectories contain documentation on platform addons.

Most of the documents have English and Russian versions in the corresponding subdirectories (en andru).

Released documentation is available atCUBA website.

In order to produce HTML from AsciiDoc, we useAsciidoctor. It can be installed as follows:

1. InstallRuby (tested on version 2.1).

2. Install Asciidoctor:

    gem install asciidoctor -v 1.5.2

3. Install coderay for code highlighting:

    gem install coderay

This is enough to build the documentation with the existing visual theme. If you want to change the theme, see theBuilding Theme section below.

Gradle is used as a build tool. Build task names have the following structure:{purpose}{doc}{lang}.

{purpose} can be one of the following:

• build - build single-HTML document.
• chop - build multi-page document.
• war - build a WAR file. The resulting WAR file will have a name corresponding to the document name and a version which is set by theext.docVersion property defined inbuild.gradle, for examplemanual-7.0.war.
• deploy - deploy WAR to Tomcat (installed by thesetupTomcat task, see below).

{doc} is the document name (Manual,Bpm, etc.)

{lang} can be eitherEn orRu.

For example, to build and deploy the English manual, use the following command:

./gradlew deployManualEn

Before running the deploy task, install the local Tomcat server by executing the following task:

./gradlew setupTomcat

By default, Tomcat is installed into./deploy/tomcat and configured to listen on port6080.

The CSS file containing the theme is located in thestyles directory. Don't change this file - it must be built by the AsciiDoc theme builder. The theme builder is located in thetools/asciidoctor-stylesheet-factory directory (it is a copy of theasciidoctor-stylesheet-factory project).

The theme source code is contained in two files:sass/cuba.scss andsass/settings/_cuba.scss. After making changes in these files, execute thebuildCubaTheme Gradle task. As a result, a newcuba.css will be written to thestyles directory.

ThebuildCubaTheme task requires the following Ruby gems:

gem install --no-rdoc --no-ri sass -v 3.4.22gem install --no-rdoc --no-ri compassgem install zurb-foundation

If you get an error like

C:/Program Files/Ruby21-x64/lib/ruby/gems/2.1.0/gems/compass-core-1.0.3/lib/compass/core/sass_extensions/functions/urls.rb:5:in `has?': undefined method `has?' for Sass::Util:Module (NoMethodError)        from C:/Program Files/Ruby21-x64/lib/ruby/gems/2.1.0/gems/compass-core-1.0.3/lib/compass/core/sass_extensions/functions/urls.rb:9:in `included'        from C:/Program Files/Ruby21-x64/lib/ruby/gems/2.1.0/gems/sass-3.5.0.pre.rc.1/lib/sass/script/functions.rb:632:in `include'

then try to uninstall gemsass-3.5.0.pre.rc.1 and install3.4.22. Perhaps you should also reinstall all the other gems.

After installing Tomcat and deploying a document as described above, start the server:

./deploy/tomcat/bin/startup.sh

If you build, for example, manual for version 7.1, it will be available athttp://localhost:6080/manual-7.1.