[openoffice-org] branch main updated: Read me files for templates

[wa...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

wave pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/openoffice-org.git


The following commit(s) were added to refs/heads/main by this push:
     new 5edf9da  Read me files for templates
5edf9da is described below

commit 5edf9da04bfd637a95148689328cc0afb1a7dbfe
Author: Dave Fisher <da...@davefisher.tech>
AuthorDate: Thu Oct 29 11:44:15 2020 -0700

    Read me files for templates
---
 templates/{README.txt => CMS_README.txt} |  0
 templates/README.md                      | 60 ++++++++++++++++++++++++++++++++
 2 files changed, 60 insertions(+)

diff --git a/templates/README.txt b/templates/CMS_README.txt
similarity index 100%
rename from templates/README.txt
rename to templates/CMS_README.txt
diff --git a/templates/README.md b/templates/README.md
new file mode 100644
index 0000000..6d1ec09
--- /dev/null
+++ b/templates/README.md
@@ -0,0 +1,60 @@
+# OpenOffice.org Templates
+
+This describes the Simple Groovy templates (GSP) that are used to build the site.
+
+## Templates that Generate HTML
+
+1. page.gsp
+   This template is used to generate html pages from both html and md files. It uses the following steps.
+   1. If an html file then html_extract.gsp is included to parse the html into the header, bodytag, and body.
+   1. breadcrumbs.gsp is included to generate the breadcrumbs and save the uri path to each directory on that content's path.
+   1. ssi_paths.gsp is included to determine which brand, topnav, leftnav, and rightnav SSIs to include. leftnav and rightnav are optional.
+   1. the html skeleton is then filled in with the data model.
+
+1. brand.gsp
+   This template is used to generate the top / branding portion of each page included with SSI.
+   These files are used to provide translated versions of the brand.
+   brand.md files cause the creation of these html SSIs using metadata to be filled into the template.
+
+    type=brand
+    search=search
+    selectedlang=en
+    language=Language
+    name=Apache OpenOffice
+    tagline=The Free and Open Productivity Suite
+    logo=AOO_logos/AOO4_website_logo.png
+    domain=https://www.openoffice.org
+    divid=bannera
+    announce=Apache OpenOffice 4.1.7 released
+    announceurl=https://blogs.apache.org/OOo/entry/announcing-apache-openoffice-4-13
+    announcetip=Apache OpenOffice 4.1.7 released
+    ~~~~~~
+
+1. navigator.gsp
+   This template is used to generate navigator SSI. These come in three flavors:
+   1. topnav.md
+   1. leftnav.md
+   1. rightnav.md
+
+    type=navigator
+    divid=topnava
+    ~~~~~~
+    
+    - [Product][m0]
+    - [Download][m1]
+    - [Support][m2]
+    - [Blog][m3]
+    - [Extend][m4]
+    - [Develop][m5]
+    - [Focus Areas][m6]
+    - [Native Language][m7]
+    
+    
+    [m0]: /product/index.html					"Apache OpenOffice product description"
+    [m1]: /download/index.html					"Download OpenOffice"
+    [m2]: /support/index.html 				     	"Find Support for OpenOffice"
+    [m3]: https://blogs.apache.org/ooo/				"Apache OpenOffice Blog"
+    [m4]: /extensions/index.html				"Extensions and Templates for OpenOffice"
+    [m5]: https://openoffice.apache.org/get-involved.html	"Get involved in Apache OpenOffice"
+    [m6]: /projects/accepted.html				"Apache OpenOffice development focus areas"
+    [m7]: /projects/native-lang.html			 	"Apache OpenOffice in your Native Language"