You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@creadur.apache.org by po...@apache.org on 2024/10/20 22:03:12 UTC
(creadur-rat) 03/03: RAT-444: Fix broken links and try to render new page elements
This is an automated email from the ASF dual-hosted git repository.
pottlinger pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/creadur-rat.git
commit 380d0c76e563f9faa1d2ac816ea7bdcd2d7189f9
Author: P. Ottlinger <po...@apache.org>
AuthorDate: Mon Oct 21 00:03:03 2024 +0200
RAT-444: Fix broken links and try to render new page elements
---
apache-rat/src/site/apt/default_licenses.apt.vm | 8 ++++----
apache-rat/src/site/apt/name_xref.apt.vm | 10 +++++-----
apache-rat/src/site/apt/xsd.apt.vm | 6 +++---
src/site/apt/license_def.apt.vm | 2 +-
src/site/apt/matcher_def.apt.vm | 4 +++-
5 files changed, 16 insertions(+), 14 deletions(-)
diff --git a/apache-rat/src/site/apt/default_licenses.apt.vm b/apache-rat/src/site/apt/default_licenses.apt.vm
index 5329ce1c..4b0f8999 100644
--- a/apache-rat/src/site/apt/default_licenses.apt.vm
+++ b/apache-rat/src/site/apt/default_licenses.apt.vm
@@ -15,11 +15,11 @@
~~ limitations under the License.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
---------------------------
-Option Name Cross Reference
---------------------------
+ ------------------------------
+ Default Licenses and Matchers
+ ------------------------------
-The following lists the Licenses, and Matchers that are available by default.
+ The following lists the Licenses, and Matchers that are available by default.
+------------------------------------------+
#include( "default_licenses.txt" )
diff --git a/apache-rat/src/site/apt/name_xref.apt.vm b/apache-rat/src/site/apt/name_xref.apt.vm
index 94eb6597..5a821542 100644
--- a/apache-rat/src/site/apt/name_xref.apt.vm
+++ b/apache-rat/src/site/apt/name_xref.apt.vm
@@ -15,12 +15,12 @@
~~ limitations under the License.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
---------------------------
-Option Name Cross Reference
---------------------------
+ ---------------
+ Option Overview
+ ---------------
-The following lists the options that are available in all clients.
+ The following lists the options that are available in all clients.
+------------------------------------------+
#include( "name_xref.txt" )
-+------------------------------------------+
++------------------------------------------+
\ No newline at end of file
diff --git a/apache-rat/src/site/apt/xsd.apt.vm b/apache-rat/src/site/apt/xsd.apt.vm
index cdb115d6..adb1471d 100644
--- a/apache-rat/src/site/apt/xsd.apt.vm
+++ b/apache-rat/src/site/apt/xsd.apt.vm
@@ -15,9 +15,9 @@
~~ limitations under the License.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
---------------------------
-XML Schema Definition
---------------------------
+ ------------------------------------
+ Configuration XML Schema Definition
+ ------------------------------------
There is a standard {{{./rat.xsd}Rat XSD file}} that describes the configuration file options and can be used to verify
any configuration file that only depends on the matchers shipped with Rat.
diff --git a/src/site/apt/license_def.apt.vm b/src/site/apt/license_def.apt.vm
index 563ad560..fddf01d4 100644
--- a/src/site/apt/license_def.apt.vm
+++ b/src/site/apt/license_def.apt.vm
@@ -29,7 +29,7 @@ How to define licenses in Apache Rat
scope of this document. In this document we will address how to define licenses in the default XML format.
The XML document has a root node named "rat-config" which comprises 4 major sections: "Families",
- "Licenses", "Approved" and "Matchers". There is an {{{./apache-rat/rat.xsd}}XSD} that can be used to validate
+ "Licenses", "Approved" and "Matchers". There is an {{{./apache-rat/rat.xsd}XSD}} that can be used to validate
configuration files. If custom matchers have been added it will be necessary to {{{./apache-rat/xsd.html}generate a
new XSD file}} that includes the new matchers.
diff --git a/src/site/apt/matcher_def.apt.vm b/src/site/apt/matcher_def.apt.vm
index 8f1ebf2b..19b9f40e 100644
--- a/src/site/apt/matcher_def.apt.vm
+++ b/src/site/apt/matcher_def.apt.vm
@@ -48,7 +48,9 @@ import org.apache.rat.analysis.matchers.AbstractHeaderMatcher;
import org.apache.rat.config.parameters.Component;
import org.apache.rat.config.parameters.ConfigComponent;
-@ConfigComponent(type = Component.Type.MATCHER, name = "QSC", desc = "Reports if the 'Quality, speed and cost, pick any two' rule is violated")
+@ConfigComponent(type = Component.Type.MATCHER,
+ name = "QSC",
+ desc = "Reports if the 'Quality, speed and cost, pick any two' rule is violated")
public class QSCMatcher extends AbstractHeaderMatcher {
public QSCMatcher(String id) {