threadr.lostcave.ddnss.de/macros/README.md

31 lines
1.6 KiB
Markdown
Raw Permalink Normal View History

# Files
2021-09-02 15:47:01 +02:00
### [[DIR] templates](./templates)
contains the templates used by the macro processor
### [pass0_templates.json](./pass0_templates.json)
Macros that insert templates
2021-09-02 17:01:28 +02:00
- `%NAVBAR%` the navigation bar at the top of the website (requires PHP)
- `%BANNER_COOKIES%` the cookie banner (requires PHP)
2021-09-02 15:47:01 +02:00
### [pass1_misc.json](./pass1_misc.json)
Miscellaneous macros
2021-10-29 04:54:12 +02:00
- `%FAVICON%` links the tab icon (HTML <head> section)
2021-09-02 17:01:28 +02:00
- `%STYLESHEET%` links stylesheet (HTML <head> section)
- `%PLEAZE_NO_CACHE%` tell the browser not to cache this page (PHP, before any data is sent to the client)
2021-09-02 15:47:01 +02:00
- `%COLOR_BEIGE%`, `%COLOR_ORANGE%`, `%COLOR_BLUE%`, `%COLOR_PINK%`, `%COLOR_CYAN%` color codes, format: #XXXXXX
### [pass2_session.json](./pass2_session.json)
Session handling macros
2021-09-02 17:01:28 +02:00
- `%REQUIRE_LOGIN%` go to login page if not logged in
2021-09-02 15:47:01 +02:00
- `%NO_CHEAP_SESSION_STEALING%` make sure that IP and user agent stay the same, otherwise end session
2021-09-02 17:01:28 +02:00
- `%SET_LOGIN_VARIABLE%` sets the variable $login based on whether the user is logged in
- `%FORCE_LOGOUT%` end session right here and now
2021-09-02 15:47:01 +02:00
### [pass3_install-config.json](./pass3_install-config.json)
Macros that grab the configuration values and inject them into the instance
2021-09-02 17:01:28 +02:00
- `%DOMAIN_NAME%` the domain name of the instance
- `%CONTENT_DIR%` the directory of the ThreadR home page on the webhost
- `%DB_PASSWORD%` password for the MySQL server
- `%DB_USERNAME%` username for the MySQL server
- `%DB_NAME%` name of the database to use
- `%DB_SERVER%` address of the mysql server
- `%ABOUT_PAGE%` the template for the about page
### [README.md](./README.md)
this file