From cabe7d304f9e75ea1e40f1563854962132cb9a9a Mon Sep 17 00:00:00 2001 From: Michael Osipov Date: Sun, 28 Nov 2021 19:53:05 +0100 Subject: [PATCH] [DOXIASITETOOLS-236] Deprecate Doxia Sitetools Doc Renderer --- .../docrenderer/AbstractDocumentRenderer.java | 1 + .../maven/doxia/docrenderer/DocRenderer.java | 1 + .../doxia/docrenderer/DocumentRenderer.java | 1 + .../docrenderer/DocumentRendererContext.java | 1 + .../DocumentRendererException.java | 1 + .../docrenderer/pdf/AbstractPdfRenderer.java | 1 + .../doxia/docrenderer/pdf/PdfRenderer.java | 1 + .../docrenderer/pdf/fo/FoPdfRenderer.java | 7 ++--- .../pdf/itext/ITextPdfRenderer.java | 7 ++--- doxia-doc-renderer/src/site/apt/index.apt | 27 +++++++++++++++++++ 10 files changed, 42 insertions(+), 6 deletions(-) create mode 100644 doxia-doc-renderer/src/site/apt/index.apt 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 bc9f7e549..108cd2141 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 @@ * @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 6bc737a85..c953867c8 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 @@ * @author Vincent Siveton * @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 202230938..b8c9ec2d5 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 @@ * @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 4610637c8..c381727eb 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 @@ * @author Vincent Siveton * @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 b4a91607e..33b8da023 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 @@ * @author Vincent Siveton * @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 ade91b06b..503bf77e9 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 @@ * @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 6e961e2b9..7bb48adce 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 @@ * @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 e264f8375..b614384ce 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 @@ * @author ltheussl * @since 1.1 */ +@Deprecated @Component( role = PdfRenderer.class, hint = "fo" ) public class FoPdfRenderer extends AbstractPdfRenderer @@ -300,7 +301,7 @@ private void renderModules( String href, FoAggregateSink sink, DocumentTOCItem t { String doc = href + "." + extension; File source = new File( moduleBasedir, doc ); - + // Velocity file? if ( !source.exists() ) { @@ -314,12 +315,12 @@ private void renderModules( String href, FoAggregateSink sink, DocumentTOCItem t } 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 dd477430d..425940533 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 @@ * @author ltheussl * @since 1.1 */ +@Deprecated @Component( role = PdfRenderer.class, hint = "itext" ) public class ITextPdfRenderer extends AbstractPdfRenderer @@ -611,7 +612,7 @@ private List parseTOCFiles( File outputDirectory, DocumentModel documentMo { String doc = href + "." + extension; File source = new File( moduleBasedir, doc ); - + // Velocity file? if ( !source.exists() ) { @@ -625,7 +626,7 @@ private List parseTOCFiles( File outputDirectory, DocumentModel documentMo } source = new File( moduleBasedir, doc ); } - + if ( source.exists() ) { String outputITextName = doc.substring( 0, doc.lastIndexOf( '.' ) + 1 ) + "xml"; @@ -635,7 +636,7 @@ private List parseTOCFiles( File outputDirectory, DocumentModel documentMo { 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 000000000..82b38e2c9 --- /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.