This is an automated email from the ASF dual-hosted git repository. msahyoun pushed a commit to branch asf-site in repository https://gitbox.apache.org/repos/asf/pdfbox-docs.git
The following commit(s) were added to refs/heads/asf-site by this push: new efa0c4c Site checkin for project Apache PDFBox Website efa0c4c is described below commit efa0c4c452c88de4568a4c694b8f08ee8d616c1b Author: Maruan Sahyoun <msahy...@linux.fritz.box> AuthorDate: Sun Nov 22 22:20:04 2020 +0100 Site checkin for project Apache PDFBox Website --- content/css/pygments-default.css | 61 ------- content/css/pygments-friendly.css | 61 ------- content/css/pygments-github.css | 61 ------- content/css/site.css | 334 -------------------------------------- content/css/styles.css.map | 1 - content/download.cgi | 6 - content/siteupdate.html | 18 +- 7 files changed, 17 insertions(+), 525 deletions(-) diff --git a/content/css/pygments-default.css b/content/css/pygments-default.css deleted file mode 100644 index 4e1f074..0000000 --- a/content/css/pygments-default.css +++ /dev/null @@ -1,61 +0,0 @@ -.hll { background-color: #ffffcc } -.c { color: #408080; font-style: italic } /* Comment */ -.err { border: 1px solid #FF0000 } /* Error */ -.k { color: #008000; font-weight: bold } /* Keyword */ -.o { color: #666666 } /* Operator */ -.cm { color: #408080; font-style: italic } /* Comment.Multiline */ -.cp { color: #BC7A00 } /* Comment.Preproc */ -.c1 { color: #408080; font-style: italic } /* Comment.Single */ -.cs { color: #408080; font-style: italic } /* Comment.Special */ -.gd { color: #A00000 } /* Generic.Deleted */ -.ge { font-style: italic } /* Generic.Emph */ -.gr { color: #FF0000 } /* Generic.Error */ -.gh { color: #000080; font-weight: bold } /* Generic.Heading */ -.gi { color: #00A000 } /* Generic.Inserted */ -.go { color: #888888 } /* Generic.Output */ -.gp { color: #000080; font-weight: bold } /* Generic.Prompt */ -.gs { font-weight: bold } /* Generic.Strong */ -.gu { color: #800080; font-weight: bold } /* Generic.Subheading */ -.gt { color: #0044DD } /* Generic.Traceback */ -.kc { color: #008000; font-weight: bold } /* Keyword.Constant */ -.kd { color: #008000; font-weight: bold } /* Keyword.Declaration */ -.kn { color: #008000; font-weight: bold } /* Keyword.Namespace */ -.kp { color: #008000 } /* Keyword.Pseudo */ -.kr { color: #008000; font-weight: bold } /* Keyword.Reserved */ -.kt { color: #B00040 } /* Keyword.Type */ -.m { color: #666666 } /* Literal.Number */ -.s { color: #BA2121 } /* Literal.String */ -.na { color: #7D9029 } /* Name.Attribute */ -.nb { color: #008000 } /* Name.Builtin */ -.nc { color: #0000FF; font-weight: bold } /* Name.Class */ -.no { color: #880000 } /* Name.Constant */ -.nd { color: #AA22FF } /* Name.Decorator */ -.ni { color: #999999; font-weight: bold } /* Name.Entity */ -.ne { color: #D2413A; font-weight: bold } /* Name.Exception */ -.nf { color: #0000FF } /* Name.Function */ -.nl { color: #A0A000 } /* Name.Label */ -.nn { color: #0000FF; font-weight: bold } /* Name.Namespace */ -.nt { color: #008000; font-weight: bold } /* Name.Tag */ -.nv { color: #19177C } /* Name.Variable */ -.ow { color: #AA22FF; font-weight: bold } /* Operator.Word */ -.w { color: #bbbbbb } /* Text.Whitespace */ -.mf { color: #666666 } /* Literal.Number.Float */ -.mh { color: #666666 } /* Literal.Number.Hex */ -.mi { color: #666666 } /* Literal.Number.Integer */ -.mo { color: #666666 } /* Literal.Number.Oct */ -.sb { color: #BA2121 } /* Literal.String.Backtick */ -.sc { color: #BA2121 } /* Literal.String.Char */ -.sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */ -.s2 { color: #BA2121 } /* Literal.String.Double */ -.se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */ -.sh { color: #BA2121 } /* Literal.String.Heredoc */ -.si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */ -.sx { color: #008000 } /* Literal.String.Other */ -.sr { color: #BB6688 } /* Literal.String.Regex */ -.s1 { color: #BA2121 } /* Literal.String.Single */ -.ss { color: #19177C } /* Literal.String.Symbol */ -.bp { color: #008000 } /* Name.Builtin.Pseudo */ -.vc { color: #19177C } /* Name.Variable.Class */ -.vg { color: #19177C } /* Name.Variable.Global */ -.vi { color: #19177C } /* Name.Variable.Instance */ -.il { color: #666666 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/content/css/pygments-friendly.css b/content/css/pygments-friendly.css deleted file mode 100644 index 61af14e..0000000 --- a/content/css/pygments-friendly.css +++ /dev/null @@ -1,61 +0,0 @@ -.hll { background-color: #ffffcc } -.c { color: #60a0b0; font-style: italic } /* Comment */ -.err { border: 1px solid #FF0000 } /* Error */ -.k { color: #007020; font-weight: bold } /* Keyword */ -.o { color: #666666 } /* Operator */ -.cm { color: #60a0b0; font-style: italic } /* Comment.Multiline */ -.cp { color: #007020 } /* Comment.Preproc */ -.c1 { color: #60a0b0; font-style: italic } /* Comment.Single */ -.cs { color: #60a0b0; background-color: #fff0f0 } /* Comment.Special */ -.gd { color: #A00000 } /* Generic.Deleted */ -.ge { font-style: italic } /* Generic.Emph */ -.gr { color: #FF0000 } /* Generic.Error */ -.gh { color: #000080; font-weight: bold } /* Generic.Heading */ -.gi { color: #00A000 } /* Generic.Inserted */ -.go { color: #888888 } /* Generic.Output */ -.gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */ -.gs { font-weight: bold } /* Generic.Strong */ -.gu { color: #800080; font-weight: bold } /* Generic.Subheading */ -.gt { color: #0044DD } /* Generic.Traceback */ -.kc { color: #007020; font-weight: bold } /* Keyword.Constant */ -.kd { color: #007020; font-weight: bold } /* Keyword.Declaration */ -.kn { color: #007020; font-weight: bold } /* Keyword.Namespace */ -.kp { color: #007020 } /* Keyword.Pseudo */ -.kr { color: #007020; font-weight: bold } /* Keyword.Reserved */ -.kt { color: #902000 } /* Keyword.Type */ -.m { color: #40a070 } /* Literal.Number */ -.s { color: #4070a0 } /* Literal.String */ -.na { color: #4070a0 } /* Name.Attribute */ -.nb { color: #007020 } /* Name.Builtin */ -.nc { color: #0e84b5; font-weight: bold } /* Name.Class */ -.no { color: #60add5 } /* Name.Constant */ -.nd { color: #555555; font-weight: bold } /* Name.Decorator */ -.ni { color: #d55537; font-weight: bold } /* Name.Entity */ -.ne { color: #007020 } /* Name.Exception */ -.nf { color: #06287e } /* Name.Function */ -.nl { color: #002070; font-weight: bold } /* Name.Label */ -.nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */ -.nt { color: #062873; font-weight: bold } /* Name.Tag */ -.nv { color: #bb60d5 } /* Name.Variable */ -.ow { color: #007020; font-weight: bold } /* Operator.Word */ -.w { color: #bbbbbb } /* Text.Whitespace */ -.mf { color: #40a070 } /* Literal.Number.Float */ -.mh { color: #40a070 } /* Literal.Number.Hex */ -.mi { color: #40a070 } /* Literal.Number.Integer */ -.mo { color: #40a070 } /* Literal.Number.Oct */ -.sb { color: #4070a0 } /* Literal.String.Backtick */ -.sc { color: #4070a0 } /* Literal.String.Char */ -.sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */ -.s2 { color: #4070a0 } /* Literal.String.Double */ -.se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */ -.sh { color: #4070a0 } /* Literal.String.Heredoc */ -.si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */ -.sx { color: #c65d09 } /* Literal.String.Other */ -.sr { color: #235388 } /* Literal.String.Regex */ -.s1 { color: #4070a0 } /* Literal.String.Single */ -.ss { color: #517918 } /* Literal.String.Symbol */ -.bp { color: #007020 } /* Name.Builtin.Pseudo */ -.vc { color: #bb60d5 } /* Name.Variable.Class */ -.vg { color: #bb60d5 } /* Name.Variable.Global */ -.vi { color: #bb60d5 } /* Name.Variable.Instance */ -.il { color: #40a070 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/content/css/pygments-github.css b/content/css/pygments-github.css deleted file mode 100644 index 67fe210..0000000 --- a/content/css/pygments-github.css +++ /dev/null @@ -1,61 +0,0 @@ -.hll { background-color: #ffffcc } -.c { color: #999988; font-style: italic } /* Comment */ -.err { color: #a61717; background-color: #e3d2d2 } /* Error */ -.k { color: #000000; font-weight: bold } /* Keyword */ -.o { color: #000000; font-weight: bold } /* Operator */ -.cm { color: #999988; font-style: italic } /* Comment.Multiline */ -.cp { color: #999999; font-weight: bold; font-style: italic } /* Comment.Preproc */ -.c1 { color: #999988; font-style: italic } /* Comment.Single */ -.cs { color: #999999; font-weight: bold; font-style: italic } /* Comment.Special */ -.gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */ -.ge { color: #000000; font-style: italic } /* Generic.Emph */ -.gr { color: #aa0000 } /* Generic.Error */ -.gh { color: #999999 } /* Generic.Heading */ -.gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */ -.go { color: #888888 } /* Generic.Output */ -.gp { color: #555555 } /* Generic.Prompt */ -.gs { font-weight: bold } /* Generic.Strong */ -.gu { color: #aaaaaa } /* Generic.Subheading */ -.gt { color: #aa0000 } /* Generic.Traceback */ -.kc { color: #000000; font-weight: bold } /* Keyword.Constant */ -.kd { color: #000000; font-weight: bold } /* Keyword.Declaration */ -.kn { color: #000000; font-weight: bold } /* Keyword.Namespace */ -.kp { color: #000000; font-weight: bold } /* Keyword.Pseudo */ -.kr { color: #000000; font-weight: bold } /* Keyword.Reserved */ -.kt { color: #445588; font-weight: bold } /* Keyword.Type */ -.m { color: #009999 } /* Literal.Number */ -.s { color: #d01040 } /* Literal.String */ -.na { color: #008080 } /* Name.Attribute */ -.nb { color: #0086B3 } /* Name.Builtin */ -.nc { color: #445588; font-weight: bold } /* Name.Class */ -.no { color: #008080 } /* Name.Constant */ -.nd { color: #3c5d5d; font-weight: bold } /* Name.Decorator */ -.ni { color: #800080 } /* Name.Entity */ -.ne { color: #990000; font-weight: bold } /* Name.Exception */ -.nf { color: #990000; font-weight: bold } /* Name.Function */ -.nl { color: #990000; font-weight: bold } /* Name.Label */ -.nn { color: #555555 } /* Name.Namespace */ -.nt { color: #000080 } /* Name.Tag */ -.nv { color: #008080 } /* Name.Variable */ -.ow { color: #000000; font-weight: bold } /* Operator.Word */ -.w { color: #bbbbbb } /* Text.Whitespace */ -.mf { color: #009999 } /* Literal.Number.Float */ -.mh { color: #009999 } /* Literal.Number.Hex */ -.mi { color: #009999 } /* Literal.Number.Integer */ -.mo { color: #009999 } /* Literal.Number.Oct */ -.sb { color: #d01040 } /* Literal.String.Backtick */ -.sc { color: #d01040 } /* Literal.String.Char */ -.sd { color: #d01040 } /* Literal.String.Doc */ -.s2 { color: #d01040 } /* Literal.String.Double */ -.se { color: #d01040 } /* Literal.String.Escape */ -.sh { color: #d01040 } /* Literal.String.Heredoc */ -.si { color: #d01040 } /* Literal.String.Interpol */ -.sx { color: #d01040 } /* Literal.String.Other */ -.sr { color: #009926 } /* Literal.String.Regex */ -.s1 { color: #d01040 } /* Literal.String.Single */ -.ss { color: #990073 } /* Literal.String.Symbol */ -.bp { color: #999999 } /* Name.Builtin.Pseudo */ -.vc { color: #008080 } /* Name.Variable.Class */ -.vg { color: #008080 } /* Name.Variable.Global */ -.vi { color: #008080 } /* Name.Variable.Instance */ -.il { color: #009999 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/content/css/site.css b/content/css/site.css deleted file mode 100644 index ed0b586..0000000 --- a/content/css/site.css +++ /dev/null @@ -1,334 +0,0 @@ -/* -* 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. -*/ - -/* - * The follwing rules are in addition to the base bootstrap css - * Some of the CSS is copied over from bootstrap as markdown, the primary - * format used to add content, doesn't allow to classes to the elements - */ - - /* 01 Import Fonts */ -@import url('https://fonts.googleapis.com/css?family=Open+Sans:300,400,600'); -@import url("https://fonts.googleapis.com/css?family=Inconsolata:400,700"); - -body { - font-family: "Open Sans", sans-serif; - font-size: 16px; - line-height: 1.5; - color: #161616; -} - -body > .container { - padding-top: 5rem; -} - -.main-header { - display: flex; - flex-direction: row; - justify-content: space-between; - padding: 0.5em 1em; - background-color: #34a5da; - border: none; - border-radius: 0; -} - -.main-header nav { - align-self: center; - margin: 0 0.8em 0 0; -} - -.main-header ul { - display: flex; - justify-content: space-between; - list-style-type: none; - width: 50%; -} - -.main-header li > a { - color: white; - font-weight: 600; - display: inline-block; - text-transform: uppercase; -} - -#menu-toggle {display: none;} -.label-toggle {display: none;} - - - -.navbar-default { - background-color: #34a5da; - border: none; - border-radius: 0; -} - -svg.pdfbox-brand-text, svg.pdfbox-brand-toolbox { - fill: white; -} - -.pdfbox-brand-toolbox { - height: 44px; - width: 48px; - vertical-align: middle; - margin-top: 2px; - margin-right: 0.4em -} - -.pdfbox-brand-text { - width: 80px; - height:46px; - vertical-align: middle; - margin-top: 2px; - margin-right: 0.4em -} - -/* Styling for the copyright footer */ -.footer { - height: 150px; - margin-top: 70px; - padding: 30px 0; - color: #e8e8e8; - border-top: 1px solid #e5e5e5; - background-color: rgb(38,21,15); -} - -/* - * Typography overwrites to bootstrap - */ - -/* headings */ -h1, h2, h3, h4, h5 { - color: #161616; -} - -h1 { - margin-top: 0; -} - -h3 { - margin-bottom: 16px; -} - -/* features list */ -h4 .oi { - position: relative; - top: 5px; - font-size: 24px; - margin-right: 8px; - color: #0088cc; -} - -h4 .open-iconic { - position: relative; - top: 0; - display: inline-block; - width: 24px; - height: 24px; - margin-right: 8px; - vertical-align: text-top; - fill: #0088cc; -} - -code, kbd, pre, samp { - font-family: 'Inconsolata',monospace; - font-size: 16px; - line-height: 1.2 -} - -pre.highlight, .highlight > pre { - background-color: inherit; - color: darkslategrey; - border: 0; - border-radius: 0; - border-left: 2px solid #5a5c5d; - padding-left: 3rem; - padding-top: 1.5rem; - padding-bottom: 1.5rem; -} - -code { - padding: 0; - background-color: inherit; - color: rgba(0,0,0); -} - -.alert { - border-radius: 0; -} -.alert-warning { - border-color: transparent; - border-left: 2px solid #8a6d3b; -} - -.alert-info { - border-color: transparent; - border-left: 2px solid #31708f; -} - -/* - * Default styling for the tables copied over from bootstrap - * to get basic styling for tables created through markdown - */ - - -table th, table td { - padding: 8px; - vertical-align: top; - border-top: 1px solid #ddd; -} - -table tr:nth-child(even) td, table tr.even td { - background: #f9f9f9; -} - -/* - * Completed items on the "ideas" list. - */ - -.complete { - text-decoration: line-through; - color: #bbb; - } - -/* - * Custom sidebar, replaces Bootstrap .nav with nested tree. - */ - -.sidebar ul { - padding-left: 20px; -} - -.sidebar, .sidebar > ul { - padding-left: 0; -} - -.sidebar li { - list-style: none; -} - -.sidebar li a { - display: block; - padding: .20em 15px; -} - -.sidebar li a:hover, .sidebar li a:focus { - text-decoration: none; - background-color: #eee; -} - -.sidebar-header { - font-size: 11px; - font-weight: bold; - line-height: 20px; - color: #999999; - text-transform: uppercase; -} - -.sidebar li + .sidebar-header { - margin-top: 8px; -} - -.sidebar .sidebar-node > a::before { - content: url("data:image/svg+xml, %3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 8 8'%3E%3Cpath fill='#0088cc' d='M1.5 0l-1.5 1.5 4 4 4-4-1.5-1.5-2.5 2.5-2.5-2.5z' transform='translate(0 1)' /%3E%3C/svg%3E"); - display:inline-block; - width:12px; - height:12px; - padding-right: 3px; -} - -.sidebar li.sidebar-node > a { - padding-left: 5px; -} - -.sidebar-node.collapsed > ul{ - display: none; -} - -.sidebar-node.collapsed > a::before { - content: url("data:image/svg+xml, %3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 8 8'%3E%3Cpath fill='#0088cc' d='M1.5 0l-1.5 1.5 2.5 2.5-2.5 2.5 1.5 1.5 4-4-4-4z' transform='translate(1)' /%3E%3C/svg%3E"); -} - -@keyframes flipdown { - 0% { - opacity: 0; - transform-origin: top center; - transform: rotateX(-90deg); - } - 5% { - opacity: 1; - } - 80% { - transform: rotateX(8deg); - } - 83% { - transform: rotateX(6deg); - } - 92% { - transform: rotateX(-3deg); - } - 100% { - transform-origin: top center; - transform: rotateX(0deg); - } -} - -/* - * Off Canvas - * -------------------------------------------------- - */ -@media screen and (max-width: 767px) { - .row-offcanvas { - position: relative; - -webkit-transition: all .25s ease-out; - -moz-transition: all .25s ease-out; - -o-transition: all .25s ease-out; - transition: all .25s ease-out; - } - - .row-offcanvas-right { - right: 0; - } - - .row-offcanvas-left { - left: 0; - } - - .row-offcanvas-right - .sidebar-offcanvas { - right: -50%; /* 6 columns */ - } - - .row-offcanvas-left - .sidebar-offcanvas { - left: -50%; /* 6 columns */ - } - - .row-offcanvas-right.active { - right: 50%; /* 6 columns */ - } - - .row-offcanvas-left.active { - left: 50%; /* 6 columns */ - margin-left: 0.5em; - } - - .sidebar-offcanvas { - position: absolute; - top: 0; - width: 50%; /* 6 columns */ - } -} \ No newline at end of file diff --git a/content/css/styles.css.map b/content/css/styles.css.map deleted file mode 100644 index 4036860..0000000 --- a/content/css/styles.css.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"sourceRoot":"","sources":["../../../content/_sass/site.scss","../../../content/_sass/documentation.scss","../../../content/_sass/accordion.scss"],"names":[],"mappings":"AAwBQ,uEACA,qEAER,KACI,mCACA,eACA,gBACA,WAGJ,gBACE,iBAGF,aACE,aACA,mBACA,8BACA,iBACA,yBACA,YACA,gBAGF,iBACG,kBACA,kBAGH,gBACE,aACA,8BACA,qBACA,UAGF,kBACE,WACA,gBACA,qBACA,yBAGF,0BACA,2BAIA,gBACE,yBACA,YACA,gBAGF,+CACI,UAGJ,sBACE,YACA,WACA,sBACA,eACA,kBAGF,mBACE,WACA,YACA,sBACA,eACA,kBAIF,QACI,aACA,gBACA,eACA [...] \ No newline at end of file diff --git a/content/download.cgi b/content/download.cgi deleted file mode 100755 index 06a42f2..0000000 --- a/content/download.cgi +++ /dev/null @@ -1,6 +0,0 @@ -#!/bin/sh -# Wrapper script around mirrors.cgi script -# (we must change to that directory in order for python to pick up the -# python includes correctly) -cd /www/www.apache.org/dyn/mirrors -/www/www.apache.org/dyn/mirrors/mirrors.cgi $* diff --git a/content/siteupdate.html b/content/siteupdate.html index f04b351..55daca9 100644 --- a/content/siteupdate.html +++ b/content/siteupdate.html @@ -192,7 +192,23 @@ $ npm run preview # to start the preview mode <p>To validate the generated website document go to the project root directory and run:</p> <pre><code>$ npm run checks </code></pre> -<p>This will validate the generated HTML for conformance to the specification as well as run accessibility tests. Testing is done using <a href="https://html-validate.org/">HTML-validate</a>.</p> +<h3 id="reuse-code-from-examples-in-the-documentation">Reuse code from examples in the documentation</h3> +<p>In order to reuse code from the examples project in the documentation the shortcode <code>codesnippet</code> can be used.</p> +<p>The shortcode expects two variables</p> +<ul> +<li>the <strong>relative</strong> path to the examples code such as <code>interactive/form/CreateCheckBox.java</code></li> +<li>the version to be used such as <code>trunk</code> or <code>2.0</code></li> +</ul> +<p>In addition - in order to be able to only put parts of the code into +the documentation the following comments can be added to the java code</p> +<pre><code>//DOC-START +... +//DOC-END +</code></pre> +<p>The DOC-START/DOC-END pair can be placed multiple times into the Java +code. Everything between these special comment lines will be added the +other content will be omitted. This will allow to skip license +header, import statements etc. to concentrate on the important bits.</p> <h3 id="publish-the-website-(for-comitters-only)">Publish the Website (For Comitters Only)</h3> <p>After you have done the local changes follow these steps to publish the content:</p> <p>Add the following server configuration in your ~/.m2/settings.xml file</p>