Yevhen Babiichuk (DustDFG)
8f4f7c797f
Optimized version of external link icon
|
2 years ago | |
|---|---|---|
| include | 2 years ago | |
| source | 2 years ago | |
| .gitignore | 3 years ago | |
| README | 3 years ago | |
| TODO | 2 years ago | |
| addlang | 3 years ago | |
| addnews | 3 years ago | |
| addpage | 3 years ago | |
| build | 3 years ago | |
| css | 4 years ago | |
| delpage | 3 years ago |
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
===============
[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