General

Components

Community

Development

TDF

Website Development

We use Git for version control. You can browse our repository in your web browser.

This page gives instructions on doing website development on your computer.

Setup

Install Python 2 dependencies.

Check your version of Python

python --version

Source code generation has been tested successfully with Python 2.7.16

Install dependencies

NOTE: The Apache CMS 3 bundled within the site directory depends on old libraries.

sudo apt-get install -y python2.7-elementtree
sudo apt install python-pip
python -m pip install "Markdown<2.6.0"
python -m pip install "Pygments==2.2.0"

Download the repo

git clone https://github.com/tdf/odftoolkit
cd odftoolkit/src/site

Directory Layout

Content directory

The src/site/site/content/odftoolkit directory contains web content - markdown, html, javascript, css, images and other files. Files that do not fit recognized patterns from site/lib/path.pm are copied as is to the web site during the build.

Templates directory

The src/site/site/templates directory contains the html skeletons used during the site build.

Lib directory

The src/site/site/lib directory contains two python modules that determine how content files are processed during the site build.

Build tools

You can find the CMS build tools in the cms directory.

Local Development

Edit the site

Using your favorite editors edit the site content, templates.

build the site

Run the build-site.sh script to build the markdown to HTML and copy all resources into the odftoolkit/docs directory. Afterthe changes have been merged to the master branch, all changes will become visible at https://tdf.github.io/odftoolkit/docs/

building JavaDoc and publishing the JavaDoc

JavaDoc is generated as part of the mvn clean install command called from the root of the project. Run the copy-javadoc.sh script to build copy the created API directories into the odftoolkit/docs/api directory and remove any prior files within.

Submitting your results.

Committer

Do the appropriate combination of git status, git add, and git commits.

Contributor

For further information see the GitHub help on creating a pull request from a fork page.

Impressum (Legal Info) | Privacy Policy (Datenschutzerklärung) | Statutes (non-binding English translation) - Satzung (binding German version) | Copyright information: Unless otherwise specified, all text and images on this website are licensed under the Apache License, v2.0. This does not include the source code of LibreOffice, which is licensed under the Mozilla Public License v2.0. “LibreOffice” and “The Document Foundation” are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy. LibreOffice was based on OpenOffice.org.