Skip to content

Commit c16bd8e

Browse files
author
Forni B
authored
Update README.md
1 parent efd694c commit c16bd8e

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

EnCAB/README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,17 +32,21 @@ Python 3, with Jinja2 (for templating), ElementTree (for parsing XML) and Beauti
3232
Edit config file "config.py" to change directories and other preferences.
3333

3434
The program will read the HTML files and the algorithms data.
35-
It will write the HTML data in *.html files inside <section block="algorithm/index" sort="(name)"></section>.
36-
block="algorithm" sort="(name)" --> write algorithms data, insert in (name) a SORT_STRINGS (from "config.py") or XML XPath of desired item to sort
37-
block="index" sort="(name)" --> write files index, insert in (name) the folder name of desired files to use for the sorted index
35+
It will write the HTML data in *.html files inside ```<section block="algorithm/index" sort="(name)"></section>```.
3836

39-
Templates are written in Jinja2 templating language. The XML ElementTree is passed as argument.
37+
```block="algorithm" sort="(name)"``` write algorithms data, insert in (name) a SORT_STRINGS (from "config.py") or XML XPath of desired item to sort
38+
39+
```block="index" sort="(name)"``` write files index, insert in (name) the folder name of desired files to use for the sorted index
4040

4141
### Data
4242

4343
Each algorithms must have its own XML file stored in ALGORITHMS_DIR with .xml or .txt extension.
4444
See "- algorithms codes format" for mandatory format of the codes.
4545

46+
### HTML Templates
47+
48+
Templates are written in Jinja2 templating language. The XML ElementTree is passed as argument.
49+
4650
### Errors
4751

4852
The log containing the errors found by the program are stored in the file "log.txt".

0 commit comments

Comments
 (0)