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 2016/04/05 13:38:49 UTC
[2/4] isis git commit: ISIS-1335: replacing use of video:xxx in
guides with links to youtube (because former can't be rendered in PDF
format).
ISIS-1335: replacing use of video:xxx in guides with links to youtube (because former can't be rendered in PDF format).
Also, minor improvement to asciidoc pom.xml: use mvn package -Dskip.pdf to just rebuild html without doing a full clean; can then selectively add/commit individual pages of website more easily.
Project: http://git-wip-us.apache.org/repos/asf/isis/repo
Commit: http://git-wip-us.apache.org/repos/asf/isis/commit/d7797be1
Tree: http://git-wip-us.apache.org/repos/asf/isis/tree/d7797be1
Diff: http://git-wip-us.apache.org/repos/asf/isis/diff/d7797be1
Branch: refs/heads/master
Commit: d7797be1b634fe9d0e5b6aae3ee6e811260723c6
Parents: 5b9fa77
Author: Dan Haywood <da...@haywood-associates.co.uk>
Authored: Sun Apr 3 16:01:51 2016 +0100
Committer: Dan Haywood <da...@haywood-associates.co.uk>
Committed: Sun Apr 3 16:01:51 2016 +0100
----------------------------------------------------------------------
adocs/documentation/pom.xml | 37 +++++++++++++++++---
.../asciidoc/guides/_dg_asciidoc-templates.adoc | 2 +-
.../main/asciidoc/guides/_dg_ide_eclipse.adoc | 4 +--
.../guides/_rgcms_classes_utility_Enums.adoc | 13 +++++++
.../guides/_rgsvc_api_CommandContext.adoc | 3 +-
.../guides/_rgsvc_spi_CommandService.adoc | 5 +--
...ncepts_philosophy_naked-objects-pattern.adoc | 4 +--
.../_ugfun_object-layout_dynamic_xml.adoc | 3 +-
.../asciidoc/guides/_ugvro_hints-and-tips.adoc | 3 +-
.../main/asciidoc/guides/_ugvro_ro-spec.adoc | 5 ++-
.../_ugvro_simplified-representations.adoc | 3 +-
11 files changed, 57 insertions(+), 25 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/isis/blob/d7797be1/adocs/documentation/pom.xml
----------------------------------------------------------------------
diff --git a/adocs/documentation/pom.xml b/adocs/documentation/pom.xml
index bd46ce2..216981c 100644
--- a/adocs/documentation/pom.xml
+++ b/adocs/documentation/pom.xml
@@ -243,10 +243,10 @@
</profile>
<profile>
- <id>copy</id>
+ <id>delete</id>
<activation>
<property>
- <name>!skip.copy</name>
+ <name>!skip.delete</name>
</property>
</activation>
<build>
@@ -256,8 +256,8 @@
<version>1.8</version>
<executions>
<execution>
- <id>package</id>
- <phase>package</phase>
+ <id>clean</id>
+ <phase>clean</phase>
<configuration>
<target>
<echo message=""/>
@@ -267,7 +267,36 @@
<delete includeemptydirs="true">
<fileset dir="${isis-site.dir}" includes="**/*"/>
</delete>
+ </target>
+ </configuration>
+ <goals>
+ <goal>run</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+ </profile>
+ <profile>
+ <id>copy</id>
+ <activation>
+ <property>
+ <name>!skip.copy</name>
+ </property>
+ </activation>
+ <build>
+ <plugins>
+ <plugin>
+ <artifactId>maven-antrun-plugin</artifactId>
+ <version>1.8</version>
+ <executions>
+ <execution>
+ <id>package</id>
+ <phase>package</phase>
+ <configuration>
+ <target>
<echo message=""/>
<echo message=""/>
<echo message="copying from ${redirects.dir} to ${isis-site.dir}"/>
http://git-wip-us.apache.org/repos/asf/isis/blob/d7797be1/adocs/documentation/src/main/asciidoc/guides/_dg_asciidoc-templates.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_dg_asciidoc-templates.adoc b/adocs/documentation/src/main/asciidoc/guides/_dg_asciidoc-templates.adoc
index 485b390..652c94a 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_dg_asciidoc-templates.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_dg_asciidoc-templates.adoc
@@ -596,7 +596,7 @@ embeds image from specified URL, where:
== YouTube (screencasts)
-Embedded youtube screencasts
+Embedded youtube screencasts. (Don't use these in guides, as they cannot be rendered as PDF).
[cols="1,4a,2a", options="header"]
|===
http://git-wip-us.apache.org/repos/asf/isis/blob/d7797be1/adocs/documentation/src/main/asciidoc/guides/_dg_ide_eclipse.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_dg_ide_eclipse.adoc b/adocs/documentation/src/main/asciidoc/guides/_dg_ide_eclipse.adoc
index 6cf8e87..7a20b2f 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_dg_ide_eclipse.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_dg_ide_eclipse.adoc
@@ -26,9 +26,9 @@ This plugin needs to be configured for each of your domain modules (usually just
== Screencast
-The following screencast shows how to import an Apache Isis maven-based application into Eclipse and configure to use with the JDO Objectstore
+This link:https://www.youtube.com/watch?v=RgcYfjQ8yJA[screencast] shows how to import an Apache Isis maven-based
+application into Eclipse and configure to use with the JDO Objectstore.
-video::RgcYfjQ8yJA[youtube,width="640px",height="480px"]
http://git-wip-us.apache.org/repos/asf/isis/blob/d7797be1/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_utility_Enums.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_utility_Enums.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_utility_Enums.adoc
index fa688ae..3f43c6b 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_utility_Enums.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_utility_Enums.adoc
@@ -6,3 +6,16 @@
NOTE: TODO
+
+[source,java]
+----
+public final class Enums {
+ public static String getFriendlyNameOf(Enum<?> anEnum) { ... }
+ public static String getFriendlyNameOf(String anEnumName) { ... }
+ public static String getEnumNameFromFriendly(String anEnumFriendlyName) { ... }
+ public static String enumToHttpHeader(final Enum<?> anEnum) { ... }
+ public static String enumNameToHttpHeader(final String name) { ... }
+ public static String enumToCamelCase(final Enum<?> anEnum) { ... }
+}
+----
+
http://git-wip-us.apache.org/repos/asf/isis/blob/d7797be1/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_CommandContext.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_CommandContext.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_CommandContext.adoc
index 138221d..23a5a41 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_CommandContext.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_api_CommandContext.adoc
@@ -26,9 +26,8 @@ Assuming that the `CommandService` supports persistent `Command`s, the associate
== Screencast
-The screencast provides a run-through of the command (profiling) service, auditing service, publishing service. It also shows how commands can be run in the background either explicitly by scheduling through the background service or implicitly by way of a framework annotation.
+The link:https://www.youtube.com/watch?v=tqXUZkPB3EI[screencast] provides a run-through of the command (profiling) service, auditing service, publishing service. It also shows how commands can be run in the background either explicitly by scheduling through the background service or implicitly by way of a framework annotation.
-video::tqXUZkPB3EI[youtube,width="640px",height="360px"]
[NOTE]
====
http://git-wip-us.apache.org/repos/asf/isis/blob/d7797be1/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_CommandService.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_CommandService.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_CommandService.adoc
index 4aa78d9..1777d4d 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_CommandService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgsvc_spi_CommandService.adoc
@@ -18,12 +18,9 @@ Persistent `Command`s support several use cases:
-The screencast below provides a run-through of the command (profiling) service, auditing service, publishing service. It also shows how commands can be run in the background either explicitly by scheduling through the background service or implicitly by way of a framework annotation.
+This link:https://www.youtube.com/watch?v=tqXUZkPB3EI[screencast] below provides a run-through of the command (profiling) service, auditing service, publishing service. It also shows how commands can be run in the background either explicitly by scheduling through the background service or implicitly by way of a framework annotation.
-
-video::tqXUZkPB3EI[youtube,width="560px",height="315px"]
-
[NOTE]
====
Note that this screencast shows an earlier version of the xref:ugvw.adoc#[Wicket viewer] UI (specifically, pre 1.8.0).
http://git-wip-us.apache.org/repos/asf/isis/blob/d7797be1/adocs/documentation/src/main/asciidoc/guides/_ugfun_core-concepts_philosophy_naked-objects-pattern.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ugfun_core-concepts_philosophy_naked-objects-pattern.adoc b/adocs/documentation/src/main/asciidoc/guides/_ugfun_core-concepts_philosophy_naked-objects-pattern.adoc
index fbe13f1..1c1b63d 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ugfun_core-concepts_philosophy_naked-objects-pattern.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ugfun_core-concepts_philosophy_naked-objects-pattern.adoc
@@ -47,10 +47,8 @@ include::_ugfun_core-concepts_philosophy_naked-objects-pattern_object-interface-
== What this means in practice
-The screencast below shows what all of this means in practice, showing the relationship between a running app and the actual code underneath.
+This link:https://www.youtube.com/watch?v=ludOLyi6VyY[screencast] shows what all of this means in practice, showing the relationship between a running app and the actual code underneath.
-.How Apache Isis builds a webapp from the underlying domain object model…
-video::ludOLyi6VyY[youtube,width="640px",height="472px"]
[NOTE]
====
http://git-wip-us.apache.org/repos/asf/isis/blob/d7797be1/adocs/documentation/src/main/asciidoc/guides/_ugfun_object-layout_dynamic_xml.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ugfun_object-layout_dynamic_xml.adoc b/adocs/documentation/src/main/asciidoc/guides/_ugfun_object-layout_dynamic_xml.adoc
index df080c2..9a97f41 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ugfun_object-layout_dynamic_xml.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ugfun_object-layout_dynamic_xml.adoc
@@ -33,9 +33,8 @@ More information about these classes can be found in xref:rgcms.adoc#_rgcms_clas
== Screencast
-The following screencast describes the feature:
+This link:https://www.youtube.com/watch?v=MxewC5Pve5k[screencast] describes the feature.
-video::MxewC5Pve5k[youtube,width="800px",height="534px"]
http://git-wip-us.apache.org/repos/asf/isis/blob/d7797be1/adocs/documentation/src/main/asciidoc/guides/_ugvro_hints-and-tips.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ugvro_hints-and-tips.adoc b/adocs/documentation/src/main/asciidoc/guides/_ugvro_hints-and-tips.adoc
index 14498bc..4436e52 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ugvro_hints-and-tips.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ugvro_hints-and-tips.adoc
@@ -15,9 +15,8 @@ This section provides a few hints-and-tips to help you on your way.
== Using Chrome Tools
-The screencast below shows how to explore the Restful API using Chrome plugins/extensions, and how we use them to write end-2-end (TCK) tests for the Restful Objects viewer.
+This link:https://www.youtube.com/watch?v=_-TOvVYWCHc[screencast] shows how to explore the Restful API using Chrome plugins/extensions, and how we use them to write end-2-end (TCK) tests for the Restful Objects viewer.
-video::_-TOvVYWCHc[youtube,width="840px",height="472px"]
http://git-wip-us.apache.org/repos/asf/isis/blob/d7797be1/adocs/documentation/src/main/asciidoc/guides/_ugvro_ro-spec.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ugvro_ro-spec.adoc b/adocs/documentation/src/main/asciidoc/guides/_ugvro_ro-spec.adoc
index 95f6bb3..43c3358 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ugvro_ro-spec.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ugvro_ro-spec.adoc
@@ -157,13 +157,12 @@ in the RO spec, the main point being to avoid the "N+1" problem of too many (slo
this feature one can load a grid of data in a single call. (That said, the xref:ugvro.adoc#_ugvro_simplified-representations[simplified representations]
supported by Restful Objects viewer also support this use case, albeit in way that deviates from the RO spec).
-The video below demonstrates the Restful Object viewer's support for `x-ro-follow-links` parameter, using the
+This link:https://www.youtube.com/watch?v=hSKnqqBQ7Zo[screencast] demonstrates the Restful Object viewer's support for `x-ro-follow-links` parameter, using the
(non-ASF) http://github.com/isisaddons/isis-app-kitchensink[Isis addons' kitchensink] app as the example,
This app contains three entities, `Grandparent`, `Parent` and `Child` that define a hierarchy of 1:m relationships.
-video::hSKnqqBQ7Zo[youtube,width="840px",height="472px"]
-The queries that are shown in the video include:
+The queries that are shown in the screencast include:
* show parent and its children (titles) +
+
http://git-wip-us.apache.org/repos/asf/isis/blob/d7797be1/adocs/documentation/src/main/asciidoc/guides/_ugvro_simplified-representations.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_ugvro_simplified-representations.adoc b/adocs/documentation/src/main/asciidoc/guides/_ugvro_simplified-representations.adoc
index c215f71..c1f3ddf 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_ugvro_simplified-representations.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_ugvro_simplified-representations.adoc
@@ -44,9 +44,8 @@ Accept: application/json;profile="urn:org.apache.isis/v1"
Not every resource supports this header, but the most commonly accessed ones do. In each case the server will set the
`Content-Type` header so that the client knows how to process the representation.
-The screencast below demonstrates the feature.
+The link:https://www.youtube.com/watch?v=HMSqapQDY_4[screencast] demonstrates the feature.
-video::HMSqapQDY_4[youtube,width="853px",height="480px"]
The sections below explain in a little more detail what is returned when this profile is activated.