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 2018/01/31 10:00:16 UTC
[isis] branch maint-1.16.1 updated: ISIS-1849 - fixes documentation
issues
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch maint-1.16.1
in repository https://gitbox.apache.org/repos/asf/isis.git
The following commit(s) were added to refs/heads/maint-1.16.1 by this push:
new c430881 ISIS-1849 - fixes documentation issues
c430881 is described below
commit c430881d32e1ddd3ff0db19c5cf2b99027069a87
Author: Dan Haywood <da...@haywood-associates.co.uk>
AuthorDate: Wed Jan 31 09:59:54 2018 +0000
ISIS-1849 - fixes documentation issues
---
.../asciidoc/guides/dg/_dg_asciidoc-syntax.adoc | 47 ++++++++++------------
.../_dg_hints-and-tips_datanucleus-enhancer.adoc | 2 +-
.../main/asciidoc/guides/dg/_dg_ide_eclipse.adoc | 2 +-
.../guides/rgcms/_rgcms_classes_layout.adoc | 2 +-
.../rgcms/_rgcms_classes_value-types_Markup.adoc | 2 +-
..._ugtst_bdd-spec-support_writing-a-bdd-spec.adoc | 2 +-
.../_migration-notes_1.11.0-to-1.12.0.adoc | 2 +-
7 files changed, 28 insertions(+), 31 deletions(-)
diff --git a/adocs/documentation/src/main/asciidoc/guides/dg/_dg_asciidoc-syntax.adoc b/adocs/documentation/src/main/asciidoc/guides/dg/_dg_asciidoc-syntax.adoc
index ddfd707..9ffa64e 100644
--- a/adocs/documentation/src/main/asciidoc/guides/dg/_dg_asciidoc-syntax.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/dg/_dg_asciidoc-syntax.adoc
@@ -733,26 +733,21 @@ For example:
image:_images/vscode.png[]
....
-will render as:
-
-image:_images/vscode.png[]
-
-
-to make the image clickable, add in the `link` attribute:
+To make the image clickable, add in the `link` attribute:
....
image:_images/vscode.png[link="_images/vscode.png"]
....
-will render as:
-
-image:_images/vscode.png[link="_images/vscode.png"]
-to make the image clickable, add in the `link` attribute:
+It's also possible to specify the width using `scaledwidth` (for PDF/HTML) or `width` and `height` (for HTML only).
+For example:
-It's also possible to specify the width using `scaledwidth` (for PDF/HTML) or `width` and `height` (for HTML only).
+....
+image:_images/vscode.png[link="_images/vscode.png",width="800px"]
+....
@@ -762,13 +757,14 @@ It's also possible to specify the width using `scaledwidth` (for PDF/HTML) or `w
Use the `include:` macro to break up a document into multiple sections.
-For example, the xref:../../setting-up/concepts/concepts.adoc#[concepts] document is broken into several files:
+For example, this xref:dg.adoc#[developers' guide] document is broken into several files:
....
-concepts.adoc
-_concepts_why-a-new-platform.adoc
-_concepts_ci-as-a-service.adoc
-_concepts_git-intro.adoc
+dg.adoc
+_dg_ide.adoc
+_dg_hints-and-tips.adoc
+_dg_building-isis.adoc
+...
....
and so on.
@@ -777,9 +773,10 @@ These are included using:
[source,asciidoc]
----
-\include::_concepts_why-a-new-platform.adoc[leveloffset=+1]
-\include::_concepts_ci-as-a-service.adoc[leveloffset=+1]
-\include::_concepts_git-intro.adoc[leveloffset=+1]
+\include::_dg_ide.adoc[leveloffset=+1]
+\include::_dg_hints-and-tips.adoc[leveloffset=+1]
+\include::_dg_building-isis.adoc[leveloffset=+1]
+...
----
The `leveloffset=+1` means that each included file's heading levels are automatically adjusted.
@@ -794,21 +791,21 @@ To make this work, it relies upon the following naming conventions:
* every document should have an id anchor for its level heading corresponding to its file name
* every child document's name should be an '_ followed by the name of its parent.
-For example, `concepts.adoc` is:
+For example, `dg.adoc` is:
[source,asciidoc]
----
-[[concepts]]
-= Concepts
+[[dg]]
+= Developers' Guide
...
----
-while its child document `_concepts_why-a-new-platform.adoc` starts with:
+while its child document `_dg_ide.adoc` starts with:
[source,asciidoc]
----
-[[_concepts_why-a-new-platform]]
-= Why a new platform?
+[[_dg_ide]]
+= Using an IDE
...
----
diff --git a/adocs/documentation/src/main/asciidoc/guides/dg/_dg_hints-and-tips_datanucleus-enhancer.adoc b/adocs/documentation/src/main/asciidoc/guides/dg/_dg_hints-and-tips_datanucleus-enhancer.adoc
index 81a61d0..b198aaa 100644
--- a/adocs/documentation/src/main/asciidoc/guides/dg/_dg_hints-and-tips_datanucleus-enhancer.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/dg/_dg_hints-and-tips_datanucleus-enhancer.adoc
@@ -20,7 +20,7 @@ What this means is that the enhancer -- available as both a Maven plugin and as
If working from the Maven command line, JDO enhancement is done using the `maven-datanucleus-plugin`.
-Both the xref:ugfun.adoc#_ugfun_getting-started_helloworld-archetype[HelloWorld] and xref:ugfun.adoc#_ugfun_getting-started_simpleapp-archetype[SimpleApp] Maven archetypes generate applications that have this plugin pre-configured.
+Both the xref:../ugfun/ugfun.adoc#_ugfun_getting-started_helloworld-archetype[HelloWorld] and xref:../ugfun/ugfun.adoc#_ugfun_getting-started_simpleapp-archetype[SimpleApp] Maven archetypes generate applications that have this plugin pre-configured.
diff --git a/adocs/documentation/src/main/asciidoc/guides/dg/_dg_ide_eclipse.adoc b/adocs/documentation/src/main/asciidoc/guides/dg/_dg_ide_eclipse.adoc
index aed1094..97f24ac 100644
--- a/adocs/documentation/src/main/asciidoc/guides/dg/_dg_ide_eclipse.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/dg/_dg_ide_eclipse.adoc
@@ -40,7 +40,7 @@ To install, download each XML file, then go to `Windows > Preferences > Java > E
[[__dg_ide_eclipse_configure-lombok]]
== Install Project Lombok
-The xref:ugfun.adoc#_ugfun_getting-started_simpleapp-archetype[SimpleApp archetype] uses link:http://projectlombok.org[Project Lombok] annotations (`@Getter` and `@Setter` and so on) to reduce the boilerplate.
+The xref:../ugfun/ugfun.adoc#_ugfun_getting-started_simpleapp-archetype[SimpleApp archetype] uses link:http://projectlombok.org[Project Lombok] annotations (`@Getter` and `@Setter` and so on) to reduce the boilerplate.
For Eclipse IDE this requires an link:https://projectlombok.org/setup/eclipse[installation step]:
* Locate the `lombok.jar` jar file:
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_layout.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_layout.adoc
index 6eb8ba9..22f20dc 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_layout.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_layout.adoc
@@ -108,7 +108,7 @@ As you can probably guess, the `BS3Grid` is the top-level object (that is, it is
All of these classes also allow custom CSS to be specified; these are added to the CSS classes for the corresponding `<div`> in the rendered page.
The xref:../ugvw/ugvw.adoc#_ugvw_customisation_tweaking-css-classes[`application.css`] file can then be used for application-specific CSS, allowing arbitrary fine-tuning of the layout of the page.
-The XSD for these classes is available at link:http://isis.apache.org/applib/layout/menus/menubars.xsd[].
+The XSD for these classes is available at link:http://isis.apache.org/applib/layout/menubars/bootstrap3/menubars.xsd[].
[[__rgcms_classes_layout_link]]
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_value-types_Markup.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_value-types_Markup.adoc
index ccca1352..1b5e72a 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_value-types_Markup.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_value-types_Markup.adoc
@@ -9,7 +9,7 @@ The `Markup` value type (introduced in `1.15.1`) is intended to be used as a rea
For example:
-image::{_imagesdir}value-types/markup.png[width="px",link="{_imagesdir}value-types/markup/.png"]
+image::{_imagesdir}value-types/markup.png[width="px",link="{_imagesdir}value-types/markup.png"]
Corresponds to:
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugtst/_ugtst_bdd-spec-support_writing-a-bdd-spec.adoc b/adocs/documentation/src/main/asciidoc/guides/ugtst/_ugtst_bdd-spec-support_writing-a-bdd-spec.adoc
index b75d638..b639fd8 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugtst/_ugtst_bdd-spec-support_writing-a-bdd-spec.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugtst/_ugtst_bdd-spec-support_writing-a-bdd-spec.adoc
@@ -129,7 +129,7 @@ public class SimpleObjectMenuGlue extends CukeGlueAbstract2 {
[TIP]
====
-The xref:rgsvc.adoc#_rgsvc_api_Scratchpad[`Scratchpad`] domain service is one way in which glue classes can pass state between each other.
+The xref:../rgsvc/rgsvc.adoc#_rgsvc_api_Scratchpad[`Scratchpad`] domain service is one way in which glue classes can pass state between each other.
Or, for more type safety, you could develop your own custom domain services for each scenario, and inject these in as regular services.
See link:http://www.thinkcode.se/blog/2017/04/01/sharing-state-between-steps-in-cucumberjvm-using-picocontainer[this blog] post for more details.
====
diff --git a/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.11.0-to-1.12.0.adoc b/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.11.0-to-1.12.0.adoc
index a172a9a..4928c28 100644
--- a/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.11.0-to-1.12.0.adoc
+++ b/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.11.0-to-1.12.0.adoc
@@ -62,7 +62,7 @@ xref:../guides/rgsvc/rgsvc.adoc#_rgsvc_application-layer-api_MessageService[`Mes
The `DomainObjectContainer` service will continue to be supported until Apache Isis v2.0.0, but in the meantime, consider changing existing application code to use these new domain services.
-Please note that when migrating from _rgsvc_core-domain-api_DomainObjectContainer_object-persistence-api.adoc#_rgsvc_core-domain-api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer#persist()`] to xref:../../guides/rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-api_RepositoryService[`RepositoryService#persist()`], no exception will be thrown if the Domain Object is already persisted, so the behavior of xref:../guides/rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-api_RepositoryS [...]
+Please note that when migrating from _rgsvc_core-domain-api_DomainObjectContainer_object-persistence-api.adoc#_rgsvc_core-domain-api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer#persist()`] to xref:../../guides/rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-api_RepositoryService[`RepositoryService#persist()`], no exception will be thrown if the Domain Object is already persisted, so the behavior of xref:../guides/rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-api_RepositoryS [...]
--
To stop receiving notification emails like this one, please contact
danhaywood@apache.org.