You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2015/08/04 22:20:56 UTC
[1/4] isis git commit: ISIS-1082: adding missing license declarations
into supplemenal_models.xml
Repository: isis
Updated Branches:
refs/heads/master acc84dfe3 -> 4411b51d6
ISIS-1082: adding missing license declarations into supplemenal_models.xml
Project: http://git-wip-us.apache.org/repos/asf/isis/repo
Commit: http://git-wip-us.apache.org/repos/asf/isis/commit/e9278100
Tree: http://git-wip-us.apache.org/repos/asf/isis/tree/e9278100
Diff: http://git-wip-us.apache.org/repos/asf/isis/diff/e9278100
Branch: refs/heads/master
Commit: e9278100dd0f0d9a9add0ed18ac37cf9785d6989
Parents: acc84df
Author: Dan Haywood <da...@haywood-associates.co.uk>
Authored: Tue Aug 4 07:51:05 2015 +0100
Committer: Dan Haywood <da...@haywood-associates.co.uk>
Committed: Tue Aug 4 07:51:05 2015 +0100
----------------------------------------------------------------------
.../appended-resources/supplemental-models.xml | 40 ++++++++++----------
1 file changed, 21 insertions(+), 19 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/isis/blob/e9278100/core/src/main/appended-resources/supplemental-models.xml
----------------------------------------------------------------------
diff --git a/core/src/main/appended-resources/supplemental-models.xml b/core/src/main/appended-resources/supplemental-models.xml
index 6c87e92..e7e93f3 100644
--- a/core/src/main/appended-resources/supplemental-models.xml
+++ b/core/src/main/appended-resources/supplemental-models.xml
@@ -96,25 +96,6 @@
<supplement>
<project>
- <groupId>org.datanucleus</groupId>
- <artifactId>datanucleus-jdo-query</artifactId>
- <version>3.0.2</version>
- <name>DataNucleus JDO Query</name>
- <organization>
- <name>DataNucleus</name>
- <url>http://www.datanucleus.org/</url>
- </organization>
- <licenses>
- <license>
- <name>The Apache Software License, Version 2.0</name>
- <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
- </license>
- </licenses>
- </project>
- </supplement>
-
- <supplement>
- <project>
<groupId>org.sonatype.spice</groupId>
<artifactId>model-builder</artifactId>
<version>1.3</version>
@@ -151,4 +132,25 @@
</project>
</supplement>
+ <supplement>
+ <project>
+ <groupId>javax.xml.bind</groupId>
+ <artifactId>jsr173_api</artifactId>
+ <version>1.0</version>
+ <name>JSR173 API</name>
+ <organization>
+ <name>Sun Microsystems</name>
+ <url>http://www.sun.com/</url>
+ </organization>
+ <licenses>
+ <license>
+ <name>
+ COMMON DEVELOPMENT AND DISTRIBUTION LICENSE (CDDL) Version 1.0
+ </name>
+ <url>http://www.sun.com/cddl/cddl.html</url>
+ </license>
+ </licenses>
+ </project>
+ </supplement>
+
</supplementalDataModels>
[4/4] isis git commit: ISIS-1082: documenting the asciidoctor
templates.
Posted by da...@apache.org.
ISIS-1082: documenting the asciidoctor templates.
Project: http://git-wip-us.apache.org/repos/asf/isis/repo
Commit: http://git-wip-us.apache.org/repos/asf/isis/commit/4411b51d
Tree: http://git-wip-us.apache.org/repos/asf/isis/tree/4411b51d
Diff: http://git-wip-us.apache.org/repos/asf/isis/diff/4411b51d
Branch: refs/heads/master
Commit: 4411b51d6521bf5e2b3f8db4bfdd61665077f5bd
Parents: 37e42b2
Author: Dan Haywood <da...@haywood-associates.co.uk>
Authored: Tue Aug 4 21:12:57 2015 +0100
Committer: Dan Haywood <da...@haywood-associates.co.uk>
Committed: Tue Aug 4 21:12:57 2015 +0100
----------------------------------------------------------------------
.../asciidoc/guides/_cg_asciidoc-templates.adoc | 804 +++++++++++++++++++
.../src/main/asciidoc/guides/_cg_asciidoc.adoc | 8 +-
.../main/asciidoc/guides/_cg_git-cookbook.adoc | 2 +-
.../main/asciidoc/guides/_cg_ide-templates.adoc | 17 +-
.../src/main/asciidoc/guides/cg.adoc | 1 +
.../templates/asciidoc-templates-idea.xml | 365 +++++++++
6 files changed, 1190 insertions(+), 7 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/isis/blob/4411b51d/adocs/documentation/src/main/asciidoc/guides/_cg_asciidoc-templates.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_cg_asciidoc-templates.adoc b/adocs/documentation/src/main/asciidoc/guides/_cg_asciidoc-templates.adoc
new file mode 100644
index 0000000..3c7a9dd
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/guides/_cg_asciidoc-templates.adoc
@@ -0,0 +1,804 @@
+[[_cg_asciidoc-templates]]
+= Appendix: Asciidoc Templates
+:notice: licensed to the apache software foundation (asf) under one or more contributor license agreements. see the notice file distributed with this work for additional information regarding copyright ownership. the asf licenses this file to you under the apache license, version 2.0 (the "license"); you may not use this file except in compliance with the license. you may obtain a copy of the license at. http://www.apache.org/licenses/license-2.0 . unless required by applicable law or agreed to in writing, software distributed under the license is distributed on an "as is" basis, without warranties or conditions of any kind, either express or implied. see the license for the specific language governing permissions and limitations under the license.
+:_basedir: ../
+:_imagesdir: images/
+:toc: right
+
+
+
+This appendix lists the (IntelliJ) live templates available for xref:cg.adoc#_cg_asciidoc[writing documentation] using Asciidoc. Instructions for installing the templates can be found xref:cg.adoc#_cg_ide-templates[here].
+
+In the examples below the text `xxx`, `yyy`, `zzz` are correspond to template variables (ie placeholders).
+
+== Callouts
+
+The Asciidoctor terminology is an "admonition".
+
+[cols="1,4,2a", options="header"]
+|===
+| Abbrev.
+| Produces
+| Example
+
+|`adadmimportant`
+| `[IMPORTANT] +
+==== +
+xxx +
+====`
+|[IMPORTANT]
+====
+xxx
+====
+
+|`adadmnote`
+| `[NOTE] +
+==== +
+xxx +
+====`
+|[NOTE]
+====
+xxx
+====
+
+|`adadmtip`
+| `[TIP] +
+==== +
+xxx +
+====`
+|[TIP]
+====
+xxx
+====
+
+|`adadmwarning`
+| `[WARNING] +
+==== +
+xxx +
+====`
+|[WARNING]
+====
+xxx
+====
+
+|===
+
+
+== TODO notes
+
+Add as a placeholder for documentation still to be written or which is work-in-progress.
+
+[cols="1,4a,2a", options="header"]
+|===
+| Abbrev.
+| Produces
+| Example
+
+|`adtodo`
+|pass:[<pre>NOTE: TODO</pre>]
+|NOTE: TODO
+
+|`adwip`
+|pass:[<pre>NOTE: WIP - xxx</pre>]
+
+where:
+
+* `xxx` is additional explanatory text
+
+|NOTE: WIP - cool new feature
+
+|===
+
+
+
+
+== Xref to Contributors' Guide
+
+Cross-references (links) to the xref:cg.adoc#_cg[Contributors' Guide] (this document).
+
+[cols="1,4a,2a", options="header"]
+|===
+| Abbrev.
+| Produces
+| Example
+
+
+|`adcg`
+|pass:[<pre>xref:cg.adoc#_cg[Contributors' Guide\]</pre>] +
+
+a hyperlink to the contributors guide.
+|xref:cg.adoc#_cg[Contributors' Guide]
+
+|`adcg1`
+|pass:[<pre>xref:cg.adoc#_cg_xxx[ttt\]</pre>]
+
+a hyperlink to a level 1 (chapter) within the contributors guide, where:
+
+* `xxx` is the chapter's anchor
+* `ttt` is the text to display as the hyperlink
+
+for example:
+
+pass:[<pre>xref:cg.adoc#_cg_asciidoc-templates[Asciidoc templates/]</pre>]
+
+|xref:cg.adoc#_cg_asciidoc-templates[Asciidoc templates]
+
+
+|`adcg2`
+|pass:[<pre>xref:cg.adoc#_cg_xxx_yyy[ttt\]</pre>]
+
+a hyperlink to a level 2 (chapter and section) within the contributors guide, where:
+
+* `xxx` and `yyy` make up the anchor to the section within the chapter
+* `ttt` is the text to display as the hyperlink
+
+for example:
+
+pass:[<pre>xref:cg.adoc#_cg_committers_release-process[Release process/]</pre>]
+
+|xref:cg.adoc#_cg_committers_release-process[Release process]
+
+|===
+
+
+
+== Xref to Reference Guide
+
+Cross-references (links) to the xref:rg.adoc#_rg[Reference Guide].
+
+[cols="1,4a,2a", options="header"]
+|===
+| Abbrev.
+| Produces
+| Example
+
+|`adrg`
+|pass:[<pre>xref:rg.adoc#_rg[Reference Guide\]</pre>]
+
+a hyperlink to the Reference Guide.
+
+|xref:rg.adoc#_rg[Reference Guide]
+
+|`adrg1`
+|pass:[<pre>xref:rg.adoc#_rg_xxx[ttt\]</pre>]
+
+a hyperlink to a level 1 (chapter) within the reference guide, where:
+
+* `xxx` is the chapter's anchor
+* `ttt` is the text to display as the hyperlink
+
+for example:
+
+pass:[<pre>xref:rg.adoc#_rg_annotations[Annotations\]</pre>]
+
+|xref:rg.adoc#_rg_annotations[Annotations]
+
+
+
+|`adrg2`
+|pass:[<pre>xref:rg.adoc#_rg_xxx_yyy[ttt\]</pre>]
+
+a hyperlink to a level 2 (chapter and section) within the reference guide, where:
+
+* `xxx` and `yyy` make up the anchor to the section within the chapter
+* `ttt` is the text to display as the hyperlink
+
+for example:
+
+pass:[<pre>xref:rg.adoc#_rg_object-layout_dynamic_[Dynamic object layout]</pre>]
+
+|xref:rg.adoc#_rg_object-layout_dynamic[Dynamic object layout]
+
+
+
+|`adrg3`
+|pass:[<pre>xref:rg.adoc#_rg_xxx_yyy_zzz[ttt\]</pre>]
+
+a hyperlink to a level 3 (chapter, section, subsection) within the reference guide, where:
+
+* `xxx`, `yyy`, `zzz` make up the anchor to the subsection within the chapter
+* `ttt` is the text to display as the hyperlink
+
+for example:
+
+pass:[<pre>xref:rg.adoc#_rg_runtime_application-specific_application-css[Application-specific CSS\]</pre>]
+
+|xref:rg.adoc#_rg_runtime_application-specific_application-css[Application-specific CSS]
+
+
+
+|`adrgcfg`
+|pass:[<pre>xref:rg.adoc#_rg_runtime_configuring-core[configuration properties]</pre>]
+
+a hyperlink to the reference guide's catalogue of the Apache Isis configuration properties.
+
+|xref:rg.adoc#_rg_runtime_configuring-core[configuration properties]
+
+
+
+|`adrgcs`
+|pass:[<pre>xref:rg.adoc#_rg_classes_super_manpage-xxx[`xxx`\]</pre>]
+
+a hyperlink to the "man page" for a superclass, where:
+
+* `xxx` is the superclass (eg `AbstractDomainService`)
+
+for example:
+
+pass:[<pre>xref:rg.adoc#_rg_classes_super_manpage-AbstractDomainService[`AbstractDomainService`\]</pre>]
+
+|xref:rg.adoc#_rg_classes_super_manpage-AbstractDomainService[`AbstractDomainService`]
+
+
+
+|`adrgcu`
+|pass:[<pre>xref:rg.adoc#_rg_classes_utility_manpage-xxx[`xxx`\]</pre>]
+
+a hyperlink to the "man page" for a utility class, where:
+
+* `xxx` is the utility class (eg `TitleBuffer`)
+
+for example:
+
+pass:[<pre>xref:rg.adoc#_rg_classes_utility_manpage-TitleBuffer[`TitleBuffer`\]</pre>]
+
+|xref:rg.adoc#_rg_classes_utility_manpage-TitleBuffer[`TitleBuffer`]
+
+
+
+|`adrgcv`
+|pass:[<pre>xref:rg.adoc#_rg_classes_value-types_manpage-xxx[`xxx`\]</pre>]
+
+
+a hyperlink to the "man page" for an applib value class, where:
+
+* `xxx` is the utility class (eg `Blob`)
+
+for example:
+
+pass:[<pre>xref:rg.adoc#_rg_classes_value-types_manpage-Blob[`Blob`\]</pre>]
+
+|xref:rg.adoc#_rg_classes_value-types_manpage-Blob[`Blob`]
+
+
+
+|`adrgmp`
+|pass:[<pre>xref:rg.adoc#_rg_methods_prefixes_manpage-xxx[`xxx...()`\]</pre>]
+
+a hyperlink to the "man page" for a prefixed method, where:
+
+* `xxx` is the method prefix (eg `disable...()`)
+
+for example:
+
+pass:[<pre>xref:rg.adoc#_rg_methods_prefixes_manpage-disable[`disable...()`\]</pre>]
+
+|xref:rg.adoc#_rg_methods_prefixes_manpage-disable[`disable...()`]
+
+
+
+|`adrgmr`
+|pass:[<pre></pre>]
+
+a hyperlink to the "man page" for a reserved method, where:
+
+* `xxx` is the method prefix (eg `title()`)
+
+for example:
+
+pass:[<pre>xref:rg.adoc#_rg_methods_reserved_manpage-title[`title()`\]</pre>]
+
+|xref:rg.adoc#_rg_methods_reserved_manpage-title[`title()`]
+
+
+
+|`adrgna`
+|pass:[<pre>xref:rg.adoc#_rg_annotations_manpage-xxx[`@xxx`]</pre>]
+
+a hyperlink to the "man page" for an annotation, where:
+
+* `xxx` is the annotation type (eg `@Action`)
+
+for example:
+
+pass:[<pre>xref:rg.adoc#_rg_annotations_manpage-Action[`@Action`\]</pre>]
+
+|xref:rg.adoc#_rg_annotations_manpage-Action[`@Action`]
+
+
+
+|`adrgnt`
+|pass:[<pre>xref:rg.adoc#_rg_annotations_manpage-xxx_ttt[`@xxx#ttt()`]</pre>]
+
+a hyperlink to the "man page" for the specific attribute (field) of an annotation, where:
+
+* `xxx` is the annotation type (eg `@Action`)
+* `ttt` is the attribute (eg `@semantics`)
+
+for example:
+
+pass:[<pre>xref:rg.adoc#_rg_annotations_manpage-Action_semantics[`@Action#semantics()`\]</pre>]
+
+|xref:rg.adoc#_rg_annotations_manpage-Action_semantics[`@Action#semantics()`]
+
+
+
+|`adrgsa`
+|pass:[<pre></pre>]
+
+a hyperlink to the "man page" for an (API) domain service, where:
+
+* `xxx` is the domain service (eg `DomainObjectContainer`)
+
+for example:
+
+pass:[<pre>xref:rg.adoc#_rg_services-api_manpage-DomainObjectContainer[`DomainObjectContainer`\]</pre>]
+
+|xref:rg.adoc#_rg_services-api_manpage-DomainObjectContainer[`DomainObjectContainer`]
+
+
+
+|`adrgss`
+|pass:[<pre></pre>]
+
+a hyperlink to the "man page" for an (SPI) domain service, where:
+
+* `xxx` is the domain service (eg `ContentMappingService`)
+
+for example:
+
+pass:[<pre>xref:rg.adoc#_rg_services-spi_manpage-ContentMappingService[`ContentMappingService`\]</pre>]
+|xref:rg.adoc#_rg_services-spi_manpage-ContentMappingService[`ContentMappingService`]
+
+
+
+|===
+
+
+
+== Xref to the Users' Guide
+
+Cross-references (links) to the xref:ug.adoc#_ug[Users' Guide].
+
+[cols="1,4a,2a", options="header"]
+|===
+| Abbrev.
+| Produces
+| Example
+
+|`adug`
+|pass:[<pre>xref:ug.adoc#_ug[Users' Guide\]</pre>]
+
+a hyperlink to the Users' Guide.
+
+|xref:ug.adoc#_ug[Users' Guide]
+
+
+
+|`adug1`
+|pass:[<pre>xref:ug.adoc#xxx[ttt\]</pre>]
+
+a hyperlink to a level 1 (chapter) within the users' guide, where:
+
+* `xxx` is the chapter's anchor
+* `ttt` is the text to display as the hyperlink
+
+for example:
+
+pass:[<pre>xref:ug.adoc#_ug_core-concepts[Core concepts\]</pre>]
+
+|xref:ug.adoc#_ug_core-concepts[Core concepts]
+
+
+
+|`adug2`
+|pass:[<pre>xref:ug.adoc#xxx_yyy[ttt\]</pre>]
+
+a hyperlink to a level 2 (chapter and section) within the users' guide, where:
+
+* `xxx` and `yyy` make up the anchor to the section within the chapter
+* `ttt` is the text to display as the hyperlink
+
+for example:
+
+pass:[<pre>xref:ug.adoc#core-concepts_philosophy[Philosophy\]</pre>]
+
+
+|xref:ug.adoc#core-concepts_philosophy[Philosophy]
+
+
+
+|`adug3`
+|pass:[<pre>xref:ug.adoc#xxx_yyy_zzz[ttt\]</pre>]
+
+a hyperlink to a level 3 (chapter, section, subsection) within the users' guide, where:
+
+* `xxx`, `yyy`, `zzz` make up the anchor to the subsection within the chapter
+* `ttt` is the text to display as the hyperlink
+
+for example:
+
+pass:[<pre>xref:ug.adoc#_ug_core-concepts_philosophy_naked-objects-pattern[Naked objects pattern\]</pre>]
+
+|xref:ug.adoc#_ug_core-concepts_philosophy_naked-objects-pattern[Naked objects pattern]
+
+
+
+
+|`adugsimpleapp`
+|pass:[<pre>xref:ug.adoc#_ug_getting-started_simpleapp-archetype[SimpleApp archetype\]</pre>]
+
+A hyperlink to the `simpleapp` archetype in the "getting started" chapter.
+
+|xref:ug.adoc#_ug_getting-started_simpleapp-archetype[SimpleApp archetype]
+
+
+|`adugvro`
+|pass:[<pre>xref:ug.adoc#_ug_restfulobjects-viewer[RestfulObjects viewer\]</pre>]
+
+A hyperlink to the Restful Objects viewer chapter.
+
+|xref:ug.adoc#_ug_restfulobjects-viewer[RestfulObjects viewer]
+
+
+
+|`adugvw`
+|pass:[<pre>xref:ug.adoc#_ug_wicket-viewer[Wicket viewer\]</pre>]
+
+A hyperlink to the Wicket viewer chapter.
+
+|xref:ug.adoc#_ug_wicket-viewer[Wicket viewer]
+
+
+
+|===
+
+
+
+
+== Link to Isis Addons
+
+Links to (non-ASF) link:http://isisaddons.org[Isis Addons]
+
+[cols="1,4a,2a", options="header"]
+|===
+| Abbrev.
+| Produces
+| Example
+
+
+|`adlinkaddons`
+|pass:[<pre>(non-ASF) link:http://isisaddons.org[Isis Addons\]</pre>]
+
+link to the Isis Addons website.
+
+|(non-ASF) link:http://isisaddons.org[Isis Addons]
+
+
+
+|`adlinkaddonsapp`
+|pass:[<pre>(non-ASF) http://github.com/isisaddons/isis-app-xxx[Isis addons' xxx]</pre>]
+
+link to the github repo for an example app from the Isis addons; where:
+
+* `xxx` is the name of the example app being linked to
+
+for example:
+
+pass:[<pre>(non-ASF) http://github.com/isisaddons/isis-app-todoapp[Isis addons' todoapp\]</pre>]
+
+|(non-ASF) http://github.com/isisaddons/isis-app-todoapp[Isis addons' todoapp]
+
+
+
+|`adlinkaddonsmodule`
+|pass:[<pre></pre>]
+
+link to the github repo for a module from the Isis addons; where:
+
+* `xxx` is the name of the module being linked to
+
+for example:
+
+pass:[<pre>(non-ASF) http://github.com/isisaddons/isis-module-security[Isis addons' security\] module</pre>]
+
+|(non-ASF) http://github.com/isisaddons/isis-module-security[Isis addons' security] module
+
+
+
+|`adlinkaddonswicket`
+|pass:[<pre></pre>]
+
+link to the github repo for a wicket UI component from the Isis addons; where:
+
+* `xxx` is the name of the wicket UI component being linked to
+
+for example:
+
+pass:[<pre>(non-ASF) http://github.com/isisaddons/isis-wicket-gmap3[Isis addons' gmap3 \] wicket extension</pre>]
+
+
+|(non-ASF) http://github.com/isisaddons/isis-wicket-gmap3[Isis addons' gmap3 ] wicket extension
+
+|===
+
+
+
+
+== Source code
+
+[cols="1,4a,2a", options="header"]
+|===
+| Abbrev.
+| Produces
+| Example
+
+|`adsrcjava`
+|`[source,java] +
+---- +
+xxx +
+----`
+
+where:
+
+* `xxx` is the source code snippet.
+
+|[source,java]
+----
+public class Foo {
+ ...
+}
+----
+
+
+|`adsrcjavac`
+|as for `adsrcjava`, but with a caption above
+|
+
+
+
+|`adsrcjavascript`
+|`[source,javascript] +
+---- +
+xxx +
+----`
+
+where:
+
+* `xxx` is the source code snippet.
+
+|[source,javascript]
+----
+$(document).ready(function() {
+ ...
+});
+----
+
+
+
+|`adsrcjavascriptc`
+|as for `adsrcjavascript`, but with a caption above
+
+|
+
+|`adsrcother`
+|`[source,nnn] +
+---- +
+xxx +
+----`
+
+where:
+
+* `nnn` is the programming language
+* `xxx` is the source code snippet.
+
+|
+
+|`adsrcotherc`
+|as for `adsrcother`, but with a caption above
+
+
+|
+
+|`adsrcxml`
+|`[source,javascript] +
+---- +
+xxx +
+----`
+
+where:
+
+* `xxx` is the source code snippet.
+
+|[source,xml]
+----
+<html>
+ <title>
+ hello world!
+ </title>
+</html>
+----
+
+
+|`adsrcxmlc`
+|as for `adsrcxml`, but with a caption above
+|
+
+|===
+
+
+== Images
+
+[cols="1,4a,2a", options="header"]
+|===
+| Abbrev.
+| Produces
+| Example
+
+|`adimgfile`
+|pass:[<pre>image::{_imagesdir}xxx/yyy.png[width="WWWpx",link="{_imagesdir}xxx/yyy.png"\]</pre>]
+
+embeds specified image, where:
+
+* `xxx` is the subdirectory under the `images/` directory
+* `yyy` is the image
+* `WWW` is the width, in pixels.
+
+for example:
+
+pass:[<pre>image::{_imagesdir}wicket-viewer/layouts/estatio-Lease.png[width="300px",link="{_imagesdir}wicket-viewer/layouts/estatio-Lease.png"\]</pre>]
+
+|image::{_imagesdir}wicket-viewer/layouts/estatio-Lease.png[width="300px",link="{_imagesdir}wicket-viewer/layouts/estatio-Lease.png"]
+
+
+
+|`adimgfilec`
+|as for `adimgfile`, but with a caption above
+|
+
+
+|`adimgurl`
+|pass:[<pre>image::xxx[width="WWWpx",link="xxx"\]</pre>]
+
+embeds image from specified URL, where:
+
+* `xxx` is the URL to the image
+* `WWW` is the width, in pixels.
+
+|
+
+
+
+|`adimgurlc`
+|as for `adimgurl`, but with a caption above
+|
+
+
+|===
+
+
+
+== YouTube (screencasts)
+
+Embedded youtube screencasts
+
+[cols="1,4a,2a", options="header"]
+|===
+| Abbrev.
+| Produces
+| Example
+
+|`adyoutube`
+|pass:[<pre>video::xxx[youtube,width="WWWpx",height="HHHpx"\]</pre>]
+
+where:
+
+* `xxx` is the youtube reference
+* `WWW` is the width, in pixels
+* `HHH` is the height, in pixels
+
+for example:
+
+pass:[<pre>video::bj8735nBRR4[youtube,width="210px",height="118px"\] </pre>]
+
+|video::bj8735nBRR4[youtube,width="210px",height="118px"]
+
+
+|`adyoutubec`
+|as for `youtube`, but with a caption above
+|
+
+|===
+
+
+== Tables
+
+[cols="1,4a,2a", options="header"]
+|===
+| Abbrev.
+| Produces
+| Example
+
+|`adtbl3`
+|Table with 3 columns, 3 rows.
+|
+
+
+|===
+
+
+== Misc.
+
+[cols="1,4a,2a", options="header"]
+|===
+| Abbrev.
+| Produces
+| Example
+
+|`adai`
+|pass:[<pre>Apache Isis</pre>] +
+
+That is, the literal text "Apache Isis".
+|Apache Isis
+
+
+
+|`adlink`
+|pass:[<pre>link:xxx[ttt\]</pre>]
+
+, where:
+
+* `xxx` is
+* `ttt` is the text to display as the hyperlink
+
+for example:
+
+pass:[<pre>link:http://isis.apache.org[Apache Isis website\]</pre>]
+
+|link:http://isis.apache.org[Apache Isis website]
+
+
+
+
+|`adanchany`
+|pass:[<pre>= anchor:[xxx\]</pre>]
+
+defines an inline anchor to any heading, where:
+
+* `xxx` is the anchor text.
+
+For example:
+
+pass:[<pre>= anchor:[_ug_i18n\] Internationalization</pre>]
+
+An alternative (more commonly used in our documentation) is to use the `[[...]]` directly above the heading:
+
+pass:[<pre>[[_ug_i18n\]\]
+= Internationalization</pre>]
+
+|
+
+
+|`adxrefany`
+|pass:[<pre>xref:[xxx\]</pre>]
+
+cross-reference to any document/anchor, where:
+
+* `xxx` is the fully qualified document with optional anchor
+
+|
+
+
+|`adfootnote`
+|pass:[<pre>.footnote:[\]</pre>]
+
+defines a footnote
+|.footnote:[this is a footnote]
+
+
+
+|===
+
+
+
+
http://git-wip-us.apache.org/repos/asf/isis/blob/4411b51d/adocs/documentation/src/main/asciidoc/guides/_cg_asciidoc.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_cg_asciidoc.adoc b/adocs/documentation/src/main/asciidoc/guides/_cg_asciidoc.adoc
index bc9015d..ae328c3 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_cg_asciidoc.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_cg_asciidoc.adoc
@@ -16,7 +16,6 @@ Publishing is performed by copying the generated HTML to a different git reposit
-
== Where to find the Docs
The (Asciidoc) source code can be found at `adocs/documentation` (relative to root). Online you'll find it link:https://github.com/apache/isis/tree/master/adocs/documentation[cloned to github here].
@@ -60,6 +59,13 @@ xxx-xxx/resources/.
+== Writing the docs
+
+We highly recommend that you install the (IntelliJ) live templates for Asciidoctor, as described in xref:cg.adoc#_cg_ide-templates[IDE templates]. These provide a large number of helper templates.
+
+An xref:cg.adoc#_cg_appendix_asciidoc-templates[appendix] lists all the templates available, demonstrating their intended usage and output.
+
+
== Build and Review (using Maven)
To (re)build the documentation locally prior to release, use:
http://git-wip-us.apache.org/repos/asf/isis/blob/4411b51d/adocs/documentation/src/main/asciidoc/guides/_cg_git-cookbook.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_cg_git-cookbook.adoc b/adocs/documentation/src/main/asciidoc/guides/_cg_git-cookbook.adoc
index 70b6870..01c5bfc 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_cg_git-cookbook.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_cg_git-cookbook.adoc
@@ -8,7 +8,7 @@
-This section describes the commands often used while working with git. In addition to these basic commands, please make sure you have read:
+This appendix describes the commands often used while working with git. In addition to these basic commands, please make sure you have read:
* xref:cg.adoc#_cg_building-isis[building Apache Isis]
* xref:cg.adoc#_cg_git-policy[Git policy]
http://git-wip-us.apache.org/repos/asf/isis/blob/4411b51d/adocs/documentation/src/main/asciidoc/guides/_cg_ide-templates.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_cg_ide-templates.adoc b/adocs/documentation/src/main/asciidoc/guides/_cg_ide-templates.adoc
index e425dae..422308d 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_cg_ide-templates.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_cg_ide-templates.adoc
@@ -11,7 +11,7 @@ We provide IDE templates (for IntelliJ and Eclipse) for writing Apache Isis doma
== Download
-The following table lists the templates to download
+The following table lists the templates available to download:
[cols="1a,1a,1a,1a", options="header"]
|===
@@ -39,6 +39,11 @@ The following table lists the templates to download
|link:./resources/templates/jmock2-templates-idea.xml[Download]
|link:./resources/templates/jmock2-templates.xml[Download]
+|Asciidoc
+|ad
+|link:./resources/templates/asciidoc-templates-idea.xml[Download]
+|(none )
+
|===
@@ -50,11 +55,13 @@ The most commonly used Apache Isis domain objects templates are also listed on t
=== IntelliJ
-To install in IntelliJ, copy to the relevant `config/templates` directory, eg:
+To install in IntelliJ (Community edition 14), copy to the relevant `config/templates` directory, eg:
+
+* Windows `<User home>\.IdeaIC14\config\templates`
+* Linux `~/.IdeaIC14/config/templates`
+* Mac OS `~/Library/Preferences/IdeaIC14/templates`
-* Windows `<User home>\.IntelliJIdea14\config\templates`
-* Linux `~/.IntelliJIdea14/config/templates`
-* Mac OS `~/Library/Preferences/IntelliJIdea14/templates`
+If using the Ultimate edition, the directory is `.IntelliJIdea14` rather than `IdeaIC14`.
=== Eclipse
http://git-wip-us.apache.org/repos/asf/isis/blob/4411b51d/adocs/documentation/src/main/asciidoc/guides/cg.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/cg.adoc b/adocs/documentation/src/main/asciidoc/guides/cg.adoc
index e36e3df..43bcc84 100644
--- a/adocs/documentation/src/main/asciidoc/guides/cg.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/cg.adoc
@@ -34,3 +34,4 @@ include::_cg_asciidoc.adoc[leveloffset=+1]
include::_cg_committers.adoc[leveloffset=+1]
include::_cg_git-cookbook.adoc[leveloffset=+1]
+include::_cg_asciidoc-templates.adoc[leveloffset=+1]
http://git-wip-us.apache.org/repos/asf/isis/blob/4411b51d/adocs/documentation/src/main/asciidoc/resources/templates/asciidoc-templates-idea.xml
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/resources/templates/asciidoc-templates-idea.xml b/adocs/documentation/src/main/asciidoc/resources/templates/asciidoc-templates-idea.xml
new file mode 100644
index 0000000..6e9c8d3
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/resources/templates/asciidoc-templates-idea.xml
@@ -0,0 +1,365 @@
+<templateSet group="AsciiDoc">
+ <template name="adtbl3" value=".$tableCaption$ [cols="1a,1a,1a", options="header"] |=== | $cell1header$ | $cell2header$ | $cell3header$ | $cell1row1$ | $cell2row1$ | $cell3row1$ | | | |===" description="Table with three columns" toReformat="false" toShortenFQNames="true">
+ <variable name="tableCaption" expression="" defaultValue=""Table caption"" alwaysStopAt="true" />
+ <variable name="cell1header" expression="" defaultValue=""Header Cell 1"" alwaysStopAt="true" />
+ <variable name="cell2header" expression="" defaultValue=""Header Cell 2"" alwaysStopAt="true" />
+ <variable name="cell3header" expression="" defaultValue="" alwaysStopAt="true" />
+ <variable name="cell1row1" expression="" defaultValue=""Row 1 Cell 1"" alwaysStopAt="true" />
+ <variable name="cell2row1" expression="" defaultValue=""Row 1 Cell 2"" alwaysStopAt="true" />
+ <variable name="cell3row1" expression="" defaultValue="" alwaysStopAt="true" />
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adadmtip" value="[TIP] ==== $END$ ==== " description="Tip admonition" toReformat="false" toShortenFQNames="true">
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adadmnote" value="[NOTE] ==== $END$ ==== " description="Note admonition" toReformat="false" toShortenFQNames="true">
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adadmimportant" value="[IMPORTANT] ==== $END$ ==== " description="Important admonition" toReformat="false" toShortenFQNames="true">
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adadmwarning" value="[WARNING] ==== $END$ ==== " description="Warning admonition" toReformat="false" toShortenFQNames="true">
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adimgfile" value="image::{_imagesdir}$INCLUDED$/$FILE$.png[width="$END$$WIDTH$px",link="{_imagesdir}$INCLUDED$/$FILE$.png"]" description="Image link to file" toReformat="false" toShortenFQNames="true">
+ <variable name="INCLUDED" expression="" defaultValue="" alwaysStopAt="true" />
+ <variable name="FILE" expression="" defaultValue="" alwaysStopAt="true" />
+ <variable name="WIDTH" expression="" defaultValue="" alwaysStopAt="true" />
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adimgurl" value="image::$URL$[width="$END$$WIDTH$px",link="$URL$"]" description="Image link to URL" toReformat="false" toShortenFQNames="true">
+ <variable name="URL" expression="" defaultValue="" alwaysStopAt="true" />
+ <variable name="WIDTH" expression="" defaultValue="" alwaysStopAt="true" />
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adlink" value="link:$URL$[$TEXT$]" description="Link to URL" toReformat="false" toShortenFQNames="true">
+ <variable name="URL" expression="" defaultValue="" alwaysStopAt="true" />
+ <variable name="TEXT" expression="" defaultValue="" alwaysStopAt="true" />
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adsrcjava" value="[source,java] ---- $END$ ---- " description="Source code (java)" toReformat="false" toShortenFQNames="true">
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adsrcxml" value="[source,xml] ---- $END$ ---- " description="Source code (XML)" toReformat="false" toShortenFQNames="true">
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adsrcother" value="[source,$LANG$] ---- $END$ ---- " description="Source code (None)" toReformat="false" toShortenFQNames="true">
+ <variable name="LANG" expression="" defaultValue="" alwaysStopAt="true" />
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adinclude" value="include::$INCLUDED$.adoc[leveloffset=+1] " description="Include" toReformat="false" toShortenFQNames="true">
+ <variable name="INCLUDED" expression="" defaultValue="" alwaysStopAt="true" />
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adlinkaddons" value="(non-ASF) link:http://isisaddons.org[Isis Addons]" description="Link to Isis Addons" toReformat="false" toShortenFQNames="true">
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adlinkaddonsmodule" value="(non-ASF) http://github.com/isisaddons/isis-module-$MODULE$[Isis addons' $MODULE$] module" description="Link to specific Isis Addons module" toReformat="false" toShortenFQNames="true">
+ <variable name="MODULE" expression="" defaultValue="" alwaysStopAt="true" />
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adtodo" value="NOTE: TODO" description="TODO note" toReformat="false" toShortenFQNames="true">
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adfootnote" value=".footnote:[$END$]" description="Footnote" toReformat="false" toShortenFQNames="true">
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adlinkaddonswicket" value="(non-ASF) http://github.com/isisaddons/isis-wicket-$WICKET$[Isis addons' $WICKET$ ] wicket extension" description="Link to specific Isis Addons wicket cpt" toReformat="false" toShortenFQNames="true">
+ <variable name="WICKET" expression="" defaultValue="" alwaysStopAt="true" />
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adlinkaddonsapp" value="(non-ASF) http://github.com/isisaddons/isis-app-$APP$[Isis addons' $APP$]" description="Link to specific Isis Addons app" toReformat="false" toShortenFQNames="true" deactivated="true">
+ <variable name="APP" expression="" defaultValue="" alwaysStopAt="true" />
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adugsimpleapp" value="xref:ug.adoc#_ug_getting-started_simpleapp-archetype[SimpleApp archetype]" description="xref to the user guide simpleapp archetype" toReformat="false" toShortenFQNames="true">
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adyoutube" value="video::$REFERENCE$[youtube,width="$WIDTH$px",height="$END$$HEIGHT$px"]" description="Link to youtube" toReformat="false" toShortenFQNames="true">
+ <variable name="REFERENCE" expression="" defaultValue="" alwaysStopAt="true" />
+ <variable name="WIDTH" expression="" defaultValue="" alwaysStopAt="true" />
+ <variable name="HEIGHT" expression="" defaultValue="" alwaysStopAt="true" />
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adimgfilec" value=".$CAPTION$ image::{_imagesdir}$INCLUDED$/$FILE$.png[width="$END$$WIDTH$px",link="{_imagesdir}$INCLUDED$/$FILE$.png"]" description="Image link to file with caption" toReformat="false" toShortenFQNames="true">
+ <variable name="CAPTION" expression="" defaultValue="" alwaysStopAt="true" />
+ <variable name="INCLUDED" expression="" defaultValue="" alwaysStopAt="true" />
+ <variable name="FILE" expression="" defaultValue="" alwaysStopAt="true" />
+ <variable name="WIDTH" expression="" defaultValue="" alwaysStopAt="true" />
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adimgurlc" value=".$CAPTION$ image::$URL$[width="$END$$WIDTH$px",link="$URL$"]" description="Image link to URL with caption" toReformat="false" toShortenFQNames="true">
+ <variable name="CAPTION" expression="" defaultValue="" alwaysStopAt="true" />
+ <variable name="URL" expression="" defaultValue="" alwaysStopAt="true" />
+ <variable name="WIDTH" expression="" defaultValue="" alwaysStopAt="true" />
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adsrcjavac" value="[source,java] .$CAPTION$ ---- $END$ ---- " description="Source code (java) with caption" toReformat="false" toShortenFQNames="true">
+ <variable name="CAPTION" expression="" defaultValue="" alwaysStopAt="true" />
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adsrcotherc" value="[source,$LANG$] ---- $END$ ---- " description="Source code (None) with caption" toReformat="false" toShortenFQNames="true">
+ <variable name="LANG" expression="" defaultValue="" alwaysStopAt="true" />
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adsrcxmlc" value="[source,xml] .$CAPTION$ ---- $END$ ---- " description="Source code (XML) with caption" toReformat="false" toShortenFQNames="true">
+ <variable name="CAPTION" expression="" defaultValue="" alwaysStopAt="true" />
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adsrcjavascript" value="[source,javascript] ---- $END$ ---- " description="Source code (Javascript)" toReformat="false" toShortenFQNames="true">
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adsrcjavascriptc" value="[source,javascript] .$CAPTION$ ---- $END$ ---- " description="Source code (javascript) with caption" toReformat="false" toShortenFQNames="true">
+ <variable name="CAPTION" expression="" defaultValue="" alwaysStopAt="true" />
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adrgmp" value="xref:rg.adoc#_rg_methods_prefixes_manpage-$methodName$[`$methodName$...()`]" description="x-ref to ref guide manpage for method prefix" toReformat="false" toShortenFQNames="true">
+ <variable name="methodName" expression="" defaultValue="" alwaysStopAt="true" />
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adug1" value="xref:ug.adoc#$chapter$[$DisplayText$]" description="x-ref to user guide level 1 (chapter)" toReformat="false" toShortenFQNames="true">
+ <variable name="chapter" expression="" defaultValue="_ug_" alwaysStopAt="true" />
+ <variable name="DisplayText" expression="" defaultValue="" alwaysStopAt="true" />
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adrgsa" value="xref:rg.adoc#_rg_services-api_manpage-$ServiceType$[`$ServiceType$`]" description="x-ref to ref guide manpage for service api" toReformat="false" toShortenFQNames="true">
+ <variable name="ServiceType" expression="" defaultValue="" alwaysStopAt="true" />
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adrgmr" value="xref:rg.adoc#_rg_methods_reserved_manpage-$methodName$[`$methodName$()`]" description="x-ref to ref guide manpage for reserved method" toReformat="false" toShortenFQNames="true">
+ <variable name="methodName" expression="" defaultValue="" alwaysStopAt="true" />
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adrgss" value="xref:rg.adoc#_rg_services-spi_manpage-$ServiceType$[`$ServiceType$`]" description="x-ref to ref guide manpage for service spi" toReformat="false" toShortenFQNames="true">
+ <variable name="ServiceType" expression="" defaultValue="" alwaysStopAt="true" />
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adrgcv" value="xref:rg.adoc#_rg_classes_value-types_manpage-$Type$[`$Type$`]" description="x-ref to ref guide manpage for class value type" toReformat="false" toShortenFQNames="true">
+ <variable name="Type" expression="" defaultValue="" alwaysStopAt="true" />
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adrgcs" value="xref:rg.adoc#_rg_classes_super_manpage-$Type$[`$Type$`]" description="x-ref to ref guide manpage for class superclass" toReformat="false" toShortenFQNames="true">
+ <variable name="Type" expression="" defaultValue="" alwaysStopAt="true" />
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adrgcu" value="xref:rg.adoc#_rg_classes_utility_manpage-$Type$[`$Type$`]" description="x-ref to ref guide manpage for class utility" toReformat="false" toShortenFQNames="true">
+ <variable name="Type" expression="" defaultValue="" alwaysStopAt="true" />
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adanchany" value="= anchor:$prefix$[]" description="anchor to any" toReformat="false" toShortenFQNames="true">
+ <variable name="prefix" expression="" defaultValue="chapter" alwaysStopAt="true" />
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adrgna" value="xref:rg.adoc#_rg_annotations_manpage-$Type$[`@$Type$`]" description="x-ref to ref guide manpage for annotation" toReformat="false" toShortenFQNames="true">
+ <variable name="Type" expression="" defaultValue="" alwaysStopAt="true" />
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adug2" value="xref:ug.adoc#$chapter$_$section$[$DisplayText$]" description="x-ref to user guide level 2 (chapter section)" toReformat="false" toShortenFQNames="true">
+ <variable name="chapter" expression="" defaultValue="_ug_" alwaysStopAt="true" />
+ <variable name="section" expression="" defaultValue="" alwaysStopAt="true" />
+ <variable name="DisplayText" expression="" defaultValue="" alwaysStopAt="true" />
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adug3" value="xref:ug.adoc#$chapter$_$section$_$subsection$[$DisplayText$]" description="x-ref to user guide level 3 (chapter section subsection)" toReformat="false" toShortenFQNames="true">
+ <variable name="chapter" expression="" defaultValue="_ug_" alwaysStopAt="true" />
+ <variable name="section" expression="" defaultValue="" alwaysStopAt="true" />
+ <variable name="subsection" expression="" defaultValue="" alwaysStopAt="true" />
+ <variable name="DisplayText" expression="" defaultValue="" alwaysStopAt="true" />
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adxrefany" value="xref:$chapter$[$DisplayText$]" description="x-ref to any" toReformat="false" toShortenFQNames="true">
+ <variable name="chapter" expression="" defaultValue="" alwaysStopAt="true" />
+ <variable name="DisplayText" expression="" defaultValue="" alwaysStopAt="true" />
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adrgnt" value="xref:rg.adoc#_rg_annotations_manpage-$Type$_$attribute$[`@$Type$#$attribute$()`]" description="x-ref to ref guide manpage for annotation's attribute" toReformat="false" toShortenFQNames="true">
+ <variable name="Type" expression="" defaultValue="" alwaysStopAt="true" />
+ <variable name="attribute" expression="" defaultValue="" alwaysStopAt="true" />
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adugvw" value="xref:ug.adoc#_ug_wicket-viewer[Wicket viewer]" description="x-ref to user guide wicket viewer" toReformat="false" toShortenFQNames="true">
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adugvro" value="xref:ug.adoc#_ug_restfulobjects-viewer[RestfulObjects viewer]" description="x-ref to user guide restfulobjects viewer" toReformat="false" toShortenFQNames="true">
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adrgntx" value="xref:rg.adoc#_rg_annotations_manpage-$Type$_$attribute$[$linkText$]" description="x-ref to ref guide manpage for annotation's attribute, overriding the link text" toReformat="false" toShortenFQNames="true">
+ <variable name="Type" expression="" defaultValue="" alwaysStopAt="true" />
+ <variable name="attribute" expression="" defaultValue="" alwaysStopAt="true" />
+ <variable name="linkText" expression="" defaultValue="" alwaysStopAt="true" />
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adwip" value="NOTE: WIP - " description="WIP note" toReformat="false" toShortenFQNames="true">
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adyoutubec" value=".$CAPTION$ video::$REFERENCE$[youtube,width="$WIDTH$px",height="$END$$HEIGHT$px"]" description="Link to youtube with caption" toReformat="false" toShortenFQNames="true">
+ <variable name="CAPTION" expression="" defaultValue="" alwaysStopAt="true" />
+ <variable name="REFERENCE" expression="" defaultValue="" alwaysStopAt="true" />
+ <variable name="WIDTH" expression="" defaultValue="" alwaysStopAt="true" />
+ <variable name="HEIGHT" expression="" defaultValue="" alwaysStopAt="true" />
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adrg1" value="xref:rg.adoc#$chapter$[$DisplayText$]" description="x-ref to ref guide level 1 (chapter)" toReformat="false" toShortenFQNames="true">
+ <variable name="chapter" expression="" defaultValue="_rg_" alwaysStopAt="true" />
+ <variable name="DisplayText" expression="" defaultValue="" alwaysStopAt="true" />
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adrg2" value="xref:rg.adoc#$chapter$_$section$[$DisplayText$]" description="x-ref to ref guide level 2 (chapter section)" toReformat="false" toShortenFQNames="true">
+ <variable name="chapter" expression="" defaultValue="_rg_" alwaysStopAt="true" />
+ <variable name="section" expression="" defaultValue="" alwaysStopAt="true" />
+ <variable name="DisplayText" expression="" defaultValue="" alwaysStopAt="true" />
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adrg3" value="xref:rg.adoc#$chapter$_$section$_$subsection$[$DisplayText$]" description="x-ref to ref guide level 3 (chapter section subsection)" toReformat="false" toShortenFQNames="true">
+ <variable name="chapter" expression="" defaultValue="_rg_" alwaysStopAt="true" />
+ <variable name="section" expression="" defaultValue="" alwaysStopAt="true" />
+ <variable name="subsection" expression="" defaultValue="" alwaysStopAt="true" />
+ <variable name="DisplayText" expression="" defaultValue="" alwaysStopAt="true" />
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adrgcfg" value="xref:rg.adoc#_rg_runtime_configuring-core[configuration property]" description="x-ref to ref guide configuration properties section" toReformat="false" toShortenFQNames="true">
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adcg" value="xref:cg.adoc#_cg[Contributors' Guide]" description="xref to contributors guide" toReformat="false" toShortenFQNames="true">
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adrg" value="xref:rg.adoc#_rg[Reference Guide]" description="xref to reference guide" toReformat="false" toShortenFQNames="true">
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adug" value="xref:ug.adoc#_ug[Users' Guide]" description="xref to user' guide" toReformat="false" toShortenFQNames="true">
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adai" value="Apache Isis " description="Apache Isis" toReformat="false" toShortenFQNames="true">
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adcg1" value="xref:cg.adoc#_cg_$chapter$[$DisplayText$]" description="x-ref to contributors guide level 1 (chapter)" toReformat="false" toShortenFQNames="true">
+ <variable name="chapter" expression="" defaultValue="" alwaysStopAt="true" />
+ <variable name="DisplayText" expression="" defaultValue="" alwaysStopAt="true" />
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adcg2" value="xref:cg.adoc#_cg_$chapter$_$section$[$DisplayText$]" description="x-ref to contributors guide level 2 (chapter section)" toReformat="false" toShortenFQNames="true">
+ <variable name="chapter" expression="" defaultValue="" alwaysStopAt="true" />
+ <variable name="section" expression="" defaultValue="" alwaysStopAt="true" />
+ <variable name="DisplayText" expression="" defaultValue="" alwaysStopAt="true" />
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adtg1" value="xref:tg.adoc#$chapter$[$DisplayText$]" description="x-ref to tutorials level 1 (chapter)" toReformat="false" toShortenFQNames="true">
+ <variable name="chapter" expression="" defaultValue="_tg_" alwaysStopAt="true" />
+ <variable name="DisplayText" expression="" defaultValue="" alwaysStopAt="true" />
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+</templateSet>
\ No newline at end of file
[2/4] isis git commit: ISIS-1082: minor updates to contributors guide.
Posted by da...@apache.org.
ISIS-1082: minor updates to contributors guide.
Project: http://git-wip-us.apache.org/repos/asf/isis/repo
Commit: http://git-wip-us.apache.org/repos/asf/isis/commit/a197924b
Tree: http://git-wip-us.apache.org/repos/asf/isis/tree/a197924b
Diff: http://git-wip-us.apache.org/repos/asf/isis/diff/a197924b
Branch: refs/heads/master
Commit: a197924b02ad2186ceced45b60bfd78ecd85b73e
Parents: e927810
Author: Dan Haywood <da...@haywood-associates.co.uk>
Authored: Tue Aug 4 07:53:52 2015 +0100
Committer: Dan Haywood <da...@haywood-associates.co.uk>
Committed: Tue Aug 4 07:53:52 2015 +0100
----------------------------------------------------------------------
.../documentation/src/main/asciidoc/guides/_cg_committers.adoc | 2 +-
.../main/asciidoc/guides/_cg_committers_release-process.adoc | 6 +++---
2 files changed, 4 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/isis/blob/a197924b/adocs/documentation/src/main/asciidoc/guides/_cg_committers.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_cg_committers.adoc b/adocs/documentation/src/main/asciidoc/guides/_cg_committers.adoc
index 1e08b24..0b266ba 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_cg_committers.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_cg_committers.adoc
@@ -1,5 +1,5 @@
[[_cg_committers]]
-= Committers
+= Committers' Guide
:notice: licensed to the apache software foundation (asf) under one or more contributor license agreements. see the notice file distributed with this work for additional information regarding copyright ownership. the asf licenses this file to you under the apache license, version 2.0 (the "license"); you may not use this file except in compliance with the license. you may obtain a copy of the license at. http://www.apache.org/licenses/license-2.0 . unless required by applicable law or agreed to in writing, software distributed under the license is distributed on an "as is" basis, without warranties or conditions of any kind, either express or implied. see the license for the specific language governing permissions and limitations under the license.
:_basedir: ../
:_imagesdir: images/
http://git-wip-us.apache.org/repos/asf/isis/blob/a197924b/adocs/documentation/src/main/asciidoc/guides/_cg_committers_release-process.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_cg_committers_release-process.adoc b/adocs/documentation/src/main/asciidoc/guides/_cg_committers_release-process.adoc
index c110b7f..463bfe9 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_cg_committers_release-process.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_cg_committers_release-process.adoc
@@ -110,7 +110,7 @@ To run the RAT tool, use:
[source,bash]
----
-mvn org.apache.rat:apache-rat-plugin:check -D rat.numUnapprovedLicenses=50 -o
+mvn org.apache.rat:apache-rat-plugin:check -D rat.numUnapprovedLicenses=50 -o && \
for a in `/bin/find . -name rat.txt -print`; do grep '!???' $a; done
----
@@ -133,7 +133,7 @@ groovy ../scripts/addmissinglicenses.groovy -x
[source,bash]
----
-mvn org.apache.rat:apache-rat-plugin:check -D rat.numUnapprovedLicenses=0 -o
+mvn org.apache.rat:apache-rat-plugin:check -D rat.numUnapprovedLicenses=0 -o && \
for a in `find . -name rat.txt -print`; do grep '!???' $a; done
----
@@ -148,7 +148,7 @@ To capture the missing license information, use:
[source,bash]
----
-mvn license:download-licenses
+mvn license:download-licenses && \
groovy ../scripts/checkmissinglicenses.groovy
----
[3/4] isis git commit: ISIS-1082: minor updates to docs describing
how to generate docs.
Posted by da...@apache.org.
ISIS-1082: minor updates to docs describing how to generate docs.
Project: http://git-wip-us.apache.org/repos/asf/isis/repo
Commit: http://git-wip-us.apache.org/repos/asf/isis/commit/37e42b2a
Tree: http://git-wip-us.apache.org/repos/asf/isis/tree/37e42b2a
Diff: http://git-wip-us.apache.org/repos/asf/isis/diff/37e42b2a
Branch: refs/heads/master
Commit: 37e42b2a25690687a05e96b4cdbf8bae879fc4ed
Parents: a197924
Author: Dan Haywood <da...@haywood-associates.co.uk>
Authored: Tue Aug 4 08:12:57 2015 +0100
Committer: Dan Haywood <da...@haywood-associates.co.uk>
Committed: Tue Aug 4 08:12:57 2015 +0100
----------------------------------------------------------------------
adocs/documentation/monitor.sh | 2 +-
.../src/main/asciidoc/guides/_cg_asciidoc.adoc | 32 +++++++-------------
2 files changed, 12 insertions(+), 22 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/isis/blob/37e42b2a/adocs/documentation/monitor.sh
----------------------------------------------------------------------
diff --git a/adocs/documentation/monitor.sh b/adocs/documentation/monitor.sh
index bf5ff7b..2a448c1 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
+mvn clean compile && ruby monitor.rb -b
http://git-wip-us.apache.org/repos/asf/isis/blob/37e42b2a/adocs/documentation/src/main/asciidoc/guides/_cg_asciidoc.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_cg_asciidoc.adoc b/adocs/documentation/src/main/asciidoc/guides/_cg_asciidoc.adoc
index ed4de95..bc9015d 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_cg_asciidoc.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_cg_asciidoc.adoc
@@ -76,7 +76,9 @@ You could then use a web server such as Python's SimpleHTTPServer to preview (so
== Instant Rebuild (using Ruby)
-The ruby script, `monitor.rb` emulates the `mvn site` command, regenerating any changed Asciidoctor files to the relevant `target/site` directory. If any included files are changed then it rebuilds the parent (per the above naming convention).
+The ruby script, `monitor.rb` emulates the `mvn compile` command, regenerating any changed Asciidoctor files to the relevant `target/site` directory. Moreover if any included files are changed then it rebuilds the parent (per the above naming convention).
+
+=== One-time setup
To setup:
@@ -89,7 +91,7 @@ To setup:
We use Ruby 2.0 rather than 2.1 because the wdm gem (required to monitor the filesystem if running on Windows) is not currently compatible with Ruby 2.1.
====
-To install:
+To download the required Ruby dependencies, use:
[source,bash]
----
@@ -97,23 +99,18 @@ gem install bundler
bundle install
----
+=== Instant Rebuild
+
To run, we typically just use:
[source,bash]
----
-ruby monitor.rb
+sh monitor.sh
----
-This will start monitoring all files under `src/main/asciidoc`, and start up a web server on port 4000 so you can review results. If any `.adoc` changes, then the appropriate HTML will be regenerated. And, if any new assets (CSS, images etc) are added, they will be copied across.
-
-It often makes sense to combine this with `mvn`:
-
-[source,bash]
-----
-mvn clean install && ruby monitor.rb
-----
+This script simply runs `mvn clean compile && ruby monitor.rb -b`. The `mvn` command performs a clean rebuild of the site, and then the ruby script monitors for any further changes under `src/main/asciidoc`.
-This directory contains a tiny script, `r.sh`, that executes exactly the above line.
+The script also starts up a web server on port 4000 so you can review results. If any `.adoc` changes, then the appropriate HTML will be regenerated. And, if any new assets (CSS, images etc) are added, they will be copied across. The `-b` flag passed through means that the script also starts a web browser pointing at the newly generated docs.
The `monitor.rb` script has a couple of other options, use `-h` flag for usage:
@@ -133,8 +130,6 @@ usage: monitor.rb [options]
----
-
-
== Publish procedure
Only Apache Isis committers can publish to link:http://isis.apache.org[isis.apache.org]. We've decided to include these procedures here here (rather than put them in the xref:cg.adoc#_cg_committers[committers' section] of this guide, just to keep things together.
@@ -188,15 +183,10 @@ To copy and to also commit the generated documents to the `isis-site.git` repo ,
[source,bash]
----
-mvn clean install
+sh publish.sh "ISIS-nnnn: a custom commit message"
----
-This will use a standard commit message (in the `isis-site.git` repo). If you want to specify a custom message, use:
-
-[source,bash]
-----
-mvn clean install -Dmessage="ISIS-nnnn: a custom commit message"
-----
+Behind the scenes this just calls `mvn clean install -Dmessage=...`.
Pushing the commits (in the `isis-site.git` directory, of course) will publishing the changes: