Files for the official Dragora website https://www.dragora.org

Matías Fonzo 9485705af0 pages: en/license: Capitalize "-libre" 1 rok pred
include 81f24c4a08 Update copyright year(s) 2 rokov pred
source 9485705af0 pages: en/license: Capitalize "-libre" 1 rok pred
.gitignore f2dd9a5c69 Adjust `.gitignore` 3 rokov pred
README 9dae439f9b Revert "Markdown-ify README (WIP)" 3 rokov pred
TODO 3e83536c9b Update TODO 2 rokov pred
addlang 93dd56b3f0 scripts: Use `_env_checks` 3 rokov pred
addnews 5360d2889e `addnews`: Whitespace clean-up; remove obsolete code line break 3 rokov pred
addpage 1ac4b4cbeb `addpage`: `_prompt_navplace`: Make code more concise 3 rokov pred
build 3c73497c2c build: Fix blank spaces 2 rokov pred
css 0c8b4f389a Add shortcut to css directory 4 rokov pred
delpage 93dd56b3f0 scripts: Use `_env_checks` 3 rokov pred

README

Dragora website
===============

[Description/Abstract/Short summary]

Contents

1. Prerequisites
2. Usage
2.1 Adding pages
2.2 Removing pages
2.3 Editing pages
2.4 Posting news items
2.5 Removing the latest news item
2.6 Adding a translation directory
2.7 Building the site
3. How it all works
3.1 Directory structure
3.2 How the scripts work
4. Contributing
5. Authors
6. Acknowledgments


2. Usage

This section describes how to use the various helper scripts to manage the
site's structure and content.


2.1 Adding pages

To add a new page, run

./addpage

without any arguments. The script works interactively and will walk you
through the process, providing context-specific help for each question
(except where it doesn't).


2.2 Removing pages

To remove a page, run

./delpage

without any arguments. The script works interactively and will walk you
through the process, providing context-specific help for each question
(except where it doesn't).

If the page selected for removal is visible in the site navigation, the
corresponding navigation item will be removed as well.


2.3 Editing pages

To edit a page, simply find the respective `index.html.in` file in
`source/pages//` and modify its content with a text
editor.

Beware that the News page is, in general, not meant to be edited by hand. See
sections 2.4 and 2.5 for more information.


2.4 Posting news items

To post a news item, run

./addnews

without any arguments. The script will ask for a publishing date (providing
the current date as a default value), a title, and a URL pointing to the
respective message in the web archive of the dragora-users mailing list.


2.5 Removing the latest news item

If something went wrong when adding a news item, the action can be reverted
by simply running

./addnews -r

Beware that this command merely restores the previous state from a backup
file created when the latest news item was added and then removes that backup
file.


2.6 Adding a translation directory

To add a directory for a translation of the site into another language, run

./addlang

without arguments. The script will ask for the ISO two-letter code for the
language of the new translation and then copy everything from
`source/pages/en` to `source/pages/`.


2.7 Building the site

To build the site, simply run

./build

To include test pages in the build, run

./build -t