Modified:
websites/production/commons/content/proper/commons-release-plugin/apidocs/src-html/org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html
==============================================================================
---
websites/production/commons/content/proper/commons-release-plugin/apidocs/src-html/org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html
(original)
+++
websites/production/commons/content/proper/commons-release-plugin/apidocs/src-html/org/apache/commons/release/plugin/velocity/ReadmeHtmlVelocityDelegate.html
Sat Apr 20 14:51:39 2024
@@ -1,173 +1,178 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
+<!-- Generated by javadoc (17) -->
<title>Source code</title>
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<meta name="description" content="source: package:
org.apache.commons.release.plugin.velocity, class: ReadmeHtmlVelocityDelegate">
+<meta name="generator" content="javadoc/SourceToHTMLConverter">
<link rel="stylesheet" type="text/css"
href="../../../../../../../stylesheet.css" title="Style">
</head>
-<body>
+<body class="source-page">
<main role="main">
-<div class="sourceContainer">
-<pre><span class="sourceLineNo">001</span><a id="line.1">/*</a>
-<span class="sourceLineNo">002</span><a id="line.2"> * Licensed to the Apache
Software Foundation (ASF) under one or more</a>
-<span class="sourceLineNo">003</span><a id="line.3"> * contributor license
agreements. See the NOTICE file distributed with</a>
-<span class="sourceLineNo">004</span><a id="line.4"> * this work for
additional information regarding copyright ownership.</a>
-<span class="sourceLineNo">005</span><a id="line.5"> * The ASF licenses this
file to You under the Apache License, Version 2.0</a>
-<span class="sourceLineNo">006</span><a id="line.6"> * (the "License"); you
may not use this file except in compliance with</a>
-<span class="sourceLineNo">007</span><a id="line.7"> * the License. You may
obtain a copy of the License at</a>
-<span class="sourceLineNo">008</span><a id="line.8"> *</a>
-<span class="sourceLineNo">009</span><a id="line.9"> *
http://www.apache.org/licenses/LICENSE-2.0</a>
-<span class="sourceLineNo">010</span><a id="line.10"> *</a>
-<span class="sourceLineNo">011</span><a id="line.11"> * Unless required by
applicable law or agreed to in writing, software</a>
-<span class="sourceLineNo">012</span><a id="line.12"> * distributed under the
License is distributed on an "AS IS" BASIS,</a>
-<span class="sourceLineNo">013</span><a id="line.13"> * WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied.</a>
-<span class="sourceLineNo">014</span><a id="line.14"> * See the License for
the specific language governing permissions and</a>
-<span class="sourceLineNo">015</span><a id="line.15"> * limitations under the
License.</a>
-<span class="sourceLineNo">016</span><a id="line.16"> */</a>
-<span class="sourceLineNo">017</span><a id="line.17">package
org.apache.commons.release.plugin.velocity;</a>
-<span class="sourceLineNo">018</span><a id="line.18"></a>
-<span class="sourceLineNo">019</span><a id="line.19">import java.io.Writer;</a>
-<span class="sourceLineNo">020</span><a id="line.20">import
org.apache.commons.lang3.StringUtils;</a>
-<span class="sourceLineNo">021</span><a id="line.21">import
org.apache.velocity.Template;</a>
-<span class="sourceLineNo">022</span><a id="line.22">import
org.apache.velocity.VelocityContext;</a>
-<span class="sourceLineNo">023</span><a id="line.23">import
org.apache.velocity.app.VelocityEngine;</a>
-<span class="sourceLineNo">024</span><a id="line.24">import
org.apache.velocity.runtime.RuntimeConstants;</a>
-<span class="sourceLineNo">025</span><a id="line.25">import
org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader;</a>
-<span class="sourceLineNo">026</span><a id="line.26"></a>
-<span class="sourceLineNo">027</span><a id="line.27">/**</a>
-<span class="sourceLineNo">028</span><a id="line.28"> * This class' purpose is
to generate the <code>README.html</code> that moves along with
the</a>
-<span class="sourceLineNo">029</span><a id="line.29"> * release for the sake
of downloading the release from the distribution area.</a>
-<span class="sourceLineNo">030</span><a id="line.30"> *</a>
-<span class="sourceLineNo">031</span><a id="line.31"> * @since 1.3</a>
-<span class="sourceLineNo">032</span><a id="line.32"> */</a>
-<span class="sourceLineNo">033</span><a id="line.33">public class
ReadmeHtmlVelocityDelegate {</a>
-<span class="sourceLineNo">034</span><a id="line.34"> /** The location of
the velocity template for this class. */</a>
-<span class="sourceLineNo">035</span><a id="line.35"> private static final
String TEMPLATE = "resources/org/apache/commons/release/plugin"</a>
-<span class="sourceLineNo">036</span><a id="line.36">
+ "/velocity/README.vm";</a>
-<span class="sourceLineNo">037</span><a id="line.37"> /** This is supposed
to represent the maven artifactId. */</a>
-<span class="sourceLineNo">038</span><a id="line.38"> private final String
artifactId;</a>
-<span class="sourceLineNo">039</span><a id="line.39"> /** This is supposed
to represent the maven version of the release. */</a>
-<span class="sourceLineNo">040</span><a id="line.40"> private final String
version;</a>
-<span class="sourceLineNo">041</span><a id="line.41"> /** The url of the
site that gets set into the <code>README.html</code>. */</a>
-<span class="sourceLineNo">042</span><a id="line.42"> private final String
siteUrl;</a>
-<span class="sourceLineNo">043</span><a id="line.43"></a>
-<span class="sourceLineNo">044</span><a id="line.44"> /**</a>
-<span class="sourceLineNo">045</span><a id="line.45"> * The private
constructor to be used by the {@link ReadmeHtmlVelocityDelegateBuilder}.</a>
-<span class="sourceLineNo">046</span><a id="line.46"> *</a>
-<span class="sourceLineNo">047</span><a id="line.47"> * @param artifactId
sets the {@link ReadmeHtmlVelocityDelegate#artifactId}.</a>
-<span class="sourceLineNo">048</span><a id="line.48"> * @param version
sets the {@link ReadmeHtmlVelocityDelegate#version}.</a>
-<span class="sourceLineNo">049</span><a id="line.49"> * @param siteUrl
sets the {@link ReadmeHtmlVelocityDelegate#siteUrl}.</a>
-<span class="sourceLineNo">050</span><a id="line.50"> */</a>
-<span class="sourceLineNo">051</span><a id="line.51"> private
ReadmeHtmlVelocityDelegate(final String artifactId, final String version, final
String siteUrl) {</a>
-<span class="sourceLineNo">052</span><a id="line.52"> this.artifactId =
artifactId;</a>
-<span class="sourceLineNo">053</span><a id="line.53"> this.version =
version;</a>
-<span class="sourceLineNo">054</span><a id="line.54"> this.siteUrl =
siteUrl;</a>
-<span class="sourceLineNo">055</span><a id="line.55"> }</a>
-<span class="sourceLineNo">056</span><a id="line.56"></a>
-<span class="sourceLineNo">057</span><a id="line.57"> /**</a>
-<span class="sourceLineNo">058</span><a id="line.58"> * Gets the {@link
ReadmeHtmlVelocityDelegateBuilder} for constructing the {@link
ReadmeHtmlVelocityDelegate}.</a>
-<span class="sourceLineNo">059</span><a id="line.59"> *</a>
-<span class="sourceLineNo">060</span><a id="line.60"> * @return the {@link
ReadmeHtmlVelocityDelegateBuilder}.</a>
-<span class="sourceLineNo">061</span><a id="line.61"> */</a>
-<span class="sourceLineNo">062</span><a id="line.62"> public static
ReadmeHtmlVelocityDelegateBuilder builder() {</a>
-<span class="sourceLineNo">063</span><a id="line.63"> return new
ReadmeHtmlVelocityDelegateBuilder();</a>
-<span class="sourceLineNo">064</span><a id="line.64"> }</a>
-<span class="sourceLineNo">065</span><a id="line.65"></a>
-<span class="sourceLineNo">066</span><a id="line.66"> /**</a>
-<span class="sourceLineNo">067</span><a id="line.67"> * Renders the
<code>README.vm</code> velocity template with the variables
constructed with the</a>
-<span class="sourceLineNo">068</span><a id="line.68"> * {@link
ReadmeHtmlVelocityDelegateBuilder}.</a>
-<span class="sourceLineNo">069</span><a id="line.69"> *</a>
-<span class="sourceLineNo">070</span><a id="line.70"> * @param writer is
the {@link Writer} to which we wish to render the
<code>README.vm</code> template.</a>
-<span class="sourceLineNo">071</span><a id="line.71"> * @return a
reference to the {@link Writer} passed in.</a>
-<span class="sourceLineNo">072</span><a id="line.72"> */</a>
-<span class="sourceLineNo">073</span><a id="line.73"> public Writer
render(final Writer writer) {</a>
-<span class="sourceLineNo">074</span><a id="line.74"> final
VelocityEngine ve = new VelocityEngine();</a>
-<span class="sourceLineNo">075</span><a id="line.75">
ve.setProperty(RuntimeConstants.RESOURCE_LOADER, "classpath");</a>
-<span class="sourceLineNo">076</span><a id="line.76">
ve.setProperty("classpath.resource.loader.class",
ClasspathResourceLoader.class.getName());</a>
-<span class="sourceLineNo">077</span><a id="line.77"> ve.init();</a>
-<span class="sourceLineNo">078</span><a id="line.78"> final Template
template = ve.getTemplate(TEMPLATE);</a>
-<span class="sourceLineNo">079</span><a id="line.79"> final String[]
splitArtifactId = artifactId.split("-");</a>
-<span class="sourceLineNo">080</span><a id="line.80"> final String
wordCommons = "commons";</a>
-<span class="sourceLineNo">081</span><a id="line.81"> String
artifactShortName = "";</a>
-<span class="sourceLineNo">082</span><a id="line.82"> if
(splitArtifactId.length > 1) {</a>
-<span class="sourceLineNo">083</span><a id="line.83">
artifactShortName = splitArtifactId[1];</a>
-<span class="sourceLineNo">084</span><a id="line.84"> } else if
(splitArtifactId.length == 1) {</a>
-<span class="sourceLineNo">085</span><a id="line.85">
artifactShortName = splitArtifactId[0];</a>
-<span class="sourceLineNo">086</span><a id="line.86"> }</a>
-<span class="sourceLineNo">087</span><a id="line.87"> // ".+\\d$"
matches a non-empty string that terminates in a digit {0-9}.</a>
-<span class="sourceLineNo">088</span><a id="line.88"> if
(artifactShortName.matches(".+\\d$")) {</a>
-<span class="sourceLineNo">089</span><a id="line.89">
artifactShortName = artifactShortName.substring(0, artifactShortName.length() -
1);</a>
-<span class="sourceLineNo">090</span><a id="line.90"> }</a>
-<span class="sourceLineNo">091</span><a id="line.91"> final String
artifactIdWithFirstLetterscapitalized =</a>
-<span class="sourceLineNo">092</span><a id="line.92">
StringUtils.capitalize(wordCommons)</a>
-<span class="sourceLineNo">093</span><a id="line.93"> +
"-"</a>
-<span class="sourceLineNo">094</span><a id="line.94"> +
artifactShortName.toUpperCase();</a>
-<span class="sourceLineNo">095</span><a id="line.95"> final
VelocityContext context = new VelocityContext();</a>
-<span class="sourceLineNo">096</span><a id="line.96">
context.internalPut("artifactIdWithFirstLetterscapitalized",
artifactIdWithFirstLetterscapitalized);</a>
-<span class="sourceLineNo">097</span><a id="line.97">
context.internalPut("artifactShortName", artifactShortName.toUpperCase());</a>
-<span class="sourceLineNo">098</span><a id="line.98">
context.internalPut("artifactId", artifactId);</a>
-<span class="sourceLineNo">099</span><a id="line.99">
context.internalPut("version", version);</a>
-<span class="sourceLineNo">100</span><a id="line.100">
context.internalPut("siteUrl", siteUrl);</a>
-<span class="sourceLineNo">101</span><a id="line.101">
template.merge(context, writer);</a>
-<span class="sourceLineNo">102</span><a id="line.102"> return
writer;</a>
-<span class="sourceLineNo">103</span><a id="line.103"> }</a>
-<span class="sourceLineNo">104</span><a id="line.104"></a>
-<span class="sourceLineNo">105</span><a id="line.105"> /**</a>
-<span class="sourceLineNo">106</span><a id="line.106"> * A builder class
for instantiation of the {@link ReadmeHtmlVelocityDelegate}.</a>
-<span class="sourceLineNo">107</span><a id="line.107"> */</a>
-<span class="sourceLineNo">108</span><a id="line.108"> public static class
ReadmeHtmlVelocityDelegateBuilder {</a>
-<span class="sourceLineNo">109</span><a id="line.109"> /** The maven
artifactId to use in the <code>README.vm</code> template. */</a>
-<span class="sourceLineNo">110</span><a id="line.110"> private String
artifactId;</a>
-<span class="sourceLineNo">111</span><a id="line.111"> /** The maven
version to use in the <code>README.vm</code> template. */</a>
-<span class="sourceLineNo">112</span><a id="line.112"> private String
version;</a>
-<span class="sourceLineNo">113</span><a id="line.113"> /** The site url
to use in the <code>README.vm</code> template. */</a>
-<span class="sourceLineNo">114</span><a id="line.114"> private String
siteUrl;</a>
-<span class="sourceLineNo">115</span><a id="line.115"></a>
-<span class="sourceLineNo">116</span><a id="line.116"> /**</a>
-<span class="sourceLineNo">117</span><a id="line.117"> * Private
constructor for using the builder through the {@link
ReadmeHtmlVelocityDelegate#builder()}</a>
-<span class="sourceLineNo">118</span><a id="line.118"> * method.</a>
-<span class="sourceLineNo">119</span><a id="line.119"> */</a>
-<span class="sourceLineNo">120</span><a id="line.120"> private
ReadmeHtmlVelocityDelegateBuilder() {</a>
-<span class="sourceLineNo">121</span><a id="line.121"> }</a>
-<span class="sourceLineNo">122</span><a id="line.122"></a>
-<span class="sourceLineNo">123</span><a id="line.123"> /**</a>
-<span class="sourceLineNo">124</span><a id="line.124"> * Adds the
artifactId to the {@link ReadmeHtmlVelocityDelegate}.</a>
-<span class="sourceLineNo">125</span><a id="line.125"> * @param
artifactId the {@link String} representing the maven artifactId.</a>
-<span class="sourceLineNo">126</span><a id="line.126"> * @return the
builder to continue building.</a>
-<span class="sourceLineNo">127</span><a id="line.127"> */</a>
-<span class="sourceLineNo">128</span><a id="line.128"> public
ReadmeHtmlVelocityDelegateBuilder withArtifactId(final String artifactId) {</a>
-<span class="sourceLineNo">129</span><a id="line.129">
this.artifactId = artifactId;</a>
-<span class="sourceLineNo">130</span><a id="line.130"> return
this;</a>
-<span class="sourceLineNo">131</span><a id="line.131"> }</a>
-<span class="sourceLineNo">132</span><a id="line.132"></a>
-<span class="sourceLineNo">133</span><a id="line.133"> /**</a>
-<span class="sourceLineNo">134</span><a id="line.134"> * Adds the
version to the {@link ReadmeHtmlVelocityDelegate}.</a>
-<span class="sourceLineNo">135</span><a id="line.135"> * @param
version the maven version.</a>
-<span class="sourceLineNo">136</span><a id="line.136"> * @return the
builder to continue building.</a>
-<span class="sourceLineNo">137</span><a id="line.137"> */</a>
-<span class="sourceLineNo">138</span><a id="line.138"> public
ReadmeHtmlVelocityDelegateBuilder withVersion(final String version) {</a>
-<span class="sourceLineNo">139</span><a id="line.139"> this.version
= version;</a>
-<span class="sourceLineNo">140</span><a id="line.140"> return
this;</a>
-<span class="sourceLineNo">141</span><a id="line.141"> }</a>
-<span class="sourceLineNo">142</span><a id="line.142"></a>
-<span class="sourceLineNo">143</span><a id="line.143"> /**</a>
-<span class="sourceLineNo">144</span><a id="line.144"> * Adds the
siteUrl to the {@link ReadmeHtmlVelocityDelegate}.</a>
-<span class="sourceLineNo">145</span><a id="line.145"> * @param
siteUrl the site url to be used in the <code>README.html</code></a>
-<span class="sourceLineNo">146</span><a id="line.146"> * @return the
builder to continue building.</a>
-<span class="sourceLineNo">147</span><a id="line.147"> */</a>
-<span class="sourceLineNo">148</span><a id="line.148"> public
ReadmeHtmlVelocityDelegateBuilder withSiteUrl(final String siteUrl) {</a>
-<span class="sourceLineNo">149</span><a id="line.149"> this.siteUrl
= siteUrl;</a>
-<span class="sourceLineNo">150</span><a id="line.150"> return
this;</a>
-<span class="sourceLineNo">151</span><a id="line.151"> }</a>
-<span class="sourceLineNo">152</span><a id="line.152"></a>
-<span class="sourceLineNo">153</span><a id="line.153"> /**</a>
-<span class="sourceLineNo">154</span><a id="line.154"> * Builds up the
{@link ReadmeHtmlVelocityDelegate} from the previously set parameters.</a>
-<span class="sourceLineNo">155</span><a id="line.155"> * @return a new
{@link ReadmeHtmlVelocityDelegate}.</a>
-<span class="sourceLineNo">156</span><a id="line.156"> */</a>
-<span class="sourceLineNo">157</span><a id="line.157"> public
ReadmeHtmlVelocityDelegate build() {</a>
-<span class="sourceLineNo">158</span><a id="line.158"> return new
ReadmeHtmlVelocityDelegate(this.artifactId, this.version, this.siteUrl);</a>
-<span class="sourceLineNo">159</span><a id="line.159"> }</a>
-<span class="sourceLineNo">160</span><a id="line.160"> }</a>
-<span class="sourceLineNo">161</span><a id="line.161">}</a>
+<div class="source-container">
+<pre><span class="source-line-no">001</span><span id="line-1">/*</span>
+<span class="source-line-no">002</span><span id="line-2"> * Licensed to the
Apache Software Foundation (ASF) under one or more</span>
+<span class="source-line-no">003</span><span id="line-3"> * contributor
license agreements. See the NOTICE file distributed with</span>
+<span class="source-line-no">004</span><span id="line-4"> * this work for
additional information regarding copyright ownership.</span>
+<span class="source-line-no">005</span><span id="line-5"> * The ASF licenses
this file to You under the Apache License, Version 2.0</span>
+<span class="source-line-no">006</span><span id="line-6"> * (the "License");
you may not use this file except in compliance with</span>
+<span class="source-line-no">007</span><span id="line-7"> * the License. You
may obtain a copy of the License at</span>
+<span class="source-line-no">008</span><span id="line-8"> *</span>
+<span class="source-line-no">009</span><span id="line-9"> *
http://www.apache.org/licenses/LICENSE-2.0</span>
+<span class="source-line-no">010</span><span id="line-10"> *</span>
+<span class="source-line-no">011</span><span id="line-11"> * Unless required
by applicable law or agreed to in writing, software</span>
+<span class="source-line-no">012</span><span id="line-12"> * distributed under
the License is distributed on an "AS IS" BASIS,</span>
+<span class="source-line-no">013</span><span id="line-13"> * WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
+<span class="source-line-no">014</span><span id="line-14"> * See the License
for the specific language governing permissions and</span>
+<span class="source-line-no">015</span><span id="line-15"> * limitations under
the License.</span>
+<span class="source-line-no">016</span><span id="line-16"> */</span>
+<span class="source-line-no">017</span><span id="line-17">package
org.apache.commons.release.plugin.velocity;</span>
+<span class="source-line-no">018</span><span id="line-18"></span>
+<span class="source-line-no">019</span><span id="line-19">import
java.io.Writer;</span>
+<span class="source-line-no">020</span><span id="line-20"></span>
+<span class="source-line-no">021</span><span id="line-21">import
org.apache.commons.lang3.StringUtils;</span>
+<span class="source-line-no">022</span><span id="line-22">import
org.apache.velocity.Template;</span>
+<span class="source-line-no">023</span><span id="line-23">import
org.apache.velocity.VelocityContext;</span>
+<span class="source-line-no">024</span><span id="line-24">import
org.apache.velocity.app.VelocityEngine;</span>
+<span class="source-line-no">025</span><span id="line-25">import
org.apache.velocity.runtime.RuntimeConstants;</span>
+<span class="source-line-no">026</span><span id="line-26">import
org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader;</span>
+<span class="source-line-no">027</span><span id="line-27"></span>
+<span class="source-line-no">028</span><span id="line-28">/**</span>
+<span class="source-line-no">029</span><span id="line-29"> * This class'
purpose is to generate the <code>README.html</code> that moves
along with the</span>
+<span class="source-line-no">030</span><span id="line-30"> * release for the
sake of downloading the release from the distribution area.</span>
+<span class="source-line-no">031</span><span id="line-31"> *</span>
+<span class="source-line-no">032</span><span id="line-32"> * @since 1.3</span>
+<span class="source-line-no">033</span><span id="line-33"> */</span>
+<span class="source-line-no">034</span><span id="line-34">public class
ReadmeHtmlVelocityDelegate {</span>
+<span class="source-line-no">035</span><span id="line-35"> /** The location
of the velocity template for this class. */</span>
+<span class="source-line-no">036</span><span id="line-36"> private static
final String TEMPLATE = "resources/org/apache/commons/release/plugin"</span>
+<span class="source-line-no">037</span><span id="line-37">
+ "/velocity/README.vm";</span>
+<span class="source-line-no">038</span><span id="line-38"> /** This is
supposed to represent the maven artifactId. */</span>
+<span class="source-line-no">039</span><span id="line-39"> private final
String artifactId;</span>
+<span class="source-line-no">040</span><span id="line-40"> /** This is
supposed to represent the maven version of the release. */</span>
+<span class="source-line-no">041</span><span id="line-41"> private final
String version;</span>
+<span class="source-line-no">042</span><span id="line-42"> /** The url of
the site that gets set into the <code>README.html</code>. */</span>
+<span class="source-line-no">043</span><span id="line-43"> private final
String siteUrl;</span>
+<span class="source-line-no">044</span><span id="line-44"></span>
+<span class="source-line-no">045</span><span id="line-45"> /**</span>
+<span class="source-line-no">046</span><span id="line-46"> * The private
constructor to be used by the {@link ReadmeHtmlVelocityDelegateBuilder}.</span>
+<span class="source-line-no">047</span><span id="line-47"> *</span>
+<span class="source-line-no">048</span><span id="line-48"> * @param
artifactId sets the {@link ReadmeHtmlVelocityDelegate#artifactId}.</span>
+<span class="source-line-no">049</span><span id="line-49"> * @param
version sets the {@link ReadmeHtmlVelocityDelegate#version}.</span>
+<span class="source-line-no">050</span><span id="line-50"> * @param
siteUrl sets the {@link ReadmeHtmlVelocityDelegate#siteUrl}.</span>
+<span class="source-line-no">051</span><span id="line-51"> */</span>
+<span class="source-line-no">052</span><span id="line-52"> private
ReadmeHtmlVelocityDelegate(final String artifactId, final String version, final
String siteUrl) {</span>
+<span class="source-line-no">053</span><span id="line-53">
this.artifactId = artifactId;</span>
+<span class="source-line-no">054</span><span id="line-54"> this.version
= version;</span>
+<span class="source-line-no">055</span><span id="line-55"> this.siteUrl
= siteUrl;</span>
+<span class="source-line-no">056</span><span id="line-56"> }</span>
+<span class="source-line-no">057</span><span id="line-57"></span>
+<span class="source-line-no">058</span><span id="line-58"> /**</span>
+<span class="source-line-no">059</span><span id="line-59"> * Gets the
{@link ReadmeHtmlVelocityDelegateBuilder} for constructing the {@link
ReadmeHtmlVelocityDelegate}.</span>
+<span class="source-line-no">060</span><span id="line-60"> *</span>
+<span class="source-line-no">061</span><span id="line-61"> * @return the
{@link ReadmeHtmlVelocityDelegateBuilder}.</span>
+<span class="source-line-no">062</span><span id="line-62"> */</span>
+<span class="source-line-no">063</span><span id="line-63"> public static
ReadmeHtmlVelocityDelegateBuilder builder() {</span>
+<span class="source-line-no">064</span><span id="line-64"> return new
ReadmeHtmlVelocityDelegateBuilder();</span>
+<span class="source-line-no">065</span><span id="line-65"> }</span>
+<span class="source-line-no">066</span><span id="line-66"></span>
+<span class="source-line-no">067</span><span id="line-67"> /**</span>
+<span class="source-line-no">068</span><span id="line-68"> * Renders the
<code>README.vm</code> velocity template with the variables
constructed with the</span>
+<span class="source-line-no">069</span><span id="line-69"> * {@link
ReadmeHtmlVelocityDelegateBuilder}.</span>
+<span class="source-line-no">070</span><span id="line-70"> *</span>
+<span class="source-line-no">071</span><span id="line-71"> * @param writer
is the {@link Writer} to which we wish to render the
<code>README.vm</code> template.</span>
+<span class="source-line-no">072</span><span id="line-72"> * @return a
reference to the {@link Writer} passed in.</span>
+<span class="source-line-no">073</span><span id="line-73"> */</span>
+<span class="source-line-no">074</span><span id="line-74"> public Writer
render(final Writer writer) {</span>
+<span class="source-line-no">075</span><span id="line-75"> final
VelocityEngine ve = new VelocityEngine();</span>
+<span class="source-line-no">076</span><span id="line-76">
ve.setProperty(RuntimeConstants.RESOURCE_LOADER, "classpath");</span>
+<span class="source-line-no">077</span><span id="line-77">
ve.setProperty("classpath.resource.loader.class",
ClasspathResourceLoader.class.getName());</span>
+<span class="source-line-no">078</span><span id="line-78">
ve.init();</span>
+<span class="source-line-no">079</span><span id="line-79"> final
Template template = ve.getTemplate(TEMPLATE);</span>
+<span class="source-line-no">080</span><span id="line-80"> final
String[] splitArtifactId = artifactId.split("-");</span>
+<span class="source-line-no">081</span><span id="line-81"> final String
wordCommons = "commons";</span>
+<span class="source-line-no">082</span><span id="line-82"> String
artifactShortName = "";</span>
+<span class="source-line-no">083</span><span id="line-83"> if
(splitArtifactId.length > 1) {</span>
+<span class="source-line-no">084</span><span id="line-84">
artifactShortName = splitArtifactId[1];</span>
+<span class="source-line-no">085</span><span id="line-85"> } else if
(splitArtifactId.length == 1) {</span>
+<span class="source-line-no">086</span><span id="line-86">
artifactShortName = splitArtifactId[0];</span>
+<span class="source-line-no">087</span><span id="line-87"> }</span>
+<span class="source-line-no">088</span><span id="line-88"> // ".+\\d$"
matches a non-empty string that terminates in a digit {0-9}.</span>
+<span class="source-line-no">089</span><span id="line-89"> if
(artifactShortName.matches(".+\\d$")) {</span>
+<span class="source-line-no">090</span><span id="line-90">
artifactShortName = artifactShortName.substring(0, artifactShortName.length() -
1);</span>
+<span class="source-line-no">091</span><span id="line-91"> }</span>
+<span class="source-line-no">092</span><span id="line-92"> final String
artifactIdWithFirstLetterscapitalized =</span>
+<span class="source-line-no">093</span><span id="line-93">
StringUtils.capitalize(wordCommons)</span>
+<span class="source-line-no">094</span><span id="line-94">
+ "-"</span>
+<span class="source-line-no">095</span><span id="line-95">
+ artifactShortName.toUpperCase();</span>
+<span class="source-line-no">096</span><span id="line-96"> final
VelocityContext context = new VelocityContext();</span>
+<span class="source-line-no">097</span><span id="line-97">
context.internalPut("artifactIdWithFirstLetterscapitalized",
artifactIdWithFirstLetterscapitalized);</span>
+<span class="source-line-no">098</span><span id="line-98">
context.internalPut("artifactShortName",
artifactShortName.toUpperCase());</span>
+<span class="source-line-no">099</span><span id="line-99">
context.internalPut("artifactId", artifactId);</span>
+<span class="source-line-no">100</span><span id="line-100">
context.internalPut("version", version);</span>
+<span class="source-line-no">101</span><span id="line-101">
context.internalPut("siteUrl", siteUrl);</span>
+<span class="source-line-no">102</span><span id="line-102">
template.merge(context, writer);</span>
+<span class="source-line-no">103</span><span id="line-103"> return
writer;</span>
+<span class="source-line-no">104</span><span id="line-104"> }</span>
+<span class="source-line-no">105</span><span id="line-105"></span>
+<span class="source-line-no">106</span><span id="line-106"> /**</span>
+<span class="source-line-no">107</span><span id="line-107"> * A builder
class for instantiation of the {@link ReadmeHtmlVelocityDelegate}.</span>
+<span class="source-line-no">108</span><span id="line-108"> */</span>
+<span class="source-line-no">109</span><span id="line-109"> public static
class ReadmeHtmlVelocityDelegateBuilder {</span>
+<span class="source-line-no">110</span><span id="line-110"> /** The
maven artifactId to use in the <code>README.vm</code> template.
*/</span>
+<span class="source-line-no">111</span><span id="line-111"> private
String artifactId;</span>
+<span class="source-line-no">112</span><span id="line-112"> /** The
maven version to use in the <code>README.vm</code> template.
*/</span>
+<span class="source-line-no">113</span><span id="line-113"> private
String version;</span>
+<span class="source-line-no">114</span><span id="line-114"> /** The
site url to use in the <code>README.vm</code> template. */</span>
+<span class="source-line-no">115</span><span id="line-115"> private
String siteUrl;</span>
+<span class="source-line-no">116</span><span id="line-116"></span>
+<span class="source-line-no">117</span><span id="line-117"> /**</span>
+<span class="source-line-no">118</span><span id="line-118"> * Private
constructor for using the builder through the {@link
ReadmeHtmlVelocityDelegate#builder()}</span>
+<span class="source-line-no">119</span><span id="line-119"> *
method.</span>
+<span class="source-line-no">120</span><span id="line-120"> */</span>
+<span class="source-line-no">121</span><span id="line-121"> private
ReadmeHtmlVelocityDelegateBuilder() {</span>
+<span class="source-line-no">122</span><span id="line-122"> }</span>
+<span class="source-line-no">123</span><span id="line-123"></span>
+<span class="source-line-no">124</span><span id="line-124"> /**</span>
+<span class="source-line-no">125</span><span id="line-125"> * Adds the
artifactId to the {@link ReadmeHtmlVelocityDelegate}.</span>
+<span class="source-line-no">126</span><span id="line-126"> * @param
artifactId the {@link String} representing the maven artifactId.</span>
+<span class="source-line-no">127</span><span id="line-127"> * @return
the builder to continue building.</span>
+<span class="source-line-no">128</span><span id="line-128"> */</span>
+<span class="source-line-no">129</span><span id="line-129"> public
ReadmeHtmlVelocityDelegateBuilder withArtifactId(final String artifactId)
{</span>
+<span class="source-line-no">130</span><span id="line-130">
this.artifactId = artifactId;</span>
+<span class="source-line-no">131</span><span id="line-131"> return
this;</span>
+<span class="source-line-no">132</span><span id="line-132"> }</span>
+<span class="source-line-no">133</span><span id="line-133"></span>
+<span class="source-line-no">134</span><span id="line-134"> /**</span>
+<span class="source-line-no">135</span><span id="line-135"> * Adds the
version to the {@link ReadmeHtmlVelocityDelegate}.</span>
+<span class="source-line-no">136</span><span id="line-136"> * @param
version the maven version.</span>
+<span class="source-line-no">137</span><span id="line-137"> * @return
the builder to continue building.</span>
+<span class="source-line-no">138</span><span id="line-138"> */</span>
+<span class="source-line-no">139</span><span id="line-139"> public
ReadmeHtmlVelocityDelegateBuilder withVersion(final String version) {</span>
+<span class="source-line-no">140</span><span id="line-140">
this.version = version;</span>
+<span class="source-line-no">141</span><span id="line-141"> return
this;</span>
+<span class="source-line-no">142</span><span id="line-142"> }</span>
+<span class="source-line-no">143</span><span id="line-143"></span>
+<span class="source-line-no">144</span><span id="line-144"> /**</span>
+<span class="source-line-no">145</span><span id="line-145"> * Adds the
siteUrl to the {@link ReadmeHtmlVelocityDelegate}.</span>
+<span class="source-line-no">146</span><span id="line-146"> * @param
siteUrl the site url to be used in the
<code>README.html</code></span>
+<span class="source-line-no">147</span><span id="line-147"> * @return
the builder to continue building.</span>
+<span class="source-line-no">148</span><span id="line-148"> */</span>
+<span class="source-line-no">149</span><span id="line-149"> public
ReadmeHtmlVelocityDelegateBuilder withSiteUrl(final String siteUrl) {</span>
+<span class="source-line-no">150</span><span id="line-150">
this.siteUrl = siteUrl;</span>
+<span class="source-line-no">151</span><span id="line-151"> return
this;</span>
+<span class="source-line-no">152</span><span id="line-152"> }</span>
+<span class="source-line-no">153</span><span id="line-153"></span>
+<span class="source-line-no">154</span><span id="line-154"> /**</span>
+<span class="source-line-no">155</span><span id="line-155"> * Builds
up the {@link ReadmeHtmlVelocityDelegate} from the previously set
parameters.</span>
+<span class="source-line-no">156</span><span id="line-156"> * @return
a new {@link ReadmeHtmlVelocityDelegate}.</span>
+<span class="source-line-no">157</span><span id="line-157"> */</span>
+<span class="source-line-no">158</span><span id="line-158"> public
ReadmeHtmlVelocityDelegate build() {</span>
+<span class="source-line-no">159</span><span id="line-159"> return
new ReadmeHtmlVelocityDelegate(this.artifactId, this.version,
this.siteUrl);</span>
+<span class="source-line-no">160</span><span id="line-160"> }</span>
+<span class="source-line-no">161</span><span id="line-161"> }</span>
+<span class="source-line-no">162</span><span id="line-162">}</span>
Modified:
websites/production/commons/content/proper/commons-release-plugin/apidocs/stylesheet.css
==============================================================================
---
websites/production/commons/content/proper/commons-release-plugin/apidocs/stylesheet.css
(original)
+++
websites/production/commons/content/proper/commons-release-plugin/apidocs/stylesheet.css
Sat Apr 20 14:51:39 2024
@@ -1,4 +1,4 @@
-/*
+/*
* Javadoc style sheet
*/
@@ -40,13 +40,6 @@ a[href]:hover, a[href]:focus {
a[name] {
color:#353833;
}
-a[name]:before, a[name]:target, a[id]:before, a[id]:target {
- content:"";
- display:inline-block;
- position:relative;
- padding-top:129px;
- margin-top:-129px;
-}
pre {
font-family:'DejaVu Sans Mono', monospace;
font-size:14px;
@@ -59,22 +52,24 @@ h2 {
}
h3 {
font-size:16px;
- font-style:italic;
}
h4 {
- font-size:13px;
+ font-size:15px;
}
h5 {
- font-size:12px;
+ font-size:14px;
}
h6 {
- font-size:11px;
+ font-size:13px;
}
ul {
list-style-type:disc;
}
code, tt {
font-family:'DejaVu Sans Mono', monospace;
+}
+:not(h1, h2, h3, h4, h5, h6) > code,
+:not(h1, h2, h3, h4, h5, h6) > tt {
font-size:14px;
padding-top:4px;
margin-top:8px;
@@ -85,7 +80,7 @@ dt code {
font-size:14px;
padding-top:4px;
}
-table tr td dt code {
+.summary-table dt code {
font-family:'DejaVu Sans Mono', monospace;
font-size:14px;
vertical-align:top;
@@ -94,7 +89,10 @@ table tr td dt code {
sup {
font-size:8px;
}
-
+button {
+ font-family: 'DejaVu Sans', Arial, Helvetica, sans-serif;
+ font-size: 14px;
+}
/*
* Styles for HTML generated by javadoc.
*
@@ -106,26 +104,19 @@ sup {
*/
.clear {
clear:both;
- height:0px;
+ height:0;
overflow:hidden;
}
-.aboutLanguage {
+.about-language {
float:right;
- padding:0px 21px;
+ padding:0 21px 8px 8px;
font-size:11px;
- z-index:200;
margin-top:-9px;
+ height:2.9em;
}
-.legalCopy {
+.legal-copy {
margin-left:.5em;
}
-.bar a, .bar a:link, .bar a:visited, .bar a:active {
- color:#FFFFFF;
- text-decoration:none;
-}
-.bar a:hover, .bar a:focus {
- color:#bb7a2a;
-}
.tab {
background-color:#0066FF;
color:#ffffff;
@@ -136,152 +127,124 @@ sup {
/*
* Styles for navigation bar.
*/
-.bar {
- background-color:#4D7A97;
- color:#FFFFFF;
- padding:.8em .5em .4em .8em;
- height:auto;/*height:1.8em;*/
- font-size:11px;
- margin:0;
+@media screen {
+ .flex-box {
+ position:fixed;
+ display:flex;
+ flex-direction:column;
+ height: 100%;
+ width: 100%;
+ }
+ .flex-header {
+ flex: 0 0 auto;
+ }
+ .flex-content {
+ flex: 1 1 auto;
+ overflow-y: auto;
+ }
}
-.navPadding {
- padding-top: 107px;
-}
-.fixedNav {
- position:fixed;
- width:100%;
- z-index:999;
- background-color:#ffffff;
-}
-.topNav {
+.top-nav {
background-color:#4D7A97;
color:#FFFFFF;
float:left;
padding:0;
width:100%;
clear:right;
- height:2.8em;
- padding-top:10px;
- overflow:hidden;
- font-size:12px;
-}
-.bottomNav {
- margin-top:10px;
- background-color:#4D7A97;
- color:#FFFFFF;
- float:left;
- padding:0;
- width:100%;
- clear:right;
- height:2.8em;
+ min-height:2.8em;
padding-top:10px;
overflow:hidden;
font-size:12px;
}
-.subNav {
+.sub-nav {
background-color:#dee3e9;
float:left;
width:100%;
overflow:hidden;
font-size:12px;
}
-.subNav div {
+.sub-nav div {
clear:left;
float:left;
padding:0 0 5px 6px;
text-transform:uppercase;
}
-ul.navList, ul.subNavList {
+.sub-nav .nav-list {
+ padding-top:5px;
+}
+ul.nav-list {
+ display:block;
+ margin:0 25px 0 0;
+ padding:0;
+}
+ul.sub-nav-list {
float:left;
margin:0 25px 0 0;
padding:0;
}
-ul.navList li{
+ul.nav-list li {
list-style:none;
float:left;
padding: 5px 6px;
text-transform:uppercase;
}
-ul.navListSearch {
+.sub-nav .nav-list-search {
float:right;
margin:0 0 0 0;
- padding:0;
-}
-ul.navListSearch li {
- list-style:none;
- float:right;
- padding: 5px 6px;
- text-transform:uppercase;
+ padding:5px 6px;
+ clear:none;
}
-ul.navListSearch li label {
+.nav-list-search label {
position:relative;
right:-16px;
}
-ul.subNavList li {
+ul.sub-nav-list li {
list-style:none;
float:left;
+ padding-top:10px;
}
-.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link,
.bottomNav a:active, .bottomNav a:visited {
+.top-nav a:link, .top-nav a:active, .top-nav a:visited {
color:#FFFFFF;
text-decoration:none;
text-transform:uppercase;
}
-.topNav a:hover, .bottomNav a:hover {
+.top-nav a:hover {
text-decoration:none;
color:#bb7a2a;
text-transform:uppercase;
}
-.navBarCell1Rev {
+.nav-bar-cell1-rev {
background-color:#F8981D;
color:#253441;
margin: auto 5px;
}
-.skipNav {
+.skip-nav {
position:absolute;
top:auto;
left:-9999px;
overflow:hidden;
}
/*
- * Styles for page header and footer.
+ * Hide navigation links and search box in print layout
*/
-.header, .footer {
- clear:both;
- margin:0 20px;
- padding:5px 0 0 0;
-}
-.indexNav {
- position:relative;
- font-size:12px;
- background-color:#dee3e9;
-}
-.indexNav ul {
- margin-top:0;
- padding:5px;
-}
-.indexNav ul li {
- display:inline;
- list-style-type:none;
- padding-right:10px;
- text-transform:uppercase;
-}
-.indexNav h1 {
- font-size:13px;
+@media print {
+ ul.nav-list, div.sub-nav {
+ display:none;
+ }
}
+/*
+ * Styles for page header and footer.
+ */
.title {
color:#2c4557;
margin:10px 0;
}
-.subTitle {
+.sub-title {
margin:5px 0 0 0;
}
.header ul {
margin:0 0 15px 0;
padding:0;
}
-.footer ul {
- margin:20px 0 5px 0;
-}
.header ul li, .footer ul li {
list-style:none;
font-size:13px;
@@ -289,69 +252,49 @@ ul.subNavList li {
/*
* Styles for headings.
*/
-div.details ul.blockList ul.blockList ul.blockList li.blockList h4,
div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 {
- background-color:#dee3e9;
- border:1px solid #d0d9e0;
- margin:0 0 6px -8px;
- padding:7px 5px;
+body.class-declaration-page .summary h2,
+body.class-declaration-page .details h2,
+body.class-use-page h2,
+body.module-declaration-page .block-list h2 {
+ font-style: italic;
+ padding:0;
+ margin:15px 0;
}
-ul.blockList ul.blockList ul.blockList li.blockList h3 {
+body.class-declaration-page .summary h3,
+body.class-declaration-page .details h3,
+body.class-declaration-page .summary .inherited-list h2 {
background-color:#dee3e9;
border:1px solid #d0d9e0;
margin:0 0 6px -8px;
padding:7px 5px;
}
-ul.blockList ul.blockList li.blockList h3 {
- padding:0;
- margin:15px 0;
-}
-ul.blockList li.blockList h2 {
- padding:0px 0 20px 0;
-}
/*
* Styles for page layout containers.
*/
-.contentContainer, .sourceContainer, .classUseContainer,
.serializedFormContainer, .constantValuesContainer,
-.allClassesContainer, .allPackagesContainer {
+main {
clear:both;
padding:10px 20px;
position:relative;
}
-.indexContainer {
- margin:10px;
- position:relative;
- font-size:12px;
-}
-.indexContainer h2 {
- font-size:13px;
- padding:0 0 3px 0;
-}
-.indexContainer ul {
- margin:0;
- padding:0;
-}
-.indexContainer ul li {
- list-style:none;
- padding-top:2px;
-}
-.contentContainer .description dl dt, .contentContainer .details dl dt,
.serializedFormContainer dl dt {
+dl.notes > dt {
+ font-family: 'DejaVu Sans', Arial, Helvetica, sans-serif;
font-size:12px;
font-weight:bold;
margin:10px 0 0 0;
color:#4E4E4E;
}
-.contentContainer .description dl dd, .contentContainer .details dl dd,
.serializedFormContainer dl dd {
- margin:5px 0 10px 0px;
+dl.notes > dd {
+ margin:5px 10px 10px 0;
font-size:14px;
font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif;
}
-.serializedFormContainer dl.nameValue dt {
+dl.name-value > dt {
margin-left:1px;
font-size:1.1em;
display:inline;
font-weight:bold;
}
-.serializedFormContainer dl.nameValue dd {
+dl.name-value > dd {
margin:0 0 0 1px;
font-size:1.1em;
display:inline;
@@ -366,70 +309,56 @@ ul.horizontal li {
display:inline;
font-size:0.9em;
}
-ul.inheritance {
+div.inheritance {
margin:0;
padding:0;
}
-ul.inheritance li {
- display:inline;
- list-style:none;
-}
-ul.inheritance li ul.inheritance {
- margin-left:15px;
- padding-left:15px;
- padding-top:1px;
+div.inheritance div.inheritance {
+ margin-left:2em;
}
-ul.blockList, ul.blockListLast {
+ul.block-list,
+ul.details-list,
+ul.member-list,
+ul.summary-list {
margin:10px 0 10px 0;
padding:0;
}
-ul.blockList li.blockList, ul.blockListLast li.blockList {
+ul.block-list > li,
+ul.details-list > li,
+ul.member-list > li,
+ul.summary-list > li {
list-style:none;
margin-bottom:15px;
line-height:1.4;
}
-ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast
li.blockList {
- padding:0px 20px 5px 10px;
- border:1px solid #ededed;
- background-color:#f8f8f8;
-}
-ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList
ul.blockListLast li.blockList {
- padding:0 0 5px 8px;
- background-color:#ffffff;
- border:none;
-}
-ul.blockList ul.blockList ul.blockList ul.blockList li.blockList {
- margin-left:0;
- padding-left:0;
- padding-bottom:15px;
- border:none;
-}
-ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast {
- list-style:none;
- border-bottom:none;
- padding-bottom:0;
-}
-table tr td dl, table tr td dl dt, table tr td dl dd {
+.summary-table dl, .summary-table dl dt, .summary-table dl dd {
margin-top:0;
margin-bottom:1px;
}
+ul.see-list, ul.see-list-long {
+ padding-left: 0;
+ list-style: none;
+}
+ul.see-list li {
+ display: inline;
+}
+ul.see-list li:not(:last-child):after,
+ul.see-list-long li:not(:last-child):after {
+ content: ", ";
+ white-space: pre-wrap;
+}
/*
* Styles for tables.
*/
-.overviewSummary, .memberSummary, .typeSummary, .useSummary,
.constantsSummary, .deprecatedSummary,
-.requiresSummary, .packagesSummary, .providesSummary, .usesSummary {
+.summary-table, .details-table {
width:100%;
border-spacing:0;
- border-left:1px solid #EEE;
- border-right:1px solid #EEE;
- border-bottom:1px solid #EEE;
-}
-.overviewSummary, .memberSummary, .requiresSummary, .packagesSummary,
.providesSummary, .usesSummary {
- padding:0px;
-}
-.overviewSummary caption, .memberSummary caption, .typeSummary caption,
-.useSummary caption, .constantsSummary caption, .deprecatedSummary caption,
-.requiresSummary caption, .packagesSummary caption, .providesSummary caption,
.usesSummary caption {
+ border-left:1px solid #EEE;
+ border-right:1px solid #EEE;
+ border-bottom:1px solid #EEE;
+ padding:0;
+}
+.caption {
position:relative;
text-align:left;
background-repeat:no-repeat;
@@ -437,38 +366,20 @@ table tr td dl, table tr td dl dt, table
font-weight:bold;
clear:none;
overflow:hidden;
- padding:0px;
+ padding:0;
padding-top:10px;
padding-left:1px;
- margin:0px;
+ margin:0;
white-space:pre;
}
-.constantsSummary caption a:link, .constantsSummary caption a:visited,
-.useSummary caption a:link, .useSummary caption a:visited {
+.caption a:link, .caption a:visited {
color:#1f389c;
}
-.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary
caption a:link,
-.deprecatedSummary caption a:link,
-.requiresSummary caption a:link, .packagesSummary caption a:link,
.providesSummary caption a:link,
-.usesSummary caption a:link,
-.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary
caption a:hover,
-.useSummary caption a:hover, .constantsSummary caption a:hover,
.deprecatedSummary caption a:hover,
-.requiresSummary caption a:hover, .packagesSummary caption a:hover,
.providesSummary caption a:hover,
-.usesSummary caption a:hover,
-.overviewSummary caption a:active, .memberSummary caption a:active,
.typeSummary caption a:active,
-.useSummary caption a:active, .constantsSummary caption a:active,
.deprecatedSummary caption a:active,
-.requiresSummary caption a:active, .packagesSummary caption a:active,
.providesSummary caption a:active,
-.usesSummary caption a:active,
-.overviewSummary caption a:visited, .memberSummary caption a:visited,
.typeSummary caption a:visited,
-.deprecatedSummary caption a:visited,
-.requiresSummary caption a:visited, .packagesSummary caption a:visited,
.providesSummary caption a:visited,
-.usesSummary caption a:visited {
+.caption a:hover,
+.caption a:active {
color:#FFFFFF;
}
-.overviewSummary caption span, .memberSummary caption span, .typeSummary
caption span,
-.useSummary caption span, .constantsSummary caption span, .deprecatedSummary
caption span,
-.requiresSummary caption span, .packagesSummary caption span, .providesSummary
caption span,
-.usesSummary caption span {
+.caption span {
white-space:nowrap;
padding-top:5px;
padding-left:12px;
@@ -480,168 +391,150 @@ table tr td dl, table tr td dl dt, table
border: none;
height:16px;
}
-.memberSummary caption span.activeTableTab span, .packagesSummary caption
span.activeTableTab span,
-.overviewSummary caption span.activeTableTab span, .typeSummary caption
span.activeTableTab span {
- white-space:nowrap;
- padding-top:5px;
- padding-left:12px;
- padding-right:12px;
- margin-right:3px;
- display:inline-block;
- float:left;
- background-color:#F8981D;
- height:16px;
-}
-.memberSummary caption span.tableTab span, .packagesSummary caption
span.tableTab span,
-.overviewSummary caption span.tableTab span, .typeSummary caption
span.tableTab span {
- white-space:nowrap;
- padding-top:5px;
- padding-left:12px;
- padding-right:12px;
- margin-right:3px;
- display:inline-block;
- float:left;
- background-color:#4D7A97;
- height:16px;
-}
-.memberSummary caption span.tableTab, .memberSummary caption
span.activeTableTab,
-.packagesSummary caption span.tableTab, .packagesSummary caption
span.activeTableTab,
-.overviewSummary caption span.tableTab, .overviewSummary caption
span.activeTableTab,
-.typeSummary caption span.tableTab, .typeSummary caption span.activeTableTab {
- padding-top:0px;
- padding-left:0px;
- padding-right:0px;
- background-image:none;
- float:none;
- display:inline;
-}
-.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd,
-.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd,
-.requiresSummary .tabEnd, .packagesSummary .tabEnd, .providesSummary .tabEnd,
.usesSummary .tabEnd {
- display:none;
- width:5px;
- position:relative;
- float:left;
- background-color:#F8981D;
-}
-.memberSummary .activeTableTab .tabEnd, .packagesSummary .activeTableTab
.tabEnd,
-.overviewSummary .activeTableTab .tabEnd, .typeSummary .activeTableTab .tabEnd
{
- display:none;
- width:5px;
- margin-right:3px;
- position:relative;
- float:left;
- background-color:#F8981D;
-}
-.memberSummary .tableTab .tabEnd, .packagesSummary .tableTab .tabEnd,
-.overviewSummary .tableTab .tabEnd, .typeSummary .tableTab .tabEnd {
- display:none;
- width:5px;
- margin-right:3px;
- position:relative;
- background-color:#4D7A97;
- float:left;
+div.table-tabs {
+ padding:10px 0 0 1px;
+ margin:0;
}
-.rowColor th, .altColor th {
- font-weight:normal;
+div.table-tabs > button {
+ border: none;
+ cursor: pointer;
+ padding: 5px 12px 7px 12px;
+ font-weight: bold;
+ margin-right: 3px;
+}
+div.table-tabs > button.active-table-tab {
+ background: #F8981D;
+ color: #253441;
+}
+div.table-tabs > button.table-tab {
+ background: #4D7A97;
+ color: #FFFFFF;
+}
+.two-column-summary {
+ display: grid;
+ grid-template-columns: minmax(15%, max-content) minmax(15%, auto);
+}
+.three-column-summary {
+ display: grid;
+ grid-template-columns: minmax(10%, max-content) minmax(15%, max-content)
minmax(15%, auto);
+}
+.four-column-summary {
+ display: grid;
+ grid-template-columns: minmax(10%, max-content) minmax(10%, max-content)
minmax(10%, max-content) minmax(10%, auto);
+}
+@media screen and (max-width: 600px) {
+ .two-column-summary {
+ display: grid;
+ grid-template-columns: 1fr;
+ }
+}
+@media screen and (max-width: 800px) {
+ .three-column-summary {
+ display: grid;
+ grid-template-columns: minmax(10%, max-content) minmax(25%, auto);
+ }
+ .three-column-summary .col-last {
+ grid-column-end: span 2;
+ }
+}
+@media screen and (max-width: 1000px) {
+ .four-column-summary {
+ display: grid;
+ grid-template-columns: minmax(15%, max-content) minmax(15%, auto);
+ }
}
-.overviewSummary td, .memberSummary td, .typeSummary td,
-.useSummary td, .constantsSummary td, .deprecatedSummary td,
-.requiresSummary td, .packagesSummary td, .providesSummary td, .usesSummary td
{
+.summary-table > div, .details-table > div {
text-align:left;
- padding:0px 0px 12px 10px;
+ padding: 8px 3px 3px 7px;
}
-th.colFirst, th.colSecond, th.colLast, th.colConstructorName,
th.colDeprecatedItemName, .useSummary th,
-.constantsSummary th, .packagesSummary th, td.colFirst, td.colSecond,
td.colLast, .useSummary td,
-.constantsSummary td {
+.col-first, .col-second, .col-last, .col-constructor-name,
.col-summary-item-name {
vertical-align:top;
- padding-right:0px;
+ padding-right:0;
padding-top:8px;
padding-bottom:3px;
}
-th.colFirst, th.colSecond, th.colLast, th.colConstructorName,
th.colDeprecatedItemName, .constantsSummary th,
-.packagesSummary th {
+.table-header {
background:#dee3e9;
- text-align:left;
- padding:8px 3px 3px 7px;
-}
-td.colFirst, th.colFirst {
- font-size:13px;
-}
-td.colSecond, th.colSecond, td.colLast, th.colConstructorName,
th.colDeprecatedItemName, th.colLast {
- font-size:13px;
+ font-weight: bold;
}
-.constantsSummary th, .packagesSummary th {
+.col-first, .col-first {
font-size:13px;
}
-.providesSummary th.colFirst, .providesSummary th.colLast, .providesSummary
td.colFirst,
-.providesSummary td.colLast {
- white-space:normal;
+.col-second, .col-second, .col-last, .col-constructor-name,
.col-summary-item-name, .col-last {
font-size:13px;
}
-.overviewSummary td.colFirst, .overviewSummary th.colFirst,
-.requiresSummary td.colFirst, .requiresSummary th.colFirst,
-.packagesSummary td.colFirst, .packagesSummary td.colSecond, .packagesSummary
th.colFirst, .packagesSummary th,
-.usesSummary td.colFirst, .usesSummary th.colFirst,
-.providesSummary td.colFirst, .providesSummary th.colFirst,
-.memberSummary td.colFirst, .memberSummary th.colFirst,
-.memberSummary td.colSecond, .memberSummary th.colSecond, .memberSummary
th.colConstructorName,
-.typeSummary td.colFirst, .typeSummary th.colFirst {
+.col-first, .col-second, .col-constructor-name {
vertical-align:top;
+ overflow: auto;
}
-.packagesSummary th.colLast, .packagesSummary td.colLast {
+.col-last {
white-space:normal;
}
-td.colFirst a:link, td.colFirst a:visited,
-td.colSecond a:link, td.colSecond a:visited,
-th.colFirst a:link, th.colFirst a:visited,
-th.colSecond a:link, th.colSecond a:visited,
-th.colConstructorName a:link, th.colConstructorName a:visited,
-th.colDeprecatedItemName a:link, th.colDeprecatedItemName a:visited,
-.constantValuesContainer td a:link, .constantValuesContainer td a:visited,
-.allClassesContainer td a:link, .allClassesContainer td a:visited,
-.allPackagesContainer td a:link, .allPackagesContainer td a:visited {
+.col-first a:link, .col-first a:visited,
+.col-second a:link, .col-second a:visited,
+.col-first a:link, .col-first a:visited,
+.col-second a:link, .col-second a:visited,
+.col-constructor-name a:link, .col-constructor-name a:visited,
+.col-summary-item-name a:link, .col-summary-item-name a:visited,
+.constant-values-container a:link, .constant-values-container a:visited,
+.all-classes-container a:link, .all-classes-container a:visited,
+.all-packages-container a:link, .all-packages-container a:visited {
font-weight:bold;
}
-.tableSubHeadingColor {
+.table-sub-heading-color {
background-color:#EEEEFF;
}
-.altColor, .altColor th {
+.even-row-color, .even-row-color .table-header {
background-color:#FFFFFF;
}
-.rowColor, .rowColor th {
+.odd-row-color, .odd-row-color .table-header {
background-color:#EEEEEF;
}
/*
* Styles for contents.
*/
-.description pre {
- margin-top:0;
-}
-.deprecatedContent {
+.deprecated-content {
margin:0;
padding:10px 0;
}
-.docSummary {
- padding:0;
-}
-ul.blockList ul.blockList ul.blockList li.blockList h3 {
- font-style:normal;
-}
div.block {
font-size:14px;
font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif;
}
-td.colLast div {
- padding-top:0px;
+.col-last div {
+ padding-top:0;
}
-td.colLast a {
+.col-last a {
padding-bottom:3px;
}
+.module-signature,
+.package-signature,
+.type-signature,
+.member-signature {
+ font-family:'DejaVu Sans Mono', monospace;
+ font-size:14px;
+ margin:14px 0;
+ white-space: pre-wrap;
+}
+.module-signature,
+.package-signature,
+.type-signature {
+ margin-top: 0;
+}
+.member-signature .type-parameters-long,
+.member-signature .parameters,
+.member-signature .exceptions {
+ display: inline-block;
+ vertical-align: top;
+ white-space: pre;
+}
+.member-signature .type-parameters {
+ white-space: normal;
+}
/*
* Styles for formatting effect.
*/
-.sourceLineNo {
+.source-line-no {
color:green;
padding:0 30px 0 0;
}
@@ -652,19 +545,18 @@ h1.hidden {
}
.block {
display:block;
- margin:3px 10px 2px 0px;
+ margin:0 10px 5px 0;
color:#474747;
}
-.deprecatedLabel, .descfrmTypeLabel, .implementationLabel, .memberNameLabel,
.memberNameLink,
-.moduleLabelInPackage, .moduleLabelInType, .overrideSpecifyLabel,
.packageLabelInType,
-.packageHierarchyLabel, .paramLabel, .returnLabel, .seeLabel, .simpleTagLabel,
-.throwsLabel, .typeNameLabel, .typeNameLink, .searchTagLink {
+.deprecated-label, .descfrm-type-label, .implementation-label,
.member-name-label, .member-name-link,
+.module-label-in-package, .module-label-in-type, .override-specify-label,
.package-label-in-type,
+.package-hierarchy-label, .type-name-label, .type-name-link, .search-tag-link,
.preview-label {
font-weight:bold;
}
-.deprecationComment, .emphasizedPhrase, .interfaceName {
+.deprecation-comment, .help-footnote, .preview-comment {
font-style:italic;
}
-.deprecationBlock {
+.deprecation-block {
font-size:14px;
font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif;
border-style:solid;
@@ -675,67 +567,19 @@ h1.hidden {
margin-right:10px;
display:inline-block;
}
-div.block div.deprecationComment, div.block div.block span.emphasizedPhrase,
-div.block div.block span.interfaceName {
- font-style:normal;
-}
-div.contentContainer ul.blockList li.blockList h2 {
- padding-bottom:0px;
-}
-/*
- * Styles for IFRAME.
- */
-.mainContainer {
- margin:0 auto;
- padding:0;
- height:100%;
- width:100%;
- position:fixed;
- top:0;
- left:0;
-}
-.leftContainer {
- height:100%;
- position:fixed;
- width:320px;
-}
-.leftTop {
- position:relative;
- float:left;
- width:315px;
- top:0;
- left:0;
- height:30%;
- border-right:6px solid #ccc;
- border-bottom:6px solid #ccc;
-}
-.leftBottom {
- position:relative;
- float:left;
- width:315px;
- bottom:0;
- left:0;
- height:70%;
- border-right:6px solid #ccc;
- border-top:1px solid #000;
-}
-.rightContainer {
- position:absolute;
- left:320px;
- top:0;
- bottom:0;
- height:100%;
- right:0;
- border-left:1px solid #000;
+.preview-block {
+ font-size:14px;
+ font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif;
+ border-style:solid;
+ border-width:thin;
+ border-radius:10px;
+ padding:10px;
+ margin-bottom:10px;
+ margin-right:10px;
+ display:inline-block;
}
-.rightIframe {
- margin:0;
- padding:0;
- height:100%;
- right:30px;
- width:100%;
- overflow:visible;
- margin-bottom:30px;
+div.block div.deprecation-comment {
+ font-style:normal;
}
/*
* Styles specific to HTML5 elements.
@@ -753,7 +597,7 @@ main, nav, header, footer, section {
background-color:#4D7A97;
color:#FFFFFF;
}
-.resultItem {
+.result-item {
font-size:13px;
}
.ui-autocomplete {
@@ -774,13 +618,13 @@ ul.ui-autocomplete li {
clear:both;
width:100%;
}
-.resultHighlight {
+.result-highlight {
font-weight:bold;
}
.ui-autocomplete .result-item {
font-size: inherit;
}
-#search {
+#search-input {
background-image:url('resources/glass.png');
background-size:13px;
background-repeat:no-repeat;
@@ -788,8 +632,9 @@ ul.ui-autocomplete li {
padding-left:20px;
position:relative;
right:-18px;
+ width:400px;
}
-#reset {
+#reset-button {
background-color: rgb(255,255,255);
background-image:url('resources/x.png');
background-position:center;
@@ -797,7 +642,7 @@ ul.ui-autocomplete li {
background-size:12px;
border:0 none;
width:16px;
- height:17px;
+ height:16px;
position:relative;
left:-4px;
top:-4px;
@@ -806,28 +651,85 @@ ul.ui-autocomplete li {
.watermark {
color:#545454;
}
-.searchTagDescResult {
+.search-tag-desc-result {
font-style:italic;
font-size:11px;
}
-.searchTagHolderResult {
+.search-tag-holder-result {
font-style:italic;
font-size:12px;
}
-.searchTagResult:before, .searchTagResult:target {
- color:red;
+.search-tag-result:target {
+ background-color:yellow;
}
-.moduleGraph span {
+.module-graph span {
display:none;
position:absolute;
}
-.moduleGraph:hover span {
+.module-graph:hover span {
display:block;
margin: -100px 0 0 100px;
z-index: 1;
}
-.methodSignature {
- white-space:normal;
+.inherited-list {
+ margin: 10px 0 10px 0;
+}
+section.class-description {
+ line-height: 1.4;
+}
+.summary section[class$="-summary"], .details section[class$="-details"],
+.class-uses .detail, .serialized-class-details {
+ padding: 0px 20px 5px 10px;
+ border: 1px solid #ededed;
+ background-color: #f8f8f8;
+}
+.inherited-list, section[class$="-details"] .detail {
+ padding:0 0 5px 8px;
+ background-color:#ffffff;
+ border:none;
+}
+.vertical-separator {
+ padding: 0 5px;
+}
+ul.help-section-list {
+ margin: 0;
+}
+ul.help-subtoc > li {
+ display: inline-block;
+ padding-right: 5px;
+ font-size: smaller;
+}
+ul.help-subtoc > li::before {
+ content: "\2022" ;
+ padding-right:2px;
+}
+span.help-note {
+ font-style: italic;
+}
+/*
+ * Indicator icon for external links.
+ */
+main a[href*="://"]::after {
+ content:"";
+ display:inline-block;
+ background-image:url('data:image/svg+xml; utf8, \
+ <svg xmlns="http://www.w3.org/2000/svg"; width="768" height="768">\
+ <path d="M584 664H104V184h216V80H0v688h688V448H584zM384 0l132 \
+ 132-240 240 120 120 240-240 132 132V0z" fill="%234a6782"/>\
+ </svg>');
+ background-size:100% 100%;
+ width:7px;
+ height:7px;
+ margin-left:2px;
+ margin-bottom:4px;
+}
+main a[href*="://"]:hover::after,
+main a[href*="://"]:focus::after {
+ background-image:url('data:image/svg+xml; utf8, \
+ <svg xmlns="http://www.w3.org/2000/svg"; width="768" height="768">\
+ <path d="M584 664H104V184h216V80H0v688h688V448H584zM384 0l132 \
+ 132-240 240 120 120 240-240 132 132V0z" fill="%23bb7a2a"/>\
+ </svg>');
}
/*
@@ -907,4 +809,61 @@ table.striped > tbody > tr > th, table.s
}
table.striped > tbody > tr > th {
font-weight: normal;
+}
+/**
+ * Tweak font sizes and paddings for small screens.
+ */
+@media screen and (max-width: 1050px) {
+ #search-input {
+ width: 300px;
+ }
+}
+@media screen and (max-width: 800px) {
+ #search-input {
+ width: 200px;
+ }
+ .top-nav,
+ .bottom-nav {
+ font-size: 11px;
+ padding-top: 6px;
+ }
+ .sub-nav {
+ font-size: 11px;
+ }
+ .about-language {
+ padding-right: 16px;
+ }
+ ul.nav-list li,
+ .sub-nav .nav-list-search {
+ padding: 6px;
+ }
+ ul.sub-nav-list li {
+ padding-top: 5px;
+ }
+ main {
+ padding: 10px;
+ }
+ .summary section[class$="-summary"], .details section[class$="-details"],
+ .class-uses .detail, .serialized-class-details {
+ padding: 0 8px 5px 8px;
+ }
+ body {
+ -webkit-text-size-adjust: none;
+ }
+}
+@media screen and (max-width: 500px) {
+ #search-input {
+ width: 150px;
+ }
+ .top-nav,
+ .bottom-nav {
+ font-size: 10px;
+ }
+ .sub-nav {
+ font-size: 10px;
+ }
+ .about-language {
+ font-size: 10px;
+ padding-right: 12px;
+ }
}
\ No newline at end of file
Added:
websites/production/commons/content/proper/commons-release-plugin/apidocs/tag-search-index.js
==============================================================================
---
websites/production/commons/content/proper/commons-release-plugin/apidocs/tag-search-index.js
(added)
+++
websites/production/commons/content/proper/commons-release-plugin/apidocs/tag-search-index.js
Sat Apr 20 14:51:39 2024
@@ -0,0 +1 @@
+tagSearchIndex = [{"l":"Constant Field
Values","h":"","u":"constant-values.html"}];updateSearchResults();
\ No newline at end of file
Modified:
websites/production/commons/content/proper/commons-release-plugin/apidocs/type-search-index.js
==============================================================================
---
websites/production/commons/content/proper/commons-release-plugin/apidocs/type-search-index.js
(original)
+++
websites/production/commons/content/proper/commons-release-plugin/apidocs/type-search-index.js
Sat Apr 20 14:51:39 2024
@@ -1 +1 @@
-typeSearchIndex = [{"l":"All
Classes","url":"allclasses-index.html"},{"p":"org.apache.commons.release.plugin.mojos","l":"CommonsDistributionDetachmentMojo"},{"p":"org.apache.commons.release.plugin.mojos","l":"CommonsDistributionStagingMojo"},{"p":"org.apache.commons.release.plugin.mojos","l":"CommonsSiteCompressionMojo"},{"p":"org.apache.commons.release.plugin.mojos","l":"CommonsStagingCleanupMojo"},{"p":"org.apache.commons.release.plugin.velocity","l":"HeaderHtmlVelocityDelegate"},{"p":"org.apache.commons.release.plugin.velocity","l":"HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder"},{"p":"org.apache.commons.release.plugin.velocity","l":"ReadmeHtmlVelocityDelegate"},{"p":"org.apache.commons.release.plugin.velocity","l":"ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder"},{"p":"org.apache.commons.release.plugin","l":"SharedFunctions"}]
\ No newline at end of file
+typeSearchIndex = [{"l":"All Classes and
Interfaces","u":"allclasses-index.html"},{"p":"org.apache.commons.release.plugin.mojos","l":"CommonsDistributionDetachmentMojo"},{"p":"org.apache.commons.release.plugin.mojos","l":"CommonsDistributionStagingMojo"},{"p":"org.apache.commons.release.plugin.mojos","l":"CommonsSiteCompressionMojo"},{"p":"org.apache.commons.release.plugin.mojos","l":"CommonsStagingCleanupMojo"},{"p":"org.apache.commons.release.plugin.velocity","l":"HeaderHtmlVelocityDelegate"},{"p":"org.apache.commons.release.plugin.velocity","l":"HeaderHtmlVelocityDelegate.HeaderHtmlVelocityDelegateBuilder"},{"p":"org.apache.commons.release.plugin.velocity","l":"ReadmeHtmlVelocityDelegate"},{"p":"org.apache.commons.release.plugin.velocity","l":"ReadmeHtmlVelocityDelegate.ReadmeHtmlVelocityDelegateBuilder"},{"p":"org.apache.commons.release.plugin","l":"SharedFunctions"}];updateSearchResults();
\ No newline at end of file
