Difference between revisions of "Config Files"
(Created page with " The configuration files are files in the site’s code that allow customisation of certain features that are highly unlikely to be changed on a regular basis. {| class="wiki...") |
|||
| Line 1: | Line 1: | ||
| − | |||
The configuration files are files in the site’s code that allow customisation of certain features that are highly unlikely to be changed on a regular basis. | The configuration files are files in the site’s code that allow customisation of certain features that are highly unlikely to be changed on a regular basis. | ||
| − | + | =Usage= | |
| − | + | These files are located in config/lorekeeper. The following files may be edited to configure an individual site: | |
| − | |||
| − | |||
| − | |||
| − | Usage | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | * settings.php | |
| − | + | * extensions.php | |
| + | * sites.php | ||
| − | + | The others should not be touched except when adding new features. A possible exception may be made for admin_sidebar.php in the event that you are rearranging the sidebar contents. However, please take care in this case to maintain syntax as well as sidebar items. | |
| − | |||
| − | = Files = | + | =Files= |
| − | == settings.php == | + | ===settings.php=== |
This file lists some basic site settings that are unlikely to change once the site is in use, and therefore should be modified before all else. The following properties can be modified here: | This file lists some basic site settings that are unlikely to change once the site is in use, and therefore should be modified before all else. The following properties can be modified here: | ||
| − | * Site Name | + | *Site Name |
| − | * Character Codes (formatting) | + | *Character Codes (formatting) |
| − | * Masterlist Thumbnail Dimensions | + | *Masterlist Thumbnail Dimensions |
| − | * Trade Asset Limit | + | *Trade Asset Limit |
Please refer to the comments in the file itself for a complete description of each setting. | Please refer to the comments in the file itself for a complete description of each setting. | ||
| − | == admin_sidebar.php == | + | ===admin_sidebar.php=== |
This file lists the links in the admin panel sidebar, as well as the staff power required to view the category of links. | This file lists the links in the admin panel sidebar, as well as the staff power required to view the category of links. | ||
| − | == image_files.php == | + | ===image_files.php=== |
This file lists the files that will appear in the image uploader section of the admin panel. | This file lists the files that will appear in the image uploader section of the admin panel. | ||
| − | == item_tags.php == | + | ===item_tags.php=== |
This file lists item tags that are available to attach to items. Please refer to (tutorial) for how to use this file. | This file lists item tags that are available to attach to items. Please refer to (tutorial) for how to use this file. | ||
| − | == notifications.php == | + | ===notifications.php=== |
This file lists notification types as well as their message texts. | This file lists notification types as well as their message texts. | ||
| − | == powers.php == | + | ===powers.php=== |
This file lists staff powers that can be attached to user ranks. | This file lists staff powers that can be attached to user ranks. | ||
| − | == text_pages.php == | + | ===text_pages.php=== |
This file lists text pages that are generated during setup and cannot be deleted from the admin panel. | This file lists text pages that are generated during setup and cannot be deleted from the admin panel. | ||
| − | = See Also = | + | =See Also= |
| − | * Site Settings | + | *Site Settings |
Revision as of 12:40, 19 May 2021
The configuration files are files in the site’s code that allow customisation of certain features that are highly unlikely to be changed on a regular basis.
Contents
Usage
These files are located in config/lorekeeper. The following files may be edited to configure an individual site:
- settings.php
- extensions.php
- sites.php
The others should not be touched except when adding new features. A possible exception may be made for admin_sidebar.php in the event that you are rearranging the sidebar contents. However, please take care in this case to maintain syntax as well as sidebar items.
Files
settings.php
This file lists some basic site settings that are unlikely to change once the site is in use, and therefore should be modified before all else. The following properties can be modified here:
- Site Name
- Character Codes (formatting)
- Masterlist Thumbnail Dimensions
- Trade Asset Limit
Please refer to the comments in the file itself for a complete description of each setting.
admin_sidebar.php
This file lists the links in the admin panel sidebar, as well as the staff power required to view the category of links.
image_files.php
This file lists the files that will appear in the image uploader section of the admin panel.
item_tags.php
This file lists item tags that are available to attach to items. Please refer to (tutorial) for how to use this file.
notifications.php
This file lists notification types as well as their message texts.
powers.php
This file lists staff powers that can be attached to user ranks.
text_pages.php
This file lists text pages that are generated during setup and cannot be deleted from the admin panel.
See Also
- Site Settings
