dragora-website/include/constants

#
# constants
#
# Common constants for the Dragora GNU/Linux-Libre website scripts
#
#
# Copyright (C) 2021, 2022 Michael Siegel
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.


## Name of invoked command
declare -r PROGNAME="${0##*/}"

## External commands
declare -r TOOLS='cat cmp cp cut grep ln mkdir mv rm rsync sort wc'
declare -r GNU_TOOLS='date find sed stat'

## Source directories and files
declare -r SOURCE_DIR=source
declare -r COMMON_DIR="$SOURCE_DIR"/common
declare -r PAGES_DIR="$SOURCE_DIR"/pages
declare -r PAGES_DIR_MASTER="$PAGES_DIR"/en
declare -r TMP_DIR="$SOURCE_DIR"/tmp
declare -r FOOTER_PARAMS=footer_params
declare -r HEADER_PARAMS=header_params
declare -r HOME_PAGE_DIR=home
declare -r HOME_PAGE="$HOME_PAGE_DIR"/index.html.in
declare -r NEWS_PAGE=news/index.html.in
declare -r NAVTREE_FILE="$PAGES_DIR"/navtree
declare -r SOURCE_PAGE_FILENAME=index.html.in

## Common directories and files (common among $SOURCE_DIR and $OUTPUT_DIR)
declare -r CSS_DIR=css
declare -r STYLESHEET=main.css
declare -r STYLESHEET_PATH="$CSS_DIR/$STYLESHEET"
declare -r IMG_DIR=img
declare -r FAVICON=dragora.ico
declare -r FAVICON_PATH="$IMG_DIR/$FAVICON"
declare -r LOGO=dragora_logo.png
declare -r LOGO_PATH="$IMG_DIR/$LOGO"

## HTML output indentation
declare -r IND1='  '  # One level equals two spaces.
declare -r IND2="${IND1}${IND1}"
declare -r IND3="${IND2}${IND1}"
declare -r IND4="${IND3}${IND1}"

## Output directory
declare -r OUTPUT_DIR=output

## Interactive user interface
declare -r PROMPT='> '
declare -r HELP_TIP_INTERACTIVE='(? for help)'
declare -r HELP_COMMAND='?'

## Misc
declare -r COPYRIGHT_HOLDERS='The Dragora Team'
declare -r COPYRIGHT_YEARS='2019–2022'
declare -r DIR_UP='../'
declare -r LATEST_NEWS_ITEMS=3
declare -r SEPARATOR='|'  # Used in <title></title>.
declare -r SITE_TITLE=Dragora
declare -r TIMEZONE=UTC