From e2522a61d6bf984cf7fe4b5e518378b5e7e9a215 Mon Sep 17 00:00:00 2001 From: Nathan Woodburn Date: Mon, 20 Nov 2023 11:37:40 +1100 Subject: [PATCH] feat: Add placeholder documentation --- PLACEHOLDERS.md | 134 +++++++++++++++++++++++++++++++++++++++++++++++ README.md | 3 +- sites/website.py | 8 ++- 3 files changed, 139 insertions(+), 6 deletions(-) create mode 100644 PLACEHOLDERS.md diff --git a/PLACEHOLDERS.md b/PLACEHOLDERS.md new file mode 100644 index 0000000..036a865 --- /dev/null +++ b/PLACEHOLDERS.md @@ -0,0 +1,134 @@ +# Template Placeholders + +- [Template Placeholders](#template-placeholders) + - [Colours](#colours) + - [Background colour (bg\_colour)](#background-colour-bg_colour) + - [Text colour (text\_colour)](#text-colour-text_colour) + - [Foreground colour (fg\_colour)](#foreground-colour-fg_colour) + - [Parts](#parts) + - [Avatar](#avatar) + - [HNSChat](#hnschat) + - [Location](#location) + - [Email](#email) + - [Footer (footer)](#footer-footer) + - [Text Placeholders](#text-placeholders) + - [Main domain (main\_domain)](#main-domain-main_domain) + - [Data (data)](#data-data) + - [Crypto Address Placeholders](#crypto-address-placeholders) + - [Icons](#icons) + - [Full parts](#full-parts) + - [Address only](#address-only) + + + + +## Colours +### Background colour (bg_colour) +Use #000000 for the background colour as the app overwrites this colour + +### Text colour (text_colour) +Use #1fffff for the background colour as the app overwrites this colour + +### Foreground colour (fg_colour) +Use #f1ffff for the background colour as the app overwrites this colour + +## Parts +### Avatar +`avatar` can be used to get the avatar of the user. +If the user doesn't have an avatar this is just +```html +

domain.shakecities/

+``` +If the user does have an avatar this is + +```html + +``` + +### HNSChat +If the user has a HNSChat name set this will return +```html + + + username/ + +``` + +### Location +If the user has a location set this will return +```html + +location +``` + +### Email +If the user has a email set this will return +```html + + + email@example + +``` + +### Footer (footer) +This is the Shakecities footer. It will always be the same "Powered by Shakecities" + + +## Text Placeholders +### Main domain (main_domain) +`main_domain` can be used to get the main domain of the site e.g. shakecities.com + +### Data (data) +`data` can be used to get the data of the site. +This is the main body + + + +## Crypto Address Placeholders +### Icons +These are the icons for the crypto addresses. +There are 2 versions of each icon. One with a contrast to the foreground colour and one without. + +These return the path to the image of the icon (eg. `assets/img/HNS.png`) + +They are as follows: +- hns_icon +- hns_icon_invert +- btc_icon +- btc_icon_invert +- eth_icon +- eth_icon_invert + +### Full parts +These are the full parts for the crypto addresses. +They return both the icon and the address. + +For example `hns` returns +```html +hs1... +``` + +The list of full parts are: +- hns +- btc +- eth +- hns_invert +- btc_invert +- eth_invert + + +### Address only + +These are plain text addresses without the icon. +Eg. `hns_address` returns +```html +hs1... +``` + +They are as follows: +- hns_address +- btc_address +- eth_address + + + diff --git a/README.md b/README.md index a3f1e52..13153ff 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,8 @@ python3 -m pip install -r requirements.txt python3 template.py city_new ``` -Visit http://127.0.0.1:5000/ to view the template +Visit http://127.0.0.1:5000/ to view the template +Here is a list of placeholders you can use [PLACEHOLDERS.md](PLACEHOLDERS.md) ### Deployment diff --git a/sites/website.py b/sites/website.py index 02a3f88..030b798 100644 --- a/sites/website.py +++ b/sites/website.py @@ -75,16 +75,14 @@ def render(data,db_object): eth_address = eth if hns != "": hns = "" + hns - if btc != "": - btc = "" + btc - if eth != "": - eth = "" + eth - if hns != "": hns_invert = "" + hns_address if btc != "": + btc = "" + btc btc_invert = "" + btc_address if eth != "": + eth = "" + eth eth_invert = "" + eth_address + hide_addresses = False if hns == "" and btc == "" and eth == "":