diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000000..87779752c1 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,16 @@ +language: something +install: +- echo "Installed" +script: + - sh .travis/publish.sh +after_success: + - sh .travis/deploy.sh +env: + global: + - DITAMAP=DITA/UserManual.ditamap + - DITAVAL=DITA/author.ditaval + - ANT_OPTS=-Xmx1024M + - secure: eDx05nCQBkMghcyW2gDBwpOEkb3mg2wYd+B3qdyfLidkHXWxluECt1pau9E0m4c7vVzaY5nH5GRm9aePkLhxTbqVcAaLd84JBkszxyBIGMK95r5LxQC8vjnc+UKDL7t9sPVeXavmyLarOuRWD0ZPTF7GsEdmap/HYO5fUEhUKjiae5xp//JV3bOrvKBqXkk0XdCpUwJWyGqp5X/Nx8BtAYWW3aJs6xRT5PQueHPH3QYUlsV/BstKHFkgNmCL/Kc47JTAUgd46fxH4FerKpDq44hK9sOMqlvLFshmbmRqfaaLynpwfM6QtS9jp3ZZQ9bt8oXucM5NYNdK6VXG7gEQkKP0EW2/NfODzB/E6E10B2jY6C6KqoJ2xfsdgT1DQnrlTUz3eOCTfdY873AWNuWfHv9UlP5QIrCYWqVktJCkJWDdlG2VhWCieUkUx5C2nh50ZkGALRBP8gs8ztQ5hwifdbuqBd3lVYYi6ZPl0JIUDRK68O2rX1sr4+9P0HCLuSOTSnN9H1QMvM8X2aBZxtuk0rhcQLqPvY5EV8kj3R2tfemq3jIDDBZD0EMuQVR8Ilza2AZPJhtCwMzrd6+JrVk5UWfNtTN2dUhUNBwt8Zr/GmnKhbg0H0ZWhXtd+zDfwCpAazGllncwadfF2DP2hVSyBy4vN5ijL3lxTFxN/IiJYg8= +before_install: +- openssl aes-256-cbc -K $encrypted_44bb9a165316_key -iv $encrypted_44bb9a165316_iv + -in licenseKey.txt.enc -out licenseKey.txt -d diff --git a/.travis/deploy.sh b/.travis/deploy.sh new file mode 100644 index 0000000000..dcbb1c10ab --- /dev/null +++ b/.travis/deploy.sh @@ -0,0 +1,33 @@ +#!/bin/bash + +set -o errexit -o nounset + +rev=$(git rev-parse --short HEAD) + +REPONAME=`basename $PWD` +PARENTDIR=`dirname $PWD` +USERNAME=`basename $PARENTDIR` +cd out + +git init +git config user.name "oXygen XML Deployer" +git config user.email "support@oxygenxml.com" + +git remote add upstream "https://$GH_TOKEN@github.com/$USERNAME/$REPONAME.git" +git fetch upstream +git reset upstream/gh-pages + +touch . + +ls +git status + +if [ "$TRAVIS_BRANCH" != "master" ] +then + echo "This commit was made against the $TRAVIS_BRANCH and not the master! No deploy!" + exit 0 +fi + +git add -A . +git commit -m "rebuild pages at ${rev}" +git push -q upstream HEAD:gh-pages diff --git a/.travis/publish.sh b/.travis/publish.sh new file mode 100644 index 0000000000..3c0abd306f --- /dev/null +++ b/.travis/publish.sh @@ -0,0 +1,32 @@ +wget http://mirror.oxygenxml.com/InstData/Editor/Webhelp/oxygen-webhelp.zip +unzip oxygen-webhelp.zip + +wget https://github.com/dita-ot/dita-ot/releases/download/2.2.3/dita-ot-2.2.3.zip +unzip dita-ot-2.2.3.zip + +cp -R com.oxygenxml.* dita-ot-2.2.3/plugins/ +mv dita-ot-2.2.3/plugins/com.oxygenxml.webhelp/plugin_2.x.xml dita-ot-2.2.3/plugins/com.oxygenxml.webhelp/plugin.xml +# Add the editlink plugin +git clone https://github.com/ctalau/ditaot-editlink-plugin dita-ot-2.2.3/plugins/com.oxygenxml.editlink/ +git clone https://github.com/ctalau/ditaot-pdf-editlink dita-ot-2.2.3/plugins/com.oxygenxml.pdf.editlink/ + +cd dita-ot-2.2.3/ +bin/ant -f integrator.xml +cd .. + +cp licenseKey.txt dita-ot-2.2.3/plugins/com.oxygenxml.webhelp/licensekey.txt + +rm -rf out + +REPONAME=`basename $PWD` +PARENTDIR=`dirname $PWD` +USERNAME=`basename $PARENTDIR` + +# Send some parameters to the "editlink" plugin as system properties +export ANT_OPTS="$ANT_OPTS -Dditamap.path=$DITAMAP" +export ANT_OPTS="$ANT_OPTS -Dcwd=`pwd`" +export ANT_OPTS="$ANT_OPTS -Drepo.url=github://getFileContent/$USERNAME/$REPONAME/$TRAVIS_BRANCH/" +export ANT_OPTS="$ANT_OPTS -Dwebapp.url=https://www.oxygenxml.com/webapp-demo-aws/" + +dita-ot-2.2.3/bin/dita -i $DITAMAP -f pdf -filter=$DITAVAL +dita-ot-2.2.3/bin/dita -i $DITAMAP -f webhelp-responsive -filter=$DITAVAL diff --git a/DITA/topics/api_faq_custom_callouts.dita b/DITA/topics/api_faq_custom_callouts.dita index 109a63f8c5..1ef890dad1 100644 --- a/DITA/topics/api_faq_custom_callouts.dita +++ b/DITA/topics/api_faq_custom_callouts.dita @@ -1,7 +1,7 @@ - Add Custom Callouts + Add Custom Callouts to the Review Panel
Question @@ -13,7 +13,7 @@
Answer -

The Plugins API allows you to set a ValidationProblemsFilter that gets +

The Plugins SDK allows you to set a ValidationProblemsFilter that gets notified when automatic validation errors are available. Then you can map each of the problems to an offset range in the Author mode using the API WSTextBasedEditorPage.getStartEndOffsets(DocumentPositionedInfo). For diff --git a/DITA/topics/author-dita-doc-type.dita b/DITA/topics/author-dita-doc-type.dita index e23c4ac8d3..f667fa9822 100644 --- a/DITA/topics/author-dita-doc-type.dita +++ b/DITA/topics/author-dita-doc-type.dita @@ -49,4 +49,4 @@ />/frameworks/dita/styleguide/catalog.xml

- \ No newline at end of file + diff --git a/DITA/topics/description-of-editor-types.dita b/DITA/topics/description-of-editor-types.dita index a5fdc7c843..93cd41cf73 100644 --- a/DITA/topics/description-of-editor-types.dita +++ b/DITA/topics/description-of-editor-types.dita @@ -2,7 +2,7 @@ - Supported Document Types + Supported Document Type diff --git a/README.md b/README.md new file mode 100644 index 0000000000..a149762157 --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +# userguide + +[![Build Status](https://travis-ci.org/ctalau/userguide.svg?branch=master)](https://travis-ci.org/ctalau/userguide) + +How to build it on travis: + +1. Create manually the gh-pages branch. +1. Copy the travis file to the project. +1. Create a personal access token, encrypt it with travis and add it to the config file. +1. Encrypt the license key file with travis and add it in the root directory of the project as licenseKey.txt. +1. Set the ditamap and the ditaval files as env variables. + +View the generated oXygen XML WebHelp at [http://ctalau.github.io/userguide/](http://ctalau.github.io/userguide/). diff --git a/licenseKey.txt.enc b/licenseKey.txt.enc new file mode 100644 index 0000000000..5dc1d0c728 --- /dev/null +++ b/licenseKey.txt.enc @@ -0,0 +1,3 @@ +&?C4=f([HQ ̺r2HW@;+[;:Ùj|UDk{3\-، 1d_f`.dr%Q@dr= piz* Ls^" @`5Md5zoRB/F疞IOd \,#pR̍Ȗɀ]ߜ?azZK0:LL0]NhĻ6m +}.(p[\;\˪x +.w5$z 7.4LW>S`GAUh=;M]WY?<C7*g[0: \ٿ>.pV:Gђ`J3s /vHY- \ No newline at end of file