This is an automated email from the ASF dual-hosted git repository.
michaelo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-doxia-sitetools.git
The following commit(s) were added to refs/heads/master by this push:
new cabe7d3 [DOXIASITETOOLS-236] Deprecate Doxia Sitetools Doc Renderer
cabe7d3 is described below
commit cabe7d304f9e75ea1e40f1563854962132cb9a9a
Author: Michael Osipov <[email protected]>
AuthorDate: Sun Nov 28 19:53:05 2021 +0100
[DOXIASITETOOLS-236] Deprecate Doxia Sitetools Doc Renderer
---
.../docrenderer/AbstractDocumentRenderer.java | 1 +
.../maven/doxia/docrenderer/DocRenderer.java | 1 +
.../maven/doxia/docrenderer/DocumentRenderer.java | 1 +
.../doxia/docrenderer/DocumentRendererContext.java | 1 +
.../docrenderer/DocumentRendererException.java | 1 +
.../doxia/docrenderer/pdf/AbstractPdfRenderer.java | 1 +
.../maven/doxia/docrenderer/pdf/PdfRenderer.java | 1 +
.../doxia/docrenderer/pdf/fo/FoPdfRenderer.java | 7 +++---
.../docrenderer/pdf/itext/ITextPdfRenderer.java | 7 +++---
doxia-doc-renderer/src/site/apt/index.apt | 27 ++++++++++++++++++++++
10 files changed, 42 insertions(+), 6 deletions(-)
diff --git
a/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.java
b/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.java
index bc9f7e5..108cd21 100644
---
a/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.java
+++
b/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/AbstractDocumentRenderer.java
@@ -69,6 +69,7 @@ import org.codehaus.plexus.velocity.VelocityComponent;
* @author ltheussl
* @since 1.1
*/
+@Deprecated
public abstract class AbstractDocumentRenderer
extends AbstractLogEnabled
implements DocumentRenderer
diff --git
a/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/DocRenderer.java
b/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/DocRenderer.java
index 6bc737a..c953867 100644
---
a/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/DocRenderer.java
+++
b/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/DocRenderer.java
@@ -28,6 +28,7 @@ import java.io.IOException;
* @author <a href="mailto:[email protected]";>Vincent Siveton</a>
* @deprecated Since 1.1, use {@link DocumentRenderer} instead.
*/
+@Deprecated
public interface DocRenderer
{
/** Plexus lookup. */
diff --git
a/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/DocumentRenderer.java
b/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/DocumentRenderer.java
index 2022309..b8c9ec2 100644
---
a/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/DocumentRenderer.java
+++
b/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/DocumentRenderer.java
@@ -32,6 +32,7 @@ import org.apache.maven.doxia.document.DocumentModel;
* @author ltheussl
* @since 1.1
*/
+@Deprecated
public interface DocumentRenderer
{
/** Plexus lookup role. */
diff --git
a/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/DocumentRendererContext.java
b/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/DocumentRendererContext.java
index 4610637..c381727 100644
---
a/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/DocumentRendererContext.java
+++
b/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/DocumentRendererContext.java
@@ -30,6 +30,7 @@ import org.codehaus.plexus.util.ReaderFactory;
* @author <a href="mailto:[email protected]";>Vincent Siveton</a>
* @since 1.1.2
*/
+@Deprecated
public class DocumentRendererContext
{
private String inputEncoding = ReaderFactory.UTF_8;
diff --git
a/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/DocumentRendererException.java
b/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/DocumentRendererException.java
index b4a9160..33b8da0 100644
---
a/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/DocumentRendererException.java
+++
b/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/DocumentRendererException.java
@@ -25,6 +25,7 @@ package org.apache.maven.doxia.docrenderer;
* @author <a href="mailto:[email protected]";>Vincent Siveton</a>
* @since 1.1
*/
+@Deprecated
public class DocumentRendererException
extends Exception
{
diff --git
a/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/AbstractPdfRenderer.java
b/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/AbstractPdfRenderer.java
index ade91b0..503bf77 100644
---
a/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/AbstractPdfRenderer.java
+++
b/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/AbstractPdfRenderer.java
@@ -34,6 +34,7 @@ import org.apache.maven.doxia.parser.module.ParserModule;
* @author ltheussl
* @since 1.1
*/
+@Deprecated
public abstract class AbstractPdfRenderer
extends AbstractDocumentRenderer
implements PdfRenderer
diff --git
a/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/PdfRenderer.java
b/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/PdfRenderer.java
index 6e961e2..7bb48ad 100644
---
a/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/PdfRenderer.java
+++
b/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/PdfRenderer.java
@@ -30,6 +30,7 @@ import
org.apache.maven.doxia.docrenderer.DocumentRendererException;
* @author ltheussl
* @since 1.1
*/
+@Deprecated
public interface PdfRenderer
extends DocumentRenderer
{
diff --git
a/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/fo/FoPdfRenderer.java
b/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/fo/FoPdfRenderer.java
index e264f83..b614384 100644
---
a/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/fo/FoPdfRenderer.java
+++
b/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/fo/FoPdfRenderer.java
@@ -55,6 +55,7 @@ import org.xml.sax.SAXParseException;
* @author ltheussl
* @since 1.1
*/
+@Deprecated
@Component( role = PdfRenderer.class, hint = "fo" )
public class FoPdfRenderer
extends AbstractPdfRenderer
@@ -300,7 +301,7 @@ public class FoPdfRenderer
{
String doc = href + "." + extension;
File source = new File( moduleBasedir, doc );
-
+
// Velocity file?
if ( !source.exists() )
{
@@ -314,12 +315,12 @@ public class FoPdfRenderer
}
source = new File( moduleBasedir, doc );
}
-
+
if ( source.exists() )
{
sink.setDocumentName( doc );
sink.setDocumentTitle( tocItem.getName() );
-
+
parse( source.getPath(), module.getParserId(), sink,
context );
}
}
diff --git
a/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/itext/ITextPdfRenderer.java
b/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/itext/ITextPdfRenderer.java
index dd47743..4259405 100644
---
a/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/itext/ITextPdfRenderer.java
+++
b/doxia-doc-renderer/src/main/java/org/apache/maven/doxia/docrenderer/pdf/itext/ITextPdfRenderer.java
@@ -79,6 +79,7 @@ import com.lowagie.text.ElementTags;
* @author ltheussl
* @since 1.1
*/
+@Deprecated
@Component( role = PdfRenderer.class, hint = "itext" )
public class ITextPdfRenderer
extends AbstractPdfRenderer
@@ -611,7 +612,7 @@ public class ITextPdfRenderer
{
String doc = href + "." + extension;
File source = new File( moduleBasedir, doc );
-
+
// Velocity file?
if ( !source.exists() )
{
@@ -625,7 +626,7 @@ public class ITextPdfRenderer
}
source = new File( moduleBasedir, doc );
}
-
+
if ( source.exists() )
{
String outputITextName = doc.substring( 0,
doc.lastIndexOf( '.' ) + 1 ) + "xml";
@@ -635,7 +636,7 @@ public class ITextPdfRenderer
{
outputITextFileTmp.getParentFile().mkdirs();
}
-
+
iTextFiles.add( outputITextFileTmp );
parse( source, module, outputITextFileTmp, context
);
}
diff --git a/doxia-doc-renderer/src/site/apt/index.apt
b/doxia-doc-renderer/src/site/apt/index.apt
new file mode 100644
index 0000000..82b38e2
--- /dev/null
+++ b/doxia-doc-renderer/src/site/apt/index.apt
@@ -0,0 +1,27 @@
+ --------------
+ Maven Doxia Sitetools Doc Renderer
+ --------------
+
+ ~~ 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
+
+Deprecation Notice
+
+ This Doxia Sitetools module is deprecated and will be removed in version
2.0.0.
