created:2021-05-14
author:Foobär
top:README:Settings
sort:018
title:Settings

<p>
A setting in a web sites <code>settings</code> file is just a global variable that's set for the script before generating the web site. Therefore a setting can be set by
writing the setting name followed by a <code>=</code> followed by the value in an otherwise empty line. There may be no blank before or after the <code>=</code>. Values with special
characters (that includes spaces) have to be quoted (encloded in <code>"</code>s).
</p><p>
Examples:
</p><p>
<code>sitename="ExSite (The Example Web Site)"</code>
The Name of the web site needs to have a <code>"</code> before and one after in this case, because it contains spaces. Otherwise, an error will occur.
</p><p>
<code>thumbsize=200</code>
The value <code>200</code> does not contain any special characters. Therefore no <code>"</code> is needed. It doesn't matter whether the value is enclosed in them or not.
</p><p>
All settings are optional. If a setting is not set in the settings file, a default value is used. The following variables/settings are meant to be set in the
settings file. Additional settings can be declared in the same way if they don't have the same name as an existing global variable. Those additional variables can
then be used in hooks. (See the "Hooks" section below.)
</p><p>
<code>sitename</code> - The name/title of the website as displayed in the header and used in the browser window title bar/browser tabs.
</p><p>
<code>url</code> - The url is used when external documents that link to the web site are generated, e.g. the RSS feed.
</p><p>
<code>webbase</code> - A prefix that is prepended to every link that is generated. Unless the web site will be sitting in a subdirectory, this should always be "/".  
</p><p>
<code>style</code> - The name of the style set that should be used if none is specified by command line option. See the "Styles" section below to learn which files this will include.
</p><p>
<code>odir</code> - The path of the output directory.
 
<code>thumbsize</code> - The maximum width and height of gallery image thumbnails when attached to blog entries.
</p><p>
<code>thumbsizemini</code> - The maximum width and height of gallery image thumbnails on gallery pages.
</p><p>
<code>previewsize</code> - The maximum width and height of gallery image previews as displayed on gallery pages. This should be large enough to view the image in full but doesn't need to be too large as the original image file will be linked for the case that somebody wants to download the full resolution.
</p><p>
<code>perpage</code> - The maximum number of entries that will be included in one HTML page when generating agpages. When there are more entries that belong on the tagpage, it is devided into several HTML pages and a pager is added at the bottom.
</p><p>
<code>tagiconsize</code> - This setting is currently ignored. You may do the same with this line.
</p><p>
<code>duals</code> - This setting is currently ignored. You may do the same with this line.
</p><p>
<code>details</code> - This setting is currently ignored. You may do the same with this line.
</p><p>
<code>exclude</code> - This setting is currently ignored. You may do the same with this line.
</p>
