You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by mg...@apache.org on 2016/03/25 15:11:06 UTC

[30/50] isis git commit: ISIS-1335: PDF versions of guides; also a new quote

ISIS-1335: PDF versions of guides; also a new quote


Project: http://git-wip-us.apache.org/repos/asf/isis/repo
Commit: http://git-wip-us.apache.org/repos/asf/isis/commit/b6c6d370
Tree: http://git-wip-us.apache.org/repos/asf/isis/tree/b6c6d370
Diff: http://git-wip-us.apache.org/repos/asf/isis/diff/b6c6d370

Branch: refs/heads/ISIS-1223-upgrade-to-wicket-7
Commit: b6c6d370db61504381a8b52b80340f82053b127a
Parents: 3b9c6b3
Author: Dan Haywood <da...@haywood-associates.co.uk>
Authored: Mon Mar 21 20:42:08 2016 +0000
Committer: Dan Haywood <da...@haywood-associates.co.uk>
Committed: Mon Mar 21 20:57:56 2016 +0000

----------------------------------------------------------------------
 adocs/documentation/monitor.sh                  |   2 +-
 adocs/documentation/pom.xml                     |  82 ++++++-------------
 .../src/main/asciidoc/documentation.adoc        |  26 +++---
 .../src/main/asciidoc/images/PDF-50.png         | Bin 0 -> 587 bytes
 .../documentation/src/main/asciidoc/index.html  |  11 +++
 .../documentation/src/main/asciidoc/quotes.adoc |  15 +++-
 6 files changed, 62 insertions(+), 74 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/isis/blob/b6c6d370/adocs/documentation/monitor.sh
----------------------------------------------------------------------
diff --git a/adocs/documentation/monitor.sh b/adocs/documentation/monitor.sh
index 2a448c1..69437a8 100644
--- a/adocs/documentation/monitor.sh
+++ b/adocs/documentation/monitor.sh
@@ -1,2 +1,2 @@
 #!/usr/bin/env bash
-mvn clean compile && ruby monitor.rb -b
+mvn compile -Dskip.pdf -o && ruby monitor.rb -b

http://git-wip-us.apache.org/repos/asf/isis/blob/b6c6d370/adocs/documentation/pom.xml
----------------------------------------------------------------------
diff --git a/adocs/documentation/pom.xml b/adocs/documentation/pom.xml
index f18c92c..f9fac73 100644
--- a/adocs/documentation/pom.xml
+++ b/adocs/documentation/pom.xml
@@ -123,20 +123,6 @@
                             <version>${asciidoctorj.version}</version>
                         </dependency>
                     </dependencies>
