Skip to content

Commit

Permalink
replaces hard-code Sculptor version number wit property from _config.…
Browse files Browse the repository at this point in the history
…yml and adds links to the Maven archetypes
  • Loading branch information
tjuerge committed Jan 21, 2014
1 parent 8cf1e97 commit 0136b10
Show file tree
Hide file tree
Showing 7 changed files with 25 additions and 20 deletions.
7 changes: 4 additions & 3 deletions documentation/advanced-tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,10 @@ In this part we will setup the project structure for maven and eclipse.

![Tryit](../images/tryit.gif)

1. Use the following command (one line) to create a maven pom and file structure.
1. Use [Sculptors Maven archetype][5] with the following command (one line) to create a Maven POM and file structure.

~~~
mvn archetype:generate -DarchetypeGroupId=org.sculptorgenerator -DarchetypeArtifactId=sculptor-archetype-standalone -DarchetypeVersion=3.0.0 -DarchetypeRepository=ttps://raw.github.com/sculptor/repository/maven/
mvn archetype:generate -DarchetypeGroupId=org.sculptorgenerator -DarchetypeArtifactId=sculptor-archetype-standalone -DarchetypeVersion={{site.sculptor_version}}
~~~

Fill in groupId and archetypeId:
Expand Down Expand Up @@ -1227,7 +1227,7 @@ Sculptor generates several UML diagrams for the domain model. The [above diagram
We are using [Graphviz](http://www.graphviz.org/).
Sculptor generates textual Graphviz `.dot` files, which is then used to generate images.

[Sculptors Maven plugin `sculptor-maven-plugin`][3] (goal `generate-images`) generates images (.png) from the .dot files. This plugin is included in the `pom.xml` created by the maven archetypes, but you need to install Graphviz and have executable `dot` in path.
[Sculptors Maven plugin `sculptor-maven-plugin`][3] (goal `generate-images`) generates images (.png) from the .dot files. This plugin is included in the `pom.xml` created by the [Maven archetypes][5], but you need to install Graphviz and have executable `dot` in path.

It is possible to mark some domain objects with `hint="umlgraph=core"` to generate a special diagram with those domain objects in focus.

Expand Down Expand Up @@ -2441,3 +2441,4 @@ The complete source code for this tutorial is available in GitHub [https://githu
[2]: installation
[3]: maven-plugin
[4]: http://www.slf4j.org
[5]: maven-archetypes#sculptor-maven-archetype
4 changes: 2 additions & 2 deletions documentation/archetype-tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Copy one of the following scripts into the root of your Eclipse workspace.
set PACKAGE=%1
set SYS_NAME=%2
set VERSION=3.0.0
set VERSION={{site.sculptor_version}}
mvn archetype:generate -DinteractiveMode=false -DarchetypeGroupId=org.sculptorgenerator -DarchetypeArtifactId=sculptor-maven-archetype-parent -DarchetypeVersion=%VERSION% -DgroupId=%PACKAGE% -DartifactId=%SYS_NAME%-parent -Dpackage=%PACKAGE% -Dversion=1.0-SNAPSHOT -Dweb=true
Expand Down Expand Up @@ -82,7 +82,7 @@ Copy one of the following scripts into the root of your Eclipse workspace.
PACKAGE=$1
SYS_NAME=$2
VERSION=3.0.0
VERSION={{site.sculptor_version}}
mvn archetype:generate -DinteractiveMode=false -DarchetypeGroupId=org.sculptorgenerator -DarchetypeArtifactId=sculptor-maven-archetype-parent \
-DarchetypeVersion=$VERSION -DgroupId=$PACKAGE -DartifactId=$SYS_NAME-parent \
Expand Down
6 changes: 3 additions & 3 deletions documentation/hello-world-tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,12 @@ Before you start you must follow the instructions in the **[Installation Guide][

In this first part we will setup the project structure for Maven and Eclipse.

1. Use the following command (**one line** - indicated by the trailing `\`) to create a new project with [Maven POM](http://maven.apache.org/guides/introduction/introduction-to-the-pom.html) and file structure. You can change the groupId and artifactId if you like.
1. Use [Sculptors Maven archetype][8] with the following command (**one line** - indicated by the trailing `\`) to create a new project with [Maven POM](http://maven.apache.org/guides/introduction/introduction-to-the-pom.html) and file structure. You can change the groupId and artifactId if you like.

~~~
mvn archetype:generate -DarchetypeGroupId=org.sculptorgenerator \
-DarchetypeArtifactId=sculptor-maven-archetype \
-DarchetypeVersion=3.0.0 \
-DarchetypeVersion={{site.sculptor_version}} \
-Dstandalone=true
~~~

Expand Down Expand Up @@ -200,4 +200,4 @@ To regenerate you use `mvn generate-sources -Dsculptor.generator.force=true`
[5]: http://hsqldb.org/
[6]: /images/emoticons/thumbs_up.png
[7]: /images/emoticons/thumbs_down.png

[8]: maven-archetypes#sculptor-maven-archetype
8 changes: 4 additions & 4 deletions documentation/maven-archetypes.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ The following command (**one line** - indicated by the trailing `\`) creates the
~~~
mvn archetype:generate -DinteractiveMode=false -DarchetypeGroupId=org.sculptorgenerator \
-DarchetypeArtifactId=sculptor-maven-archetype-parent \
-DarchetypeVersion=3.0.0 \
-DarchetypeVersion={{site.sculptor_version}} \
-DgroupId=org.helloworld -DartifactId=helloworld-parent -Dpackage=org.helloworld \
-Dversion=1.0-SNAPSHOT -Dear=true
~~~
Expand Down Expand Up @@ -77,7 +77,7 @@ The following command (**one line** - indicated by the trailing `\`) creates the
~~~
mvn archetype:generate -DinteractiveMode=false -DarchetypeGroupId=org.sculptorgenerator \
-DarchetypeArtifactId=sculptor-maven-archetype \
-DarchetypeVersion=3.0.0 \
-DarchetypeVersion={{site.sculptor_version}} \
-DgroupId=org.helloworld -DartifactId=helloworld -Dpackage=org.helloworld \
-Dversion=1.0-SNAPSHOT -Drest=true -Dstandalone=true
~~~
Expand Down Expand Up @@ -105,7 +105,7 @@ The following command (**one line** - indicated by the trailing `\`) creates the
~~~
mvn archetype:generate -DinteractiveMode=false -DarchetypeGroupId=org.sculptorgenerator \
-DarchetypeArtifactId=sculptor-maven-archetype-web \
-DarchetypeVersion=3.0.0 \
-DarchetypeVersion={{site.sculptor_version}} \
-DgroupId=org.helloworld -DartifactId=helloworld-web -Dpackage=org.helloworld \
-Dversion=1.0-SNAPSHOT -Dejb=true -Dear=true -Drest=true
~~~
Expand All @@ -131,7 +131,7 @@ The following command (**one line** - indicated by the trailing `\`) creates the
~~~
mvn archetype:generate -DinteractiveMode=false -DarchetypeGroupId=org.sculptorgenerator \
-DarchetypeArtifactId=sculptor-maven-archetype-ear \
-DarchetypeVersion=3.0.0 \
-DarchetypeVersion={{site.sculptor_version}} \
-DgroupId=org.helloworld -DartifactId=helloworld-ear -Dpackage=org.helloworld \
-Dversion=1.0-SNAPSHOT -Dejb=true -Dweb=true
~~~
Expand Down
4 changes: 2 additions & 2 deletions documentation/mongodb-tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,12 @@ Before you start you need to run a mongoDB server locally. Therefore [download a

In this first part we will setup the project structure for Maven and Eclipse.

1. Use the following command (**one line** - indicated by the trailing `\`) to create a new project with [Maven POM](http://maven.apache.org/guides/introduction/introduction-to-the-pom.html) and file structure. You can change the groupId and artifactId if you like.
1. Use [Sculptors Maven archetype][16] with the following command (**one line** - indicated by the trailing `\`) to create a new project with [Maven POM](http://maven.apache.org/guides/introduction/introduction-to-the-pom.html) and file structure. You can change the groupId and artifactId if you like.

~~~
mvn archetype:generate -DarchetypeGroupId=org.sculptorgenerator \
-DarchetypeArtifactId=sculptor-maven-archetype \
-DarchetypeVersion=3.0.0 \
-DarchetypeVersion={{site.sculptor_version}} \
-Dstandalone=true \
-Dmongodb=true
~~~
Expand Down
11 changes: 7 additions & 4 deletions documentation/pure-ejb3-tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@ It consists of the following Maven projects:
* `helloworld` - Business tier. EJB project containing the services and domain objects.
* `helloworld-ear` - EAR package of the deployable application.

These projects are created with Sculptors Maven archetypes as follows:
These projects are created with [Sculptors Maven archetypes][1] as follows:

1. Create `helloworld-parent` project with the following command (**one line** - indicated by the trailing `\`):

~~~
mvn archetype:generate -DinteractiveMode=false -DarchetypeGroupId=org.sculptorgenerator \
-DarchetypeArtifactId=sculptor-maven-archetype-parent -DarchetypeVersion=3.0.0 \
-DarchetypeArtifactId=sculptor-maven-archetype-parent -DarchetypeVersion={{site.sculptor_version}} \
-DgroupId=org.helloworld -DartifactId=helloworld-parent -Dpackage=org.helloworld \
-Dversion=1.0-SNAPSHOT -Dear=true
~~~
Expand All @@ -41,7 +41,7 @@ These projects are created with Sculptors Maven archetypes as follows:

~~~
mvn archetype:generate -DinteractiveMode=false -DarchetypeGroupId=org.sculptorgenerator \
-DarchetypeArtifactId=sculptor-maven-archetype -DarchetypeVersion=3.0.0 \
-DarchetypeArtifactId=sculptor-maven-archetype -DarchetypeVersion={{site.sculptor_version}} \
-DgroupId=org.helloworld -DartifactId=helloworld -Dpackage=org.helloworld \
-Dversion=1.0-SNAPSHOT -Dejb=true
~~~
Expand All @@ -54,7 +54,7 @@ These projects are created with Sculptors Maven archetypes as follows:

~~~
mvn archetype:generate -DinteractiveMode=false -DarchetypeGroupId=org.sculptorgenerator \
-DarchetypeArtifactId=sculptor-maven-archetype-ear -DarchetypeVersion=3.0.0 \
-DarchetypeArtifactId=sculptor-maven-archetype-ear -DarchetypeVersion={{site.sculptor_version}} \
-DgroupId=org.helloworld -DartifactId=helloworld-ear -Dpackage=org.helloworld \
-Dversion=1.0-SNAPSHOT
~~~
Expand Down Expand Up @@ -447,3 +447,6 @@ Run `SimpleSend`. You'll find in JBoss console log something like this:
Open SoapUI again an execute the `getAllPlanets` request. Voilà! The planet is retrieved.

![Soapui Screenshot](/images/documentation/pure-ejb3-tutorial/soapui-screenshot.png)


[1]: maven-archetypes
5 changes: 3 additions & 2 deletions documentation/rest-tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@ HTML, JSON and XML representations are generated.

At first we will setup the project structure for Maven and Eclipse.

1. Use the following command (**one line** - indicated by the trailing `\`) to create a new project with [Maven POM](http://maven.apache.org/guides/introduction/introduction-to-the-pom.html) and file structure. You can change the groupId and artifactId if you like.
1. Use [Sculptors Maven archetype][12] with the following command (**one line** - indicated by the trailing `\`) to create a new project with [Maven POM](http://maven.apache.org/guides/introduction/introduction-to-the-pom.html) and file structure. You can change the groupId and artifactId if you like.

~~~
mvn archetype:generate -DarchetypeGroupId=org.sculptor \
-DarchetypeArtifactId=sculptor-maven-archetype \
-DarchetypeVersion=3.0.0 \
-DarchetypeVersion={{site.sculptor_version}} \
-Dstandalone=true -Drest=true
~~~

Expand Down Expand Up @@ -539,3 +539,4 @@ generate.restWeb.jsp=false
[9]: https://jaxb.java.net/
[10]: advanced-tutorial#cross-project-references
[11]: maven-plugin#configuration
[12]: maven-archetypes#sculptor-maven-archetype

0 comments on commit 0136b10

Please sign in to comment.