This is an automated email from the ASF dual-hosted git repository.
cdutz pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/incubator-training.git
The following commit(s) were added to refs/heads/develop by this push:
new 20ba32a chore: Updated the documentation and added the apache.css file
20ba32a is described below
commit 20ba32aca0b2db0ae15cc8b285c5bb4e8287ea07
Author: Christofer Dutz <[email protected]>
AuthorDate: Wed Sep 11 17:24:07 2024 +0200
chore: Updated the documentation and added the apache.css file
---
.../main/resources/archetype-resources/README.md | 20 +-
.../archetype-resources/src/main/theme/apache.css | 381 +++++++++++++++++++++
2 files changed, 388 insertions(+), 13 deletions(-)
diff --git
a/tools/content-archetype/src/main/resources/archetype-resources/README.md
b/tools/content-archetype/src/main/resources/archetype-resources/README.md
index e1eaff5..f688aa7 100644
--- a/tools/content-archetype/src/main/resources/archetype-resources/README.md
+++ b/tools/content-archetype/src/main/resources/archetype-resources/README.md
@@ -20,28 +20,22 @@
# Presentation with Reveal.JS and AsciiDoctor
Remarks:
-- Currently it seems as if the system can't detect the 'docinfo' files, so we
have to replace the `document.html.slim` file from `asciidoctor-reveal.js` with
an updated one, that adds some additional js and css references. This template
is located in `libs/docinfo-hack`.
- In order to use the preview of the IntelliJ asciidoctor plugin, you need to
set an attribute in the plugin settings: `imagesdir` = `../resources/images`
-- Even if it is possible to run the presentation directly from the
`generated-slides` directory, some JavaScript extensions don't work in this
case. Therefore it is required to run the presentation from a local webserver.
- In order to generate the diagrams, GraphVIS needs to be installed locally.
Get it from: http://www.graphviz.org/
-- The template is adjusted to use the codecentric font `Panton`, so be sure to
have that installed on your presentation machine.
-- Any css adjustments can go to `src/main/theme/cc.css` as this is
automatically embedded into the themes directory.
+- Any css adjustments can go to `src/main/theme/apache.css` as this is
automatically embedded into the themes directory.
## Building the presentation
By running the following command, you can generate the presentation:
- mvn clean package
+ mvn package
## Running the presentation
-In order to start a local web server serving the presentation, execute the
following command:
+In order to show the presentation, go into the `target` directory and look for
a directory named {artifactId}-{version}.
+This direcotry contains an `index.html` file.
- mvn jetty:run-exploded
-
-As soon as that's done, just point your browser to:
-
- http://localhost:8080/
+Simply open this in any browser of your choice.
## Generating PDF versions
@@ -49,9 +43,9 @@ In order to generate a PDF version of the presentation just
add `?print-pdf` to
The following link should do the trick:
- http://localhost:8080/?print-pdf
+ http:///{someFilePath}/?print-pdf
-As soon as that's loaded, just use the normal `print` functionality of the
browser and `print as PDF`.
+As soon as that's loaded, the presentation will look a bit odd. Now just use
the normal `print` functionality of the browser and select `print as PDF`.
## Installing third party software:
diff --git
a/tools/content-archetype/src/main/resources/archetype-resources/src/main/theme/apache.css
b/tools/content-archetype/src/main/resources/archetype-resources/src/main/theme/apache.css
new file mode 100644
index 0000000..89536b2
--- /dev/null
+++
b/tools/content-archetype/src/main/resources/archetype-resources/src/main/theme/apache.css
@@ -0,0 +1,381 @@
+/*
+ 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
+
+ https://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.
+*/
+
+section.has-light-background, section.has-light-background h1,
section.has-light-background h2, section.has-light-background h3,
section.has-light-background h4, section.has-light-background h5,
section.has-light-background h6 {
+ color: #fff; }
+
+/*********************************************
+ * GLOBAL STYLES
+ *********************************************/
+body {
+/* TODO: Fix this */
+/* background-image: url("../../../images/background.jpg");*/
+ background-repeat: no-repeat;
+ background-size: cover;
+ background-color: #fff; }
+
+.reveal {
+ font-family: Panton-Regular, Helvetica, sans-serif;
+ font-size: 34px;
+ font-weight: normal;
+ color: #000; }
+
+::selection {
+ color: #000;
+ background: #bee4fd;
+ text-shadow: none; }
+
+.reveal .slides > section, .reveal .slides > section > section {
+ line-height: 1.3;
+ font-weight: inherit; }
+
+/*********************************************
+ * HEADERS
+ *********************************************/
+.reveal h1, .reveal h2, .reveal h3, .reveal h4, .reveal h5, .reveal h6 {
+ margin: 0 0 20px 0;
+ color: #000;
+ font-family: Panton-Regular, Helvetica, sans-serif;
+ font-weight: 600;
+ line-height: 1.2;
+ letter-spacing: normal;
+ text-transform: uppercase;
+ text-shadow: none;
+ word-wrap: break-word; }
+
+.reveal h1 {
+ font-size: 2.5em; }
+
+.reveal h2 {
+ font-size: 1.6em; }
+
+.reveal h3 {
+ font-size: 1.3em; }
+
+.reveal h4 {
+ font-size: 1em; }
+
+.reveal h1 {
+ text-shadow: none; }
+
+/*********************************************
+ * OTHER
+ *********************************************/
+.reveal p {
+ margin: 20px 0;
+ line-height: 1.3; }
+
+/* Ensure certain elements are never larger than the slide itself */
+.reveal img, .reveal video, .reveal iframe {
+ max-width: 95%;
+ max-height: 95%; }
+
+.reveal strong, .reveal b {
+ font-weight: bold; }
+
+.reveal em {
+ font-style: italic; }
+
+.reveal ol, .reveal dl, .reveal ul {
+ display: inline-block;
+ text-align: left;
+ margin: 0 0 0 1em; }
+
+.reveal ol {
+ list-style-type: decimal; }
+
+.reveal ul {
+ list-style-type: disc; }
+
+.reveal ul ul {
+ list-style-type: square; }
+
+.reveal ul ul ul {
+ list-style-type: circle; }
+
+.reveal ul ul, .reveal ul ol, .reveal ol ol, .reveal ol ul {
+ display: block;
+ margin-left: 40px; }
+
+.reveal dt {
+ font-weight: bold; }
+
+.reveal dd {
+ margin-left: 40px; }
+
+.reveal q, .reveal blockquote {
+ quotes: none; }
+
+.reveal blockquote {
+ display: block;
+ position: relative;
+ width: 70%;
+ margin: 20px auto;
+ padding: 5px;
+ font-style: italic;
+ background: rgba(255, 255, 255, 0.05);
+ box-shadow: 0 0 2px rgba(0, 0, 0, 0.2); }
+
+.reveal blockquote p:first-child, .reveal blockquote p:last-child {
+ display: inline-block; }
+
+.reveal q {
+ font-style: italic; }
+
+.reveal pre {
+ display: block;
+ position: relative;
+ width: 90%;
+ margin: 20px auto;
+ text-align: left;
+ font-size: 0.55em;
+ font-family: monospace;
+ line-height: 1.2em;
+ word-wrap: break-word;
+ box-shadow: 0 0 6px rgba(0, 0, 0, 0.3); }
+
+.reveal code {
+ font-family: monospace; }
+
+.reveal pre code {
+ display: block;
+ padding: 5px;
+ overflow: auto;
+ max-height: 400px;
+ word-wrap: normal;
+ background: #3F3F3F;
+ color: #DCDCDC; }
+
+.reveal table {
+ margin: auto;
+ border-collapse: collapse;
+ border-spacing: 0; }
+
+.reveal table th {
+ font-weight: bold; }
+
+.reveal table th, .reveal table td {
+ text-align: left;
+ padding: 0.2em 0.5em 0.2em 0.5em;
+ border-bottom: 1px solid; }
+
+.reveal table th[align="center"], .reveal table td[align="center"] {
+ text-align: center; }
+
+.reveal table th[align="right"], .reveal table td[align="right"] {
+ text-align: right; }
+
+.reveal table tr:last-child td {
+ border-bottom: none; }
+
+.reveal sup {
+ vertical-align: super; }
+
+.reveal sub {
+ vertical-align: sub; }
+
+.reveal small {
+ display: inline-block;
+ font-size: 0.6em;
+ line-height: 1.2em;
+ vertical-align: top; }
+
+.reveal small * {
+ vertical-align: top; }
+
+/*********************************************
+ * LINKS
+ *********************************************/
+.reveal a {
+ color: #42affa;
+ text-decoration: none;
+ -webkit-transition: color 0.15s ease;
+ -moz-transition: color 0.15s ease;
+ transition: color 0.15s ease; }
+
+.reveal a:hover {
+ color: #8dcffc;
+ text-shadow: none;
+ border: none; }
+
+.reveal .roll span:after {
+ color: #fff;
+ background: #068ee9; }
+
+/*********************************************
+ * IMAGES
+ *********************************************/
+.reveal section img {
+ margin: 15px 0;
+ /*background: rgba(255, 255, 255, 0.12);*/
+ /*border: 4px solid #fff;*/
+ /*box-shadow: 0 0 10px rgba(0, 0, 0, 0.15);*/ }
+
+.reveal a img {
+ -webkit-transition: all 0.15s linear;
+ -moz-transition: all 0.15s linear;
+ transition: all 0.15s linear; }
+
+.reveal a:hover img {
+ background: rgba(255, 255, 255, 0.2);
+ border-color: #42affa;
+ box-shadow: 0 0 20px rgba(0, 0, 0, 0.55); }
+
+/*********************************************
+ * NAVIGATION CONTROLS
+ *********************************************/
+.reveal .controls div.navigate-left, .reveal .controls
div.navigate-left.enabled {
+ border-right-color: #42affa; }
+
+.reveal .controls div.navigate-right, .reveal .controls
div.navigate-right.enabled {
+ border-left-color: #42affa; }
+
+.reveal .controls div.navigate-up, .reveal .controls div.navigate-up.enabled {
+ border-bottom-color: #42affa; }
+
+.reveal .controls div.navigate-down, .reveal .controls
div.navigate-down.enabled {
+ border-top-color: #42affa; }
+
+.reveal .controls div.navigate-left.enabled:hover {
+ border-right-color: #8dcffc; }
+
+.reveal .controls div.navigate-right.enabled:hover {
+ border-left-color: #8dcffc; }
+
+.reveal .controls div.navigate-up.enabled:hover {
+ border-bottom-color: #8dcffc; }
+
+.reveal .controls div.navigate-down.enabled:hover {
+ border-top-color: #8dcffc; }
+
+/*********************************************
+ * PROGRESS BAR
+ *********************************************/
+.reveal .progress {
+ background: rgba(0, 0, 0, 0.2); }
+
+.reveal .progress span {
+ background: #42affa;
+ -webkit-transition: width 800ms cubic-bezier(0.26, 0.86, 0.44, 0.985);
+ -moz-transition: width 800ms cubic-bezier(0.26, 0.86, 0.44, 0.985);
+ transition: width 800ms cubic-bezier(0.26, 0.86, 0.44, 0.985); }
+
+/*********************************************
+ * SLIDE NUMBER
+ *********************************************/
+.reveal .slide-number {
+ color: #42affa; }
+
+/*********************************************
+ * GENERAL PURPOSE COLORS
+ *********************************************/
+
+.reveal .red {
+ color: red;
+}
+
+.reveal .orange {
+ color: orange;
+}
+
+.reveal .yellow {
+ color: yellow;
+}
+
+.reveal .green {
+ color: green;
+}
+
+/*********************************************
+ * C3JS Charts
+ *********************************************/
+
+.c3 {
+ fill: white; }
+
+.c3 line, .c3 path {
+ stroke: white !important; }
+
+/*********************************************
+ * Custom styling of individual charts
+ *********************************************/
+
+#most-significant-barriers .c3-shape .c3-shape-2 .c3-bar .c3-bar-2 {
+ color: red;
+}
+
+/*********************************************
+ * Footer and Header
+ *********************************************/
+
+.header {
+ position:relative;
+}
+/*.header .left {
+ position:absolute;
+ top: 5px;
+ left: 5px;
+ width: 196px;
+ height: 100px;
+ background-image: url("../../../images/logo-building-iot.png");
+}*/
+.header .right {
+ position:absolute;
+ top: 5px;
+ right: 5px;
+ width: 246px;
+ height: 100px;
+ background-image: url("../../../images/logo-apache.png");
+}
+
+.footer {
+ position:relative;
+}
+/*.footer .left {
+ position:absolute;
+ bottom: 5px;
+ left: 5px;
+ width: 392px;
+ height: 50px;
+ background-image: url("../../../images/logo-company.png");
+}
+.footer .right {
+ position:absolute;
+ bottom: 5px;
+ right: 5px;
+ width: 306px;
+ height: 100px;
+ background-image: url("../../../images/logo-training.png");
+}*/
+
+/*********************************************
+ * Add the ability to split into two columns
+ *********************************************/
+
+.reveal .west {
+ position: fixed;
+ left: 5%;
+}
+
+.reveal .east {
+ position: fixed;
+ right: 5%;
+}
+
+
