Skip to content

Commit

Permalink
avoid syntax color when not useful
Browse files Browse the repository at this point in the history
  • Loading branch information
hboutemy committed Jun 6, 2020
1 parent 57589c9 commit 3ad95e1
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 34 deletions.
16 changes: 8 additions & 8 deletions src/site/apt/examples/adding-filtering-webresources.apt.vm
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Adding and Filtering External Web Resources

Using our sample project in the {{{../usage.html}usage section}} with an added external resource, like this:

+----------+
----------
.
|-- pom.xml
|-- resource2
Expand All @@ -87,7 +87,7 @@ Adding and Filtering External Web Resources
|-- index.jsp
`-- jsp
`-- websource.jsp
+----------+
----------

would end up in the WAR as:

Expand Down Expand Up @@ -228,7 +228,7 @@ documentedproject-1.0-SNAPSHOT.war
Using our example above, we can also configure filters for our resources.
We will add a hypothetical <<<configurations>>> directory to our project:

+----------+
----------
.
|-- configurations
| |-- config.cfg
Expand All @@ -255,7 +255,7 @@ documentedproject-1.0-SNAPSHOT.war
|-- index.jsp
`-- jsp
`-- websource.jsp
+----------+
----------

To prevent corrupting your binary files when filtering is enabled, you can configure a list of file extensions that
will not be filtered.
Expand Down Expand Up @@ -307,7 +307,7 @@ interpolated_property=some_config_value

The resulting WAR would be:

+----------+
----------
documentedproject-1.0-SNAPSHOT.war
|-- META-INF
| |-- MANIFEST.MF
Expand All @@ -332,7 +332,7 @@ documentedproject-1.0-SNAPSHOT.war
|-- index.jsp
`-- jsp
`-- websource.jsp
+----------+
----------

and the content of <<<config.cfg>>> would be:

Expand Down Expand Up @@ -379,7 +379,7 @@ documentedproject-1.0-SNAPSHOT.war

Using the sample project the resulting WAR would look like this:

+----------+
----------
documentedproject-1.0-SNAPSHOT.war
|-- META-INF
| |-- MANIFEST.MF
Expand All @@ -404,4 +404,4 @@ documentedproject-1.0-SNAPSHOT.war
|-- index.jsp
`-- jsp
`-- websource.jsp
+----------+
----------
4 changes: 2 additions & 2 deletions src/site/apt/examples/skinny-wars.apt.vm
Original file line number Diff line number Diff line change
Expand Up @@ -91,15 +91,15 @@ Creating Skinny WARs

Your EAR will contain something like this:

+-----------------+
-----------------
.
|-- META-INF
| `-- application.xml
|-- lib
| `-- shared-jar-1.0.0.jar
|-- war1-1.0.0.war
`-- war2-1.0.0.war
+-----------------+
-----------------


* Alternatives
Expand Down
4 changes: 2 additions & 2 deletions src/site/apt/index.apt.vm
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ ${project.name}
Of course, patches are welcome, too. Contributors can check out the project from
our {{{./scm.html}source repository}} and will find supplementary
information in the
{{{http://maven.apache.org/guides/development/guide-helping.html}guide to helping with Maven}}.
{{{/guides/development/guide-helping.html}guide to helping with Maven}}.

* Examples

Expand All @@ -103,6 +103,6 @@ ${project.name}

* Related links

* {{{http://maven.apache.org/guides/mini/guide-archive-configuration.html}Exclusion of Maven Descriptors}}
* {{{/guides/mini/guide-archive-configuration.html}Exclusion of Maven Descriptors}}

[]
12 changes: 6 additions & 6 deletions src/site/apt/overlays.apt.vm
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Overlays

To demonstrate, given this structure for the project <<<documentedproject>>>:

+-----------------+
-----------------
|-- pom.xml
`-- src
`-- main
Expand All @@ -57,7 +57,7 @@ Overlays
|-- index.jsp
`-- jsp
`-- websource.jsp
+-----------------+
-----------------

The project depends on another WAR artifact, <<<documentedprojectdependency-1.0-SNAPSHOT.war>>>,
which is declared as a dependency in the project's <<<pom.xml>>>:
Expand All @@ -79,7 +79,7 @@ Overlays

The structure for the <<<documentedprojectdependency>>> WAR file looks like this:

+-----------------+
-----------------
documentedprojectdependency-1.0-SNAPSHOT.war
|-- META-INF
| |-- MANIFEST.MF
Expand All @@ -98,11 +98,11 @@ documentedprojectdependency-1.0-SNAPSHOT.war
| | `-- sampleimage-dependency.jpg
| `-- web.xml
`-- index-dependency.jsp
+-----------------+
-----------------

The resulting WAR would end up like this:

+-----------------+
-----------------
|-- META-INF
| |-- MANIFEST.MF
| `-- maven
Expand All @@ -125,7 +125,7 @@ documentedprojectdependency-1.0-SNAPSHOT.war
|-- index.jsp
`-- jsp
`-- websource.jsp
+-----------------+
-----------------

The <<<web.xml>>> file above comes from <<<documentedproject>>>.

Expand Down
32 changes: 16 additions & 16 deletions src/site/apt/usage.apt.vm
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Usage

The project's structure looks like this:

+----------+
----------
|-- pom.xml
`-- src
`-- main
Expand All @@ -88,23 +88,23 @@ Usage
|-- index.jsp
`-- jsp
`-- websource.jsp
+----------+
----------

Invoking

+----------+
----------
mvn package
+----------+
----------

or

+----------+
----------
mvn compile war:war
+----------+
----------

will generate the WAR file <<<target/documentedproject-1.0-SNAPSHOT.war>>>. Here are the contents of that WAR file:

+----------+
----------
documentedproject-1.0-SNAPSHOT.war
|-- META-INF
| |-- MANIFEST.MF
Expand All @@ -125,22 +125,22 @@ documentedproject-1.0-SNAPSHOT.war
|-- index.jsp
`-- jsp
`-- websource.jsp
+----------+
----------

*Invocation of <<<war:exploded>>> goal

To speed up testing during the developement phase, <<<war:explode>>> can be used to generate the WAR in exploded
form.
Use the same project as above and invoke:

+----------+
----------
mvn compile war:exploded
+----------+
----------

This will generate an exploded version of the WAR in <<<target/documentedproject-1.0-SNAPSHOT>>>.
The contents of that directory looks like this:

+----------+
----------
documentedproject-1.0-SNAPSHOT
|-- META-INF
|-- WEB-INF
Expand All @@ -155,7 +155,7 @@ mvn compile war:exploded
|-- index.jsp
`-- jsp
`-- websource.jsp
+----------+
----------

The default directory for the exploded WAR is <<<target/\<finalName\>>>>. The <<<finalName>>> is usually in the form
of <<<\<artifactId\>-\<version\>>>>.
Expand Down Expand Up @@ -186,13 +186,13 @@ mvn compile war:exploded
in the webapp source, which defaults to <<<src/main/webapp>>>.
Use our sample project above, and invoke:

+----------+
----------
mvn compile war:inplace
+----------+
----------

This will result in:

+----------+
----------
|-- pom.xml
|-- src
| `-- main
Expand Down Expand Up @@ -226,4 +226,4 @@ mvn compile war:inplace
| `-- SampleAction.class
`-- images
`-- sampleimage.jpg
+----------+
----------

0 comments on commit 3ad95e1

Please sign in to comment.