You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by el...@apache.org on 2020/04/05 16:31:12 UTC
[maven-doxia-site] branch master updated: [MNGSITE-393] remove
Maven 2 and very old Doxia info (#2)
This is an automated email from the ASF dual-hosted git repository.
elharo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-doxia-site.git
The following commit(s) were added to refs/heads/master by this push:
new 4267341 [MNGSITE-393] remove Maven 2 and very old Doxia info (#2)
4267341 is described below
commit 426734185dece04a88cc118605290a3ed09ef5b3
Author: Elliotte Rusty Harold <el...@users.noreply.github.com>
AuthorDate: Sun Apr 5 12:31:05 2020 -0400
[MNGSITE-393] remove Maven 2 and very old Doxia info (#2)
* remove Maven 2 and very old Doxia info
* update links
---
content/apt/developers/maven-integration.apt | 86 ----------------------------
content/apt/developers/sink.apt | 10 ++--
content/apt/issues/index.apt | 22 -------
content/apt/resources.apt | 4 +-
content/apt/upgrading.apt.vm | 45 ---------------
content/apt/whatsnew-1.1.apt | 71 -----------------------
content/fml/faq.fml | 8 ---
content/site.xml | 4 --
8 files changed, 6 insertions(+), 244 deletions(-)
diff --git a/content/apt/developers/maven-integration.apt b/content/apt/developers/maven-integration.apt
deleted file mode 100644
index 708f064..0000000
--- a/content/apt/developers/maven-integration.apt
+++ /dev/null
@@ -1,86 +0,0 @@
- -----
- Integration With Maven
- -----
- Vincent Siveton
- ------
- 2009-03-02
- ------
-
-~~ 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.
-
-~~ NOTE: For help with the syntax of this file, see:
-~~ http://maven.apache.org/doxia/references/apt-format.html
-
-Integration With Maven
-
- This page presents how to use Doxia 1.1 under Maven 2.0.x and 2.1.x with a Maven reporting plugin.
- Its goal is to help the Maven reporting plugin developer to integrate it.
-
-* Maven 2.0.x
-
- Doxia 1.0 API is embedded in Maven 2.0.x (see {{{https://issues.apache.org/jira/browse/MNG-3402}MNG-3402}}),
- so your Maven reporting plugin needs to shade Doxia 1.1 API and Logging to be backward compatible
- with Maven 2.0.x.
-
-+-----+
-<project>
- ...
- <build>
- ...
- <plugins>
- <plugin>
- <artifactId>maven-shade-plugin</artifactId>
- <version>1.2</version>
- <executions>
- <execution>
- <phase>package</phase>
- <goals>
- <goal>shade</goal>
- </goals>
- <configuration>
- <finalName>${project.build.finalName}</finalName>
- <createDependencyReducedPom>false</createDependencyReducedPom>
- <keepDependenciesWithProvidedScope>true</keepDependenciesWithProvidedScope>
- <transformers>
- <transformer implementation="org.apache.maven.plugins.shade.resource.ComponentsXmlResourceTransformer" />
- </transformers>
- <artifactSet>
- <includes>
- <include>org.apache.maven.doxia:doxia-sink-api</include>
- <include>org.apache.maven.doxia:doxia-logging-api</include>
- </includes>
- </artifactSet>
- </configuration>
- </execution>
- </executions>
- </plugin>
- ...
- </plugins>
- </build>
- ...
-</project>
-+-----+
-
-* Maven 2.1.x
-
- Doxia 1.1 API and Logging are embedded in Maven 2.1.x, your Maven reporting plugin is directly compatible with 2.1.x.
-
-Common Bugs and Pitfalls
-
- Please read the {{{../issues/index.html}Doxia Issues}} page.
-
diff --git a/content/apt/developers/sink.apt b/content/apt/developers/sink.apt
index d138c6e..479f4a8 100644
--- a/content/apt/developers/sink.apt
+++ b/content/apt/developers/sink.apt
@@ -121,8 +121,8 @@ Using the Doxia Sink API
* {Passing attributes to Sink events}
- With Doxia 1.1 a number of methods have been added to the Sink API that
- allow to pass a set of attributes to many sink events. A typical use case would be:
+ A number of methods in the Sink API enable passing
+ a set of attributes to many sink events. A typical use case is:
+----
SinkEventAttributeSet atts = new SinkEventAttributeSet();
@@ -131,10 +131,10 @@ atts.addAttribute( SinkEventAttributes.ALIGN, "center" );
sink.paragraph( atts );
+----
- What kind of attributes are supported depends on the event and the sink
+ The kind of attributes supported depends on the event and the sink
implementation. The sink API specifies a list of suggested attribute
- names that sinks are expected to recognize, and parsers are expected to use
- preferably when emitting events.
+ names that sinks are expected to recognize and parsers are expected to use
+ when emitting events.
* {Avoid sink.rawText!}
diff --git a/content/apt/issues/index.apt b/content/apt/issues/index.apt
index 198b826..1aa4ee0 100644
--- a/content/apt/issues/index.apt
+++ b/content/apt/issues/index.apt
@@ -60,28 +60,6 @@ Doxia Issues & Gotchas
in <<<DEBUG>>> mode, eg invoke maven with the <<<-X>>> switch,
you can see which source document is being parsed when the warning is emitted.
-* {TOC macro issues}
-
- There was a particular {{{https://issues.apache.org/jira/browse/DOXIA-316}bug}}
- in the TOC macro in version 1.0 that has been fixed but leads to a
- backward incompatibility in some cases. If you have specified the
- <<<section>>> parameter in your TOC, as for instance:
-
-+----
-%{toc|section=1|fromDepth=1|toDepth=1}
-+----
-
- then the generated TOC is probably different from the result with Doxia 1.0.
- In <<Doxia 1.1>>, depth=1 is section, depth=2 is sub-section, etc, as documented
- in the {{{../macros/index.html#TOC_Macro}macro guide}}.
-
-* {Verbatim blocks not boxed}
-
- There was a particular {{{https://issues.apache.org/jira/browse/DOXIA-297}bug}}
- in Doxia 1.0 that verbatim blocks were always boxed. If after an upgrade
- to <<Doxia 1.1>> you find that your blocks are not boxed anymore, check that
- you actually start your verbatim block with <<<+-->>> (and not <<<--->>>).
-
* {Figure sink events}
Doxia distinguishes between figures, which are block-level elements, and images (or icons),
diff --git a/content/apt/resources.apt b/content/apt/resources.apt
index aaa1047..973eb95 100644
--- a/content/apt/resources.apt
+++ b/content/apt/resources.apt
@@ -41,12 +41,10 @@ External Resources
*-----------+--------------+--------------+
|| Title || Publisher || Author
*-----------+--------------+--------------+
-| {{{http://www.linux.com/feature/35690}Quick and dirty typesetting with APT}} | linux.com | Scott Nesbitt
+| {{{https://www.linux.com/news/quick-and-dirty-typesetting-apt/}Quick and dirty typesetting with APT}} | linux.com | Scott Nesbitt
*-----------+--------------+--------------+
| {{{http://en.wikipedia.org/wiki/Lightweight_markup_language}Lightweight markup language}} | wikipedia.org | ?
*-----------+--------------+--------------+
-| {{{http://project.knowledgeforge.net/kforge/trac/wiki/TextProcessing}Simple (Ascii-Based) Text Formats}} | project.knowledgeforge.net | ?
-*-----------+--------------+--------------+
* Tools
diff --git a/content/apt/upgrading.apt.vm b/content/apt/upgrading.apt.vm
deleted file mode 100644
index 9fc01f7..0000000
--- a/content/apt/upgrading.apt.vm
+++ /dev/null
@@ -1,45 +0,0 @@
- -----
- Upgrading from old versions
- -----
- Lukas Theussl
- ------
- 2011-05-28
- ------
-
-~~ 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.
-
-~~ NOTE: For help with the syntax of this file, see:
-~~ http://maven.apache.org/doxia/references/apt-format.html
-
-
-Latest release
-
- The current version of Doxia is ${doxiaVersion}.
-
-
-Upgrading from v. 1.0.x to 1.1.x
-
- See {{{./whatsnew-1.1.html}What's new in 1.1}}.
-
-Upgrading from v. 1.1.x to 1.2.x
-
- The only major change in version 1.2 is the upgrade to java 5.
- Functionally v. 1.2 is equivalent and fully compatible with v. 1.1.
-
- The full list of changes is available in the release notes:
- {{{https://issues.apache.org/jira/secure/ReleaseNote.jspa?version=12330556&styleName=Text&projectId=12317230}1.2}}
diff --git a/content/apt/whatsnew-1.1.apt b/content/apt/whatsnew-1.1.apt
deleted file mode 100644
index 77df06e..0000000
--- a/content/apt/whatsnew-1.1.apt
+++ /dev/null
@@ -1,71 +0,0 @@
- -----
- What's new in 1.1?
- -----
- Vincent Siveton
- ------
- 2009-05-31
- ------
-
-~~ 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.
-
-~~ NOTE: For help with the syntax of this file, see:
-~~ http://maven.apache.org/doxia/references/apt-format.html
-
-What's new in 1.1?
-
- This document describes the changes made to Maven Doxia between versions 1.0 and 1.1.
-
-* Notable New Features
-
- * <<Logging>>: added logging support with a new project called {{{./doxia/doxia-logging-api}doxia-logging-api}}.
-
- * <<Sink API improvements>>: added a new <<<SinkEventAttributes>>> interface to handle attributes.
- The <<<Sink>>> interface has been updated to use this new interface.
- Added new methods for comments and unknown events to the <<<Sink>>> interface.
-
- * <<SinkFactory>>: all Sink implementations can be retrieved via a factory.
-
- * <<XSDs>>: created several {{{./faq.html#doxia-xsd}XSDs}}, in particular for FML and Xdoc.
-
- * <<Tools>>: created some tools like a {{{./doxia-tools/doxia-converter/index.html}converter}}
- and a {{{./doxia-tools/doxia-linkcheck/index.html}linkchecker}}
- to use Doxia outside of Maven.
-
- * <<New Sinks>>: for Confluence, XLS-FO and Twiki.
-
- * Applied a few {{{./references/doxia-apt.html}modifications to the APT}} format.
-
- []
-
- The full list of changes for 1.1 can be found in our issue management system:
- {{{https://issues.apache.org/jira/secure/ReleaseNote.jspa?version=12330551&styleName=Text&projectId=12317230}1.1}} ::
- {{{https://issues.apache.org/jira/secure/ReleaseNote.jspa?version=12330552&styleName=Text&projectId=12317230}1.1.1}} ::
- {{{https://issues.apache.org/jira/secure/ReleaseNote.jspa?version=12330553&styleName=Text&projectId=12317230}1.1.2}} ::
- {{{https://issues.apache.org/jira/secure/ReleaseNote.jspa?version=12330554&styleName=Text&projectId=12317230}1.1.3}} ::
- {{{https://issues.apache.org/jira/secure/ReleaseNote.jspa?version=12330555&styleName=Text&projectId=12317230}1.1.4}}
-
-* Binary Incompatibility
-
- Please note that in version 1.1 a number of new methods were added to the
- {{{./doxia/doxia-sink-api/clirr-report.html}Sink and SinkFactory APIs}},
- which makes them binary incompatible with version 1.0.
-
- <<However>>, maven reporting plugins have been kept binary compatible.
- If you are a Maven Plugin developer and you plan to switch to Doxia 1.1, please read this
- {{{./developers/maven-integration.html}Maven Integration}} page to understand how to integrate correctly Doxia 1.1
- with Maven.
diff --git a/content/fml/faq.fml b/content/fml/faq.fml
index 74cf539..38a4b73 100644
--- a/content/fml/faq.fml
+++ b/content/fml/faq.fml
@@ -169,13 +169,5 @@ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd
</p>
</answer>
</faq>
- <faq id="How_to_integrate_Doxia_1.1_with_Maven">
- <question>How to integrate Doxia 1.1 with Maven?</question>
- <answer>
- <p>
- See this <a href="developers/maven-integration.html">page</a>.
- </p>
- </answer>
- </faq>
</part>
</faqs>
\ No newline at end of file
diff --git a/content/site.xml b/content/site.xml
index 8c01ecb..109b3b3 100644
--- a/content/site.xml
+++ b/content/site.xml
@@ -43,10 +43,6 @@ under the License.
<menu name="About Doxia">
<item name="What is Doxia?" href="index.html"/>
<item name="Overview" href="overview.html"/>
- <item name="Upgrading" href="upgrading.html" collapse="true">
- <item name="What's new in 1.1?" href="whatsnew-1.1.html"/>
- <item name="Maven Integration" href="developers/maven-integration.html"/>
- </item>
<item name="Downloads" href="downloads.html"/>
<item name="FAQ" href="faq.html"/>
</menu>