You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by mi...@apache.org on 2019/06/19 21:14:23 UTC
[maven-site-plugin] branch MSITE-838 created (now 337cb16)
This is an automated email from the ASF dual-hosted git repository.
michaelo pushed a change to branch MSITE-838
in repository https://gitbox.apache.org/repos/asf/maven-site-plugin.git.
at 337cb16 [MSITE-838] Include support for confluence/docbook/twiki by default
This branch includes the following new commits:
new 337cb16 [MSITE-838] Include support for confluence/docbook/twiki by default
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
[maven-site-plugin] 01/01: [MSITE-838] Include support for
confluence/docbook/twiki by default
Posted by mi...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
michaelo pushed a commit to branch MSITE-838
in repository https://gitbox.apache.org/repos/asf/maven-site-plugin.git
commit 337cb162a94304bf8c9decaa5379ffffaf1b0154
Author: Matt Nelson <ma...@cerner.com>
AuthorDate: Mon Jun 10 18:33:37 2019 -0500
[MSITE-838] Include support for confluence/docbook/twiki by default
This closes #7
---
pom.xml | 18 +++++++
.../src/site/confluence/confluence.confluence | 33 +++++++++++++
.../doxia-formats/src/site/docbook/docbook.xml | 56 ++++++++++++++++++++++
.../doxia-formats/src/site/twiki/twiki.twiki | 23 +++++++++
src/it/projects/doxia-formats/verify.groovy | 4 ++
src/site/apt/history.apt | 2 +
6 files changed, 136 insertions(+)
diff --git a/pom.xml b/pom.xml
index 751310c..361fa17 100644
--- a/pom.xml
+++ b/pom.xml
@@ -373,6 +373,24 @@ under the License.
<version>${doxiaVersion}</version>
<scope>runtime</scope>
</dependency>
+ <dependency>
+ <groupId>org.apache.maven.doxia</groupId>
+ <artifactId>doxia-module-confluence</artifactId>
+ <version>${doxiaVersion}</version>
+ <scope>runtime</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.maven.doxia</groupId>
+ <artifactId>doxia-module-docbook-simple</artifactId>
+ <version>${doxiaVersion}</version>
+ <scope>runtime</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.maven.doxia</groupId>
+ <artifactId>doxia-module-twiki</artifactId>
+ <version>${doxiaVersion}</version>
+ <scope>runtime</scope>
+ </dependency>
<!-- Doxia Sitetools -->
<dependency>
diff --git a/src/it/projects/doxia-formats/src/site/confluence/confluence.confluence b/src/it/projects/doxia-formats/src/site/confluence/confluence.confluence
new file mode 100644
index 0000000..d3ba5ec
--- /dev/null
+++ b/src/it/projects/doxia-formats/src/site/confluence/confluence.confluence
@@ -0,0 +1,33 @@
+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.
+
+h4. Confluence Markup
+
+Ideally, the markup should be _readable_ and even *clearly understandable* when you are
+editing it. Inserting formatting should require few keystrokes, and little thought.
+
+After all, we want people to be concentrating on the words, not on where the angle-brackets
+should go.
+
+* Kinds of Markup
+** Text Effects
+** Headings
+** Text Breaks
+** Links
+** Other
+
+Example from [https://confluence.atlassian.com/display/CONF25/Confluence+Notation+Guide+Overview]
diff --git a/src/it/projects/doxia-formats/src/site/docbook/docbook.xml b/src/it/projects/doxia-formats/src/site/docbook/docbook.xml
new file mode 100644
index 0000000..43c7b1c
--- /dev/null
+++ b/src/it/projects/doxia-formats/src/site/docbook/docbook.xml
@@ -0,0 +1,56 @@
+<?xml version="1.0" encoding='UTF-8'?>
+<!--
+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.
+-->
+<!-- example from https://supportweb.cs.bham.ac.uk/docs/tutorials/docsystem/build/tutorials/docbooksys/segmentedhtml/ch08s03.html -->
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+<article>
+ <articleinfo>
+ <title>Your title here</title>
+
+ <author>
+ <firstname>Your first name</firstname>
+ <surname>Your surname</surname>
+ <affiliation>
+ <address><email>Your e-mail address</email></address>
+ </affiliation>
+ </author>
+
+ <copyright>
+ <year>2002</year>
+ <holder role="mailto:your e-mail address">Your name</holder>
+ </copyright>
+
+ <abstract>
+ <para>Include an abstract of the article's contents here.</para>
+ </abstract>
+ </articleinfo>
+
+ <sect1><title>Section 1</title>
+ <para>
+ blah blah blah
+ </para>
+ </sect1>
+
+ <sect1><title>Section 2</title>
+ <para>
+ blah blah blah
+ </para>
+ </sect1>
+</article>
diff --git a/src/it/projects/doxia-formats/src/site/twiki/twiki.twiki b/src/it/projects/doxia-formats/src/site/twiki/twiki.twiki
new file mode 100644
index 0000000..d235934
--- /dev/null
+++ b/src/it/projects/doxia-formats/src/site/twiki/twiki.twiki
@@ -0,0 +1,23 @@
+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.
+
+---++ Example
+
+ * level 1
+ * level 2
+ * back on 1
+ * last bullet
\ No newline at end of file
diff --git a/src/it/projects/doxia-formats/verify.groovy b/src/it/projects/doxia-formats/verify.groovy
index 2a1ce97..ebe0c14 100644
--- a/src/it/projects/doxia-formats/verify.groovy
+++ b/src/it/projects/doxia-formats/verify.groovy
@@ -40,4 +40,8 @@ assert !content.replace('<<<$value', '').contains( '<<<$' );
assert new File( basedir, 'target/site/markdown2.html' ).exists(); // DOXIA-535
+assert new File( basedir, 'target/site/confluence.html' ).exists(); // MSITE-838
+assert new File( basedir, 'target/site/docbook.html' ).exists(); //MSITE-838
+assert new File( basedir, 'target/site/twiki.html' ).exists(); //MSITE-838
+
return true;
diff --git a/src/site/apt/history.apt b/src/site/apt/history.apt
index d82cb28..8adf5fa 100644
--- a/src/site/apt/history.apt
+++ b/src/site/apt/history.apt
@@ -56,6 +56,8 @@ Maven Site Plugin History
*-----------------*--------------------*--------*------------------*--------------------*---------------*
|| relelease date || maven-site-plugin || {{{/doxia/}Doxia}} || {{{/doxia/doxia-sitetools/}Doxia Sitetools}} || {{{/shared/maven-reporting-exec/}Maven Reporting Executor}} || Comment
*-----------------*--------------------*--------*------------------*--------------------*---------------*
+| 2019-06 | 3.8 | 1.9 | 1.9.1 | 1.4 | addition of confluence/docbook/twiki support by default
+*-----------------*--------------------*--------*------------------*--------------------*---------------*
| 2018-04 | 3.7.1 | 1.8 | 1.8.1 | 1.4 |
*-----------------*--------------------*--------*------------------*--------------------*---------------*
| 2017-12-31 | 3.7 | 1.8 | 1.8 | 1.4 | Markdown parser/HTML renderer {{{/doxia/doxia/doxia-modules/doxia-module-markdown/}changed}}