Overrides

In your installation directory (typically called tachibanasite), there is a directory called common. In it are TachibanaSite's defaults for its "common override" files. These files fill particular roles on a TachibanaSite page [Example].

The files are searched for in this order:

  1. The current page directory.

  2. If recursive common overrides are enabled, each directory from the current up to the local host path.

  3. <install path>/../common/

  4. <install path>/common/ (the aforementioned defaults)

Typically Site-Global

These files are typically placed in <install path>/../common/. They can be overridden for particular pages, but usually are not for most.

config.ini

This file contains the settings for your TachibanaSite install. There are several namespaces and fields, which will be described here in detail.

Namespace: TachibanaSite

This namespace is used for almost all of the TachibanaSite settings.

version (default: "1.9.1")

This is the TachibanaSite version. There is no real reason to override this.

site_title (default: "")

This is the title for the site, which will be appended to each page's <title>.

local_host_path (default: "/var/www")

This is the path on disk that corresponds to the URL / on your site. Definitely set this on new installations.

install_url (default: "/tachibanasite")

This is the URL path from the site root to the TachibanaSite installation directory. This is also important to set on new installations.

theme_name (default: "default")

This is the name of the theme to use.

force_ssl (default: no)

If set to yes, this will automatically redirect users to the SSL version of your site.

email (default: "example@example.com")

Set this to your email address. SendMail.php will email to this email address.

sender_email (default: "tachibanasite@localhost")

Set this to <some name>@<your server>. The default will probably send correctly, but most email systems will flag messages from localhost as spam, so you should probably change it if you plan to use SendMail.php.

enable_templates (default: no)

If set to yes, .template files will be interpreted as SimpleTemplate files, enabling embedded Python.

recursive_common_override (default: no)

If set to yes, TachibanaSite will search ancestor directories when searching for common override files. This does not apply to config.ini, since the override system has to find that file first.

Namespace: Theme

Under the default standard page, key-value pairs under the Theme namespace are sent to the theme's support.css.php as GET parameters.

Namespace: Modules

<module>_disabled (default: no)

If <module>_disabled exists and is yes, that module will refuse to load. All modules except for bootstrap, bootstrap4, and bootstrapify are enabled by default.

Example

This is the config.ini for this site:

[TachibanaSite]
site_title = "TachibanaSite Docs | TachibanaTech"
local_host_path = "/home/ntd5/tachibanatech.com"
install_url = "/ts/tachibanasite"
force_ssl = yes
email = "@@kjicr%7Ctvqq%7C_zr%7Evs1l%7C1z%7Bjkjic@@"
sender_email = "@@kjonlzq%7Bzm_k%7E%7Cwv%7D%7Eq%7Ekz%7Cw1%7Cprkjon@@"
enable_templates = yes
theme_name = "coloredpencil"

[Theme]
preset = "default"

[Modules]
mobiletext_disabled = yes
bootstrap4_disabled = no

Space for copyright or other licensing information. You can use &copy; for the copyright symbol.

This file is eligible for templating.

favicon.png

This is the favicon for the site (the icon that shows up in the title bar in most browsers).

This is the heading for the site (e.g. "TS Docs" here). Typically you should make the heading an <h1> element.

This file is eligible for templating.

This is the navigation list for the site. Typically the file should be a template and take something like the following form:

<%
import os, configIniUtils
base = os.path.dirname(configIniUtils.get_install_url())
%>
* [About]({{base}}/home/)
* [Install]({{base}}/install/)

sidebar.markdown

Typically you will want to override this file globally early on, since you probably don't want a link to this documentation sitting on the sidebar of your site.

This file is eligible for templating.

Typically Page-Specific

index.markdown

This is the actual content of the page.

This file is eligible for templating.

Miscellaneous

This is for providing a path through the site, but it has rarely been used.

This file is eligible for templating.

themes/

This directory can contain additional theme files. See themes for more information.