-                    <configuration>
-                        <sourceDirectory>src/main/asciidoc</sourceDirectory>
-                        <outputDirectory>${project.reporting.outputDirectory}</outputDirectory>
-                        <!-- Attributes common to all output formats -->
-                        <attributes>
-                            <sourcedir>${project.build.sourceDirectory}</sourcedir>
-                            <!--
-                            in essence unsets the imagesdir attribute (the mojo hardcodes it to "images").
-                            Has unfortunate side-effect of preventing docs from overriding with own value
-                            (but any other value seems to be incompatible with github's built-in rendering anyway)
-                            -->
-                            <imagesdir/>
-                        </attributes>
-                    </configuration>
                 </plugin>
             </plugins>
         </pluginManagement>
@@ -179,21 +165,24 @@
                                     <goal>process-asciidoc</goal>
                                 </goals>
                                 <configuration>
+                                    <backend>html5</backend>
+
+                                    <sourceDirectory>src/main/asciidoc</sourceDirectory>
+                                    <outputDirectory>${project.reporting.outputDirectory}</outputDirectory>
+
                                     <!-- The gem-maven-plugin appends the scope (e.g., provided) to the gemPath defined in the plugin configuration -->
                                     <gemPath>${project.build.directory}/gems-provided</gemPath>
-                                    <!--
-                                                <requires>
-                                                    <require>asciidoctor-diagram</require>
-                                                </requires>
-                                    -->
 
                                     <sourceHighlighter>coderay</sourceHighlighter>
-                                    <backend>html5</backend>
                                     <templateDir>../template</templateDir>
                                     <eruby>erb</eruby>
                                     <preserveDirectories>true</preserveDirectories>
                                     <relativeBaseDir>true</relativeBaseDir>
+
                                     <attributes>
+                                        <sourcedir>${project.build.sourceDirectory}</sourcedir>
+                                        <imagesdir/>
+
                                         <toc>right</toc>
                                         <icons>font</icons>
                                     </attributes>
@@ -225,18 +214,26 @@
                                 </goals>
                                 <configuration>
                                     <backend>pdf</backend>
-                                    <!-- Since 1.5.0-alpha.9 PDF back-end can use 'rouge' as well as 'coderay'
-                                    source highlighting -->
+
+                                    <sourceDirectory>src/main/asciidoc/guides</sourceDirectory>
+                                    <outputDirectory>${project.reporting.outputDirectory}/guides</outputDirectory>
+
                                     <sourceHighlighter>rouge</sourceHighlighter>
                                     <preserveDirectories>true</preserveDirectories>
                                     <relativeBaseDir>true</relativeBaseDir>
+                                    <doctype>book</doctype>
+
                                     <attributes>
+                                        <sourcedir>${project.build.sourceDirectory}</sourcedir>
+                                        <imagesdir/>
+
                                         <icons>font</icons>
                                         <pagenums/>
                                         <toc/>
                                         <idprefix/>
                                         <idseparator>-</idseparator>
                                     </attributes>
+
                                 </configuration>
                             </execution>
                         </executions>
@@ -244,7 +241,7 @@
                 </plugins>
             </build>
         </profile>
-        
+
         <profile>
             <id>copy</id>
             <activation>
@@ -265,8 +262,6 @@
                                     <target>
                                         <echo message=""/>
                                         <echo message=""/>
-
-                                        <echo message=""/>
                                         <echo message="deleting everything in ${isis-site.dir}"/>
                                         <echo message=""/>
                                         <delete includeemptydirs="true">
@@ -286,23 +281,7 @@
                                         <echo message="copying from ${build.dir} to ${isis-site.dir} (ignoring PDFs)"/>
                                         <echo message=""/>
                                         <copy todir="${isis-site.dir}" overwrite="true" force="true">
-                                            <fileset dir="${build.dir}" excludes="**/*.pdf"/>
-                                        </copy>
-
-                                        <echo message=""/>
-                                        <echo message=""/>
-                                        <echo message="copying from ${build.dir}/resouces/*.pdf to ${isis-site.dir}/resources"/>
-                                        <echo message=""/>
-                                        <copy todir="${isis-site.dir}/resources" overwrite="true" force="true">
-                                            <fileset dir="${build.dir}/resources" includes="**/*.pdf"/>
-                                        </copy>
-
-                                        <echo message=""/>
-                                        <echo message=""/>
-                                        <echo message="copying PDFs from ${build.dir}/guides to ${isis-site.dir}/guides"/>
-                                        <echo message=""/>
-                                        <copy todir="${isis-site.dir}/guides" overwrite="true" force="true">
-                                            <fileset dir="${build.dir}/guides" includes="**/*.pdf"/>
+                                            <fileset dir="${build.dir}"/>
                                         </copy>
 
                                         <echo message=""/>
@@ -340,8 +319,8 @@
                         <version>1.8</version>
                         <executions>
                             <execution>
-                                <id>package</id>
-                                <phase>package</phase>
+                                <id>install</id>
+                                <phase>install</phase>
                                 <configuration>
                                     <target>
                                         <echo message=""/>
@@ -353,24 +332,9 @@
                                             <arg value="--all"/>
                                             <arg value="."/>
                                         </exec>
-                                        <echo message=""/>
-
 
                                         <echo message=""/>
                                         <echo message=""/>
-                                    </target>
-                                </configuration>
-                                <goals>
-                                    <goal>run</goal>
-                                </goals>
-                            </execution>
-                            <execution>
-                                <id>install</id>
-                                <phase>install</phase>
-                                <configuration>
-                                    <target>
-                                        <echo message=""/>
-                                        <echo message=""/>
                                         <echo message="git commit -m '${message}' "/>
                                         <echo message=""/>
                                         <exec executable="git" dir="${isis-site.dir}">

http://git-wip-us.apache.org/repos/asf/isis/blob/b6c6d370/adocs/documentation/src/main/asciidoc/documentation.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/documentation.adoc b/adocs/documentation/src/main/asciidoc/documentation.adoc
index 3540663..00ac3ae 100644
--- a/adocs/documentation/src/main/asciidoc/documentation.adoc
+++ b/adocs/documentation/src/main/asciidoc/documentation.adoc
@@ -59,32 +59,32 @@ pass:[<br/>]
 
 |*User Guides:*
 
-* *link:./guides/ugfun.html[Fundamentals^]*
-* link:./guides/ugvw.html[Wicket Viewer^]
-* link:./guides/ugvro.html[Restful Objects Viewer^]
-* link:./guides/ugsec.html[Security^]
-* *link:./guides/ugtst.html[Testing^]*
-* link:./guides/ugbtb.html[Beyond the Basics^]
+* *link:./guides/ugfun.html[Fundamentals^]*  image:{_imagesdir}PDF-50.png[width="20px" link="./guides/ugfun.pdf"]
+* link:./guides/ugvw.html[Wicket Viewer^]  image:{_imagesdir}PDF-50.png[width="20px" link="./guides/ugvw.pdf"]
+* link:./guides/ugvro.html[Restful Objects Viewer^]  image:{_imagesdir}PDF-50.png[width="20px" link="./guides/ugvro.pdf"]
+* link:./guides/ugsec.html[Security^]  image:{_imagesdir}PDF-50.png[width="20px" link="./guides/ugsec.pdf"]
+* *link:./guides/ugtst.html[Testing^]*  image:{_imagesdir}PDF-50.png[width="20px" link="./guides/ugtst.pdf"]
+* link:./guides/ugbtb.html[Beyond the Basics^]  image:{_imagesdir}PDF-50.png[width="20px" link="./guides/ugbtb.pdf"]
 
 
 |*Reference Guides:*
 
-* *link:./guides/rgant.html[Annotations^]*
-* *link:./guides/rgsvc.html[Domain Services^]*
-* link:./guides/rgcfg.html[Configuration Properties^]
-* link:./guides/rgcms.html[Classes, Methods and Schema^]
-* link:./guides/rgmvn.html[Apache Isis Maven plugin^]
+* *link:./guides/rgant.html[Annotations^]*  image:{_imagesdir}PDF-50.png[width="20px" link="./guides/rgant.pdf"]
+* *link:./guides/rgsvc.html[Domain Services^]*  image:{_imagesdir}PDF-50.png[width="20px" link="./guides/rgsvc.pdf"]
+* link:./guides/rgcfg.html[Configuration Properties^]  image:{_imagesdir}PDF-50.png[width="20px" link="./guides/rgcfg.pdf"]
+* link:./guides/rgcms.html[Classes, Methods and Schema^]  image:{_imagesdir}PDF-50.png[width="20px" link="./guides/rgcms.pdf"]
+* link:./guides/rgmvn.html[Apache Isis Maven plugin^]  image:{_imagesdir}PDF-50.png[width="20px" link="./guides/rgmvn.pdf"]
 
 
 
 
 |*"Supporting" Guides:*
 
-* *link:./guides/dg.html[Developers' Guide^]*
+* *link:./guides/dg.html[Developers' Guide^]*  image:{_imagesdir}PDF-50.png[width="20px" link="./guides/dg.pdf"]
 ** Setting up link:./guides/dg.html#_dg_ide_intellij[IntelliJ^] or link:./guides/dg.html#_dg_ide_eclipse[Eclipse^]
 ** link:./guides/dg.html#_dg_contributing[Contributing patches^] (pull requests)
 
-* link:./guides/cgcom.html[Committers' Guide^]
+* link:./guides/cgcom.html[Committers' Guide^]  image:{_imagesdir}PDF-50.png[width="20px" link="./guides/cgcom.pdf"]
 ** link:./guides/cgcom.html#_cgcom_cutting-a-release[Cutting a release^]
 ** link:./guides/cgcom.html#_cgcom_verifying-releases[Verifying a release^]
 

http://git-wip-us.apache.org/repos/asf/isis/blob/b6c6d370/adocs/documentation/src/main/asciidoc/images/PDF-50.png
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/images/PDF-50.png b/adocs/documentation/src/main/asciidoc/images/PDF-50.png
new file mode 100644
index 0000000..e2694ca
Binary files /dev/null and b/adocs/documentation/src/main/asciidoc/images/PDF-50.png differ

http://git-wip-us.apache.org/repos/asf/isis/blob/b6c6d370/adocs/documentation/src/main/asciidoc/index.html
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/index.html b/adocs/documentation/src/main/asciidoc/index.html
index 3593f0e..243f16f 100644
--- a/adocs/documentation/src/main/asciidoc/index.html
+++ b/adocs/documentation/src/main/asciidoc/index.html
@@ -564,6 +564,17 @@ And I must say this: "Great Support from the development team"</p>
                                 <blockquote>
                                     <div class="row">
                                         <div class="large-12 medium-12">
+                                            <p>Apache Isis is an easy to learn, efficient and productive RAD platform. Further I can say it is evolving to be
+                                               "the best RAD platform" without any exaggerations. The help from the community is simply wonderful.</p>
+                                            <small>Theekshana Dilshan, Computer Science and Engineering, University of Moratuwa, Sri Lanka.</small>
+                                        </div>
+                                    </div>
+                                </blockquote>
+                            </div>
+                            <div>
+                                <blockquote>
+                                    <div class="row">
+                                        <div class="large-12 medium-12">
                                             <p>Apache Isis is one of the best tools for hackathons.  Given a 2 day hackathon challenge I have the perfect framework to create my prototype helping me to focus on business logic.</p>
                                             <small>Sunand Padmanabhan</small>
                                         </div>

http://git-wip-us.apache.org/repos/asf/isis/blob/b6c6d370/adocs/documentation/src/main/asciidoc/quotes.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/quotes.adoc b/adocs/documentation/src/main/asciidoc/quotes.adoc
index ae16553..0f3ad4a 100644
--- a/adocs/documentation/src/main/asciidoc/quotes.adoc
+++ b/adocs/documentation/src/main/asciidoc/quotes.adoc
@@ -157,7 +157,20 @@ pass:[</p></div>]
 
 pass:[<br/><br/>]
 pass:[<div class="extended-quote-first"><p>]
-Apache Isis is one of the best tools for hackathons.  Given a 2 day hackathon challenge I have the perfect framework to create my prototype helping me to focus on business logic.
+Apache Isis is an easy to learn, efficient and productive RAD platform. Further I can say it is evolving to be
+"the best RAD platform" without any exaggerations. The help from the community is simply wonderful.
+pass:[</p></div>]
+
+pass:[<div class="extended-quote-attribution"><p>]
+-- Theekshana Dilshan, Computer Science and Engineering, University of Moratuwa, Sri Lanka.
+pass:[</p></div>]
+
+
+
+pass:[<br/><br/>]
+pass:[<div class="extended-quote-first"><p>]
+Apache Isis is one of the best tools for hackathons.  Given a 2 day hackathon challenge I have the perfect framework
+to create my prototype helping me to focus on business logic.
 pass:[</p></div>]
 
 pass:[<div class="extended-quote-attribution"><p>]