Settings
The main settings file for Miga is settings.ini, a file that you will have to create in the main Miga directory. That file defines some high-level information, as well as defining, for each "app" (though there might be just one), where the settings of that app can be found. If the installation holds just a single app, called "Billy's Books", then the settings.ini file might look like the following:
[Billy's Books] Directory = books Schema file = BooksSchema.ini Pages file = BooksPages.ini Logo = billysbooks.png
The "Directory" setting tells the system where to find the other files. Miga will look in the directory "apps/directory-name" - so, in this case, "apps/books" - to find the other files specified. (For information about the schema and pages files, see Data schema files and Additional pages, respectively.) The "Logo" setting specifies a logo image to be shown on every page of this app.
Below is a complete listing of the allowed settings for settings.ini:
- Directory - the only required setting. Indicates where the files (for data, schema, page list, and images) are located for a specific app.
- URL - specifies the URL for this app specifically. Necessary only if there is more than one app in this installation.
- Schema file - the name of the schema file for this app's data, if any.
- Pages file - the name of the file holding the list of additional pages for this app.
- Start page - an HTML file displayed when the user goes to the site's main URL, instead of the standard category/page selector.
- Logo - the name of the image to be used as the logo of this app.
- Favicon - the name of the image to be used as the favicon, i.e. the small image that shows up in the browser tab.
- App icon - the name of the image used as an icon if a shortcut to the web page is saved to the screen, in the manner of a mobile app.
- CSS file - the name of the file holding CSS customizations for this app. This file, if it is set, will override the CSS settings contained in the main CSS file, "main.css".
- Header file - the name of a file holding HTML to be placed at the top of every page.
- Footer file - the name of a file holding HTML to be placed at the bottom of every page.
- Hide quantity tab - if set to "true", hides the tab marked "Quantity", that shows the numerical distribution of filter values, when viewing the set of values for a filter.
- 24-hour time - if set to "true", shows time values in 24-hour format, known in the US and Canada as "military time". Defaults to false.
- Map service - the mapping service to be used for maps, if this app's data contains any geographical coordinates. Currently the only two options are "Google Maps" and "OpenLayers"; Google Maps is the default.
- Marker clustering - if set to "true", clusters markers together when displaying maps, so that points appear as big "heat map" circles as opposed to individual markers. This setting only works with Google Maps.
You can place setting values at the very top of the file, above the app sections, so that they will apply to all apps. For instance, if you put "24-hour time = true" at the top, all apps will use 24-hour time, without having to add that setting to each one. (You can then override such a global setting within any specific app, in this case by adding "24-hour time = false" to that app.
