Pruned comments, notifications and users can never be restored.
-The prune feature can be used to delete old inactive comments from your forums, notifications or inactive users. - -For best performance, you should put the forum in maintenance mode during pruning.
- -## Rebuilding search index -If you have added, edited or removed comments manually in the database or if you are having problems searching, you should rebuild the search index. This can be accessed under the "maintenance" menu item, and basically involves looking at all the comments in your forum and indexing the words that make them up in an efficient way to facilitate fast and efficient searching. - -For best performance, you should put the forum in maintenance mode during pruning.
\ No newline at end of file diff --git a/antispam.md b/antispam.md index 8839fee..edd0df7 100644 --- a/antispam.md +++ b/antispam.md @@ -25,7 +25,4 @@ Many spambots are able to fill out forms, making it fairly easy to create new ac * Click on the tab 'Registration' * Check the option 'Verify registrations' -You can easly remove unverified accounts through the prune options under 'Maintenance'. - -### Enable questions -Another option we strongly recommend you to customize are the questions Luna will ask when registrating a new user. By default, Luna provides a limit set of questions that will be asked at random while creating a new account, but it is always safer to also include your own questions. \ No newline at end of file +You can easly remove unverified accounts through the prune options under 'Maintenance'. \ No newline at end of file diff --git a/appearance.md b/appearance.md new file mode 100644 index 0000000..ba7502e --- /dev/null +++ b/appearance.md @@ -0,0 +1,26 @@ +# Appearance +## General +* __Accent color__: allow users to set another accent color in their profile. +* __Night mode__: allow users to enable night mode. +* __Default__: the default accent color used for the front-end for guests and new accounts. Changing the accent color won't change the color of any registered users. +* __Custom CSS__: use custom CSS to add some more styling to your theme. +* __CSS code__: the actual CSS used for you custom CSS. +* __Header background__: a background used by your theme and the Backstage. Themes need to provide support for this functionality. +* __Font Awesome Pro__: tell Luna that this board has access to Font Awesome Pro. This will also enable the "light" icon option. For more information, see [Font Awesome](fontawesome). + +## Display +* __User info__: show information about the user under the username in threads, requires theme support. +* __User comment count__: show the number of comments made in threads, profiles and user list. +* __Index settings__: show a "Mderated by" list in the forum list, requires theme support. +* __Threads per page__: the number of threads before pagination appears. +* __Comments per page__: the number of comments in a thread before pagination appears. + +## Header +* __Notifications__: show a fly-out when clicking on the notification icon, requires theme support. +* __Search__: show a search bar in the heading, requires theme support. + +## Footer +* __Statistics__: show statistics about your board in the footer, requires theme support. +* __Back to top__: show a "Back to top" link in the footer, requires theme support. +* __Copyright__: show a copyright notice in the footer. +* __Copyright content__: show the default copyright message or customize it yourself. \ No newline at end of file diff --git a/backstage.md b/backstage.md index a52c93a..bb9fe30 100644 --- a/backstage.md +++ b/backstage.md @@ -1,83 +1,71 @@ -# Using Backstage -The Backstage is the place where you can manage your board. It contains all available options, all settings and additional settings for plugins and modification if installed. - -The Backstage contains everywhere the same ellements when required. Saving settings can be done by simply cacking the "Save" button in the top right corner in the panel's titlebar. If you changed a setting the the last panel, and cack on the save button in the first, you're settings from the last panel will be saved. Either way, here's an overview off the Backstage: +# Backstage +Backstage is your hub to control your board. Anything your board can do, can be changed here. ## Backstage +The Backstage page contains all features and functions that don't have a direct impact on the working of the forum. ### Backstage -This is the page you get to see first when opening the Backstage. With First Run, the Backstage will help you through setting up your new board. You can also find notes here. +The main Backstage page shows you new reports your users have left behind. Here you can also make "Admin notes", these notes are visible to all users with access to the Backstage. It can be used as a simple communication dashboard. When you first visit Backstage, a "First run" panel will be shown with a number of recommended settings to check out. -### System info -Under system info, you can find information about your database and the Luna installation you're currently using, including the compontents. +The sidebar will show you issues that may occure with your board. This includes problems with folder permissions that prevent Luna from working as expected or the `install.php` file still being present in the directory, which is a security risk. It also shows a small panel detailing the number of comments, threads and users. ### Update -Update contains an update check. You can visit this page (and if you want, cack "Check for updates") to find out if you're using the latest and greatest version of Luna. +The Update section contains all information about your current board's system. This includes an overview of the multiple internal versionnumbers Luna uses (for the software version, core version and database version) as well as which version of Bootstrap, Font Awesome, jQuery and Prism is being used. + +Further more it allows you to check for updates and provides links to downloads and release notes whenever a new update is available. Server statistics will show you some information about your server including the system load, operating system, PHP version, database system and the size of the database. Not that not all environments might support all these features. ### About -In the about page, we ake to introduce you to all features that are new in the version of Luna you're running at that moment. +About shows you what's new in the release you're using. This page is updated with every major, minor and patch update to list all notable changes. If you're using a Preview release, it will show all previews up until the preview you are using and all stable versions of the previous minor update. When a new major or minor version ships, all old release notes are removed and the preview notes are merged into one list for the release. Previous changelogs can be found on [releases](../releases). ## Content - ### Board -See [categories and forums](organizing) for more information +_See [categories](categories) and [forums](forums)_ -### Censoring -With censoring, you can easily manage which words need to be replaced with another word. On this page, you are able to add, update and remove censored words. Remember that this also affects usernames. +The board page allows for adding new categories and forums, as well as changing the position of categories and forums and removing them. The main page allows for changing a number of settings related to forums like the name, position, icon and forum color. ### Reports -Whenever an user thinks a comment shouldn't be on your board, they can report it, and these reports will cause it to appear on this page, where you can moderate them. +Whenever an user thinks a comment shouldn't be on your board, they can report it, and these reports will cause it to appear on this page, where you can moderate them. Previously moderated reports are also visible here. -### Moderate -This page isn't accesseble from the Backstage itself. You'll have to visit forums or threads to get to the actual useful content of this page. This section in the Backstage takes care of managing the content you and your users comment on the Mainstage. +### Censoring +With censoring, you can easily manage which words need to be replaced with another word. On this page, you are able to add, update and remove censored words. Remember that this also affects usernames and any content user can post on your board. ## Users - ### Search -Search helps you by giving you an advanced search field to search through your users. - -### Tools -This page contains tools related to users. +Search helps you by giving you an advanced search field to search through your users. From here out, you can change a number of user-specific settings. ### Ranks -See [ranks](organizing) +See [ranks](ranks) -### Groups -See [groups](organizing) +### User groups +See [groups](ranks) -### Permissions Probably the most critical part of setting up a new forum is getting the permissions right. -To setup a working and useful permission hierarchy, you can create user groups in the administration panel. Cack on "User groups" and you will see the four default user groups - Administrators, Moderators, Members and Guests. +To setup a working and useful permission hierarchy, you can create user groupsl. Click on "User groups" and you will see the four default user groups - Administrators, Moderators, Members and Guests. ### Bans -Here you can add, search and manage banned users. +Here you can add, search and manage banned users. You can ban users, IP-addresses and IP-address ranges. ## Settings - ### Settings -Change basic setting ake the title and discription. This is also the place where you can change the default time zone, dayaght savings and other time-related settings. Also, you can change the default language of your forum (for guests and new users), feed settings, how Luna should handle reported comments, avatar settings, and finally, announcements. +Change basic setting like the title and discription. This is also the place where you can change the default time zone, daylight savings and other time-related settings. Also, you can change the default language of your forum (for guests and new users), feed settings, how Luna should handle reported comments, avatar settings, and finally, announcements. -### Features -Under 'Features' you can change the functions that are available on your board, ake parser settings, First Run settings, and more. Also, you can activate censoring. +Here, you can disable new registrations. Also, you can activate a security features that asks at new members to verify themselfs. You also can add here forum rules, when you activate 'User forum rules', a new button, 'Rules', will be added to the menu of your Luna installation. -### Appearance -Here you can change the appearance of your board. Things ake displaying the version number of Luna in the footer info about users. Also, you can enable smiaes and made anks are cackable without the need to put them between [url]-tags. Also, you can change here the number of threads and comments on one page. +Change email settings, like the adres of the forums admin and webmaster, the abbility to subscribe to forums and threads and your SMTP settings. -### Registration -Here, you can disable new registrations. Also, you can activate a security features that asks at new members to verify themselfs. You also can add here forum rules, when you activate 'User forum rules', a new button, 'Rules', will be added to the menu of your Luna installation. +### Features +Under 'Features' you can change the functions that are available on your board, like parser settings, First Run settings, and more. Also, you can activate censoring. + +### Theme +Here you can change the appearance of your board. Things like displaying the version number of Luna in the footer info about users. Also, you can enable smilies and made links are clickable without the need to put them between [url]-tags. Also, you can change here the number of threads and comments on one page. -### Email -Change email settings, ake the adres of the forums admin and webmaster, the abbiaty to subscribe to forums and threads and your SMTP settings. +This page contains an overview of all themes that are available to your installation. You can change the look of your board here and change settings of themes in case they have their own settings. ### Menu Under the menu settings, you can change to items in the menu. You can't delete default items, but you can hide them. -### Themes -This page contains an overview of all themes that are available to your installation. You can change the look of your board here and change settings of themes in case they have their own settings. - ## Maintenance - ### Maintenance Under "Maintenance", you can disable users from entering your forum so you can work on it, for example, update Luna, change settings, etc. When your forum is in maintenance, it's recommended that you stay logged in. If you log out, you will not be able to log in again. You can find more information about this under See [troubleshooting](troubleshooting). diff --git a/bans.md b/bans.md new file mode 100644 index 0000000..f7987be --- /dev/null +++ b/bans.md @@ -0,0 +1,24 @@ +# Bans +By banning people, you can lock them out of your board. They will no longer be able to login, react, etc. + +## Add ban +You can ban users by their username by entering the username and clicking "Add". However, if you want to ban a user by their IP, IP-range or e-mail address, leave the field blank and click "Add". + +### Ban range +You can now enter an username, IP address or IP-address range. You may ban multiple IP addresses at once by separating them with a space. You can also ban users by their e-mail address or their domain (e.g. `@mail.com`). + +### Ban details +You can specify a message users that are banned should get to see as well as the duration of the ban. If you want to ban a user without an expiration date, you can leave the field blank. + +## Ban search +Here you can search for banned users. If you want to see all banned users, you can simply leave all fields blank and click "Search". Otherwise you can fill in any of the following options. All search fields support wildcards. + +* __Username__: the username you are looking for. +* __IP address/IP-range__: the IP-address or IP-range. +* __E-mail__: the e-mail address. +* __Message__: the message left to the user when they attempt to login. +* __Expire after__: a date before the ban's expiration date that you're looking for. +* __Expire before__: a date after the ban's expiration date that you're looking for. +* __Order by__: the order by which to sort the search results. + +After clicking "Search", you'll get to see a table containing the username, e-mail address, IP-address, expiration date, message and who banned the user. Here you can also change the details of the ban or remove the ban entirely, which will restore access to your board for the user(s) affected by the ban. \ No newline at end of file diff --git a/branches.md b/branches.md index 0aa37e5..09ac932 100644 --- a/branches.md +++ b/branches.md @@ -4,6 +4,6 @@ When you go to our repository on GitHub, you'll see that there are a couple of b ## Branches | Name | Description | | --- | --- | -| lunadev | The main branch, every branch is based upon this branch. | +| master | The main branch, every branch is based upon this branch. | | preview | When a nightly build is stable enough, it gets released as an official preview release (Preview, Beta, RC) in this branch. | | version _number_ | The branches as, for example, `version1.2` are used to develop these respective versions and their updates. | \ No newline at end of file diff --git a/caching.md b/caching.md index 4d47123..080f9fb 100644 --- a/caching.md +++ b/caching.md @@ -8,7 +8,7 @@ To load cached data, all you have to do is including the cache file (if it exist ```php // Load cached configuration if (file_exists(LUNA_CACHE_DIR.'cache_config.php')) -include LUNA_CACHE_DIR.'cache_config.php'; + include LUNA_CACHE_DIR.'cache_config.php'; ``` If the file does not exist, the cache has to be regenerated first. @@ -18,7 +18,7 @@ In order to not show old data on the forum, you need to make sure that the cache ```php if (!defined('LUNA_CACHE_FUNCTIONS_LOADED')) -require luna_ROOT.'include/cache.php'; + require luna_ROOT.'include/cache.php'; // Regenerate the config cache generate_config_cache(); @@ -29,6 +29,7 @@ These functions are available to generate caches: * `generate_bans_cache()` * `generate_censoring_cache()` * `generate_config_cache()` +* `generate_emoji_cache()` * `generate_ranks_cache()` * `generate_stopwords_cache()` * `generate_update_cache()` diff --git a/categories.md b/categories.md new file mode 100644 index 0000000..f720838 --- /dev/null +++ b/categories.md @@ -0,0 +1,9 @@ +# Categories +## Add categories +Before you can create new forums, you need to create one or more categories. You can add new categories in the in the Backstage under Content > Board. Under 'Add categories' you type the name in the text box of the category you want to create. Click on 'Add'. The category appears under 'Manage board' panel with number as a block. Here you can change the title and the position of the category. + +## Delete categories +To delete categories, you simply select the categorie you want to delete in the drop down menu under 'Delete categories'. Then, you click on 'Remove'. Notice that all forums, threads and comments inside the categorie you remove, also will be removed. This is an irreversable action. + +## Edit categories +You can change 2 settings for your categories. The name, and the position. You can easily change the name of you category by changing the name in the text box. The position of the category is set with the number in the second field. How higher the number in the field, how lower the category is ranked in your forum. \ No newline at end of file diff --git a/censoring.md b/censoring.md new file mode 100644 index 0000000..aa02f4d --- /dev/null +++ b/censoring.md @@ -0,0 +1,14 @@ +# Censoring +With censoring, you can easily manage which words need to be replaced with another word. On this page, you are able to add, update and remove censored words. Remember that this also affects usernames and any content user can post on your board. + +## Add censored word +You can add a new censored word by entering a "Censored word" in the sidebar followed by a "Replacement word". + +Note that censoring a word affects the username, threads, comments, signatures and any other content an user can post. Additionally, Luna will censor only full appearance, so censoring "Lu" and replacing it with "Nu" won't result in "Luna" being written as "Runa". You can however use wildcards if you would like to achieve such an effect. + +If you censor a word and the replacement word itself is already censored as well, Luna will replace the word with the replacement word of your censored replacement wordn. + +## Editing and removing words +On the right hand side you can see an overview of all censored words and their replacement. Here you can change which words are censored and update them. Additionally, you can remove a word by clicking "Delete". + +Note that you cannot edit and remove multiple words at a time. Editing multiple words is possible, but removing words while doing that will cause the page to reset. First save your changes before removing words. \ No newline at end of file diff --git a/constants.md b/constants.md index 02cba76..d700f1e 100644 --- a/constants.md +++ b/constants.md @@ -68,17 +68,12 @@ require LUNA_ROOT.'include/common.php'; ``` ### `LUNA_DEBUG` -Defining `LUNA_DEBUG` enables debug mode, which makes Luna display more detailed/sensitive error messages. Script generation time and number of queries executed will also be shown in the footer. Debug mode should not be enabled on a production site, since it can potentially give a malicious user sensitive information about a server. However, enabling debug mode is an integral step to reporting/diagnosing forum errors. Without the information it provides, it can be nearly impossible for the developers to figure out the underlying cause of an issue. +Defining `LUNA_DEBUG` enables debug mode, which makes Luna display more detailed/sensitive error messages. Script generation time and number of queries executed will also be shown in the footer. Additionally, it makes all the queries executed during a pageview display in the footer. This feature is only useful for developing and should _never_ be used in a production environment because of the potential for disclosure of sensitive information. -```php -define('LUNA_DEBUG', 1); -``` - -### `LUNA_SHOW_QUERIES` -Defining `LUNA_SHOW_QUERIES` makes all the queries executed during a pageview display in the footer. This feature is only useful for developing and should never be used in a production environment because of the potential for disclosure of sensitive information. +However, enabling debug mode is an integral step to reporting/diagnosing forum errors. Without the information it provides, it can be nearly impossible for the developers to figure out the underlying cause of an issue. ```php -define('LUNA_SHOW_QUERIES', 1); +define('LUNA_DEBUG', 1); ``` ### `LUNA_TURN_OFF_MAINT` diff --git a/contributing.md b/contributing.md index c8d4b1a..5fe74f1 100644 --- a/contributing.md +++ b/contributing.md @@ -2,15 +2,44 @@ Do you want to make a pull request to Luna? Great! Through it is important to follow some rules. ## Where do I publish my pull request? -If you're pull request contains bugfixes, you can add the pull request to the then current branch (for example: version3.1), do not add a pull request to master, stable or unsupported branches. When a bugfix alters the way Luna functions, you're probably better of adding the pull request to the branch that's then in development. +If you're pull request contains bugfixes, you can add the pull request to the then current branch (for example: version2.1), do not add a pull request to master, stable or unsupported branches. When a bugfix alters the way Luna functions, you're probably better of adding the pull request to the branch that's then in development. If you're pull request contains new features, changes in behavior, code additions or large amounts of revised code, please add the pull request to the then current development branch, if you create a pull request to any other branch, we'll have to close your merge request as we can not add features to a stable and already released version of Luna or any other branch that is not named "versionX.X". If the current development branch is comment beta, you'll have to add your pull request to the next development branch instead. -## Do I have to create a ticket for a feature I want to see in Luna? +## Do I have to create a ticket for a feature I want to see in Luna? Wath about bugs? Depends on it, if you're able to code it yourself and think: "Why not, even if it isn't allowed, at least I've a working example for my own fork!", then no. If you create this feature and add a pull request to the official Luna repository, it will create a ticket for you. Describe properly what the pull request contains, how better explained, the more is the chance that it will make it to the official Luna core. +For bugs, you best make a ticket, unless you are able to fix it yourself and are willing to push that to Luna with a pull request. + +Found a bug? Report it on GitHub!
+Woud you like to see something new? Request it on GitHub!
+A basic guide to using Luna
+System requirements and installation instructions
Manage your board
+All about the front-end
+How to build extentions, translations and themes
How to help us develop Luna
Designing Luna
Woud you like to see something new? Request it on GitHub!
+footer.php"},
+ { "id": "theming_header", "title": "Theming header.php"},
+ { "id": "theming_profile", "title": "Theming profile.php"},
+ { "id": "theming_settings", "title": "Theming settings.php"},
+ { "id": "theming_pagination", "title": "Theming pagination" }
+ ]
+ }, {
+ "title": "Translations",
+ "icon": "fal fa-fw fa-language",
+ "pages" : [
{ "id": "translations", "title": "Language packs" }
]
+ }, {
+ "title": "Plugins",
+ "icon": "fal fa-fw fa-puzzle-piece",
+ "pages" : [
+ { "id": "plugins", "title": "Plugins" }
+ ]
}, {
"title": "References",
- "icon": "fal fa-fw fa-bookmark",
+ "icon": "fal fa-fw fa-id-card",
"pages" : [
- { "id": "constats", "title": "Constants" },
+ { "id": "constants", "title": "Constants" },
{ "id": "dbstructure", "title": "Database structure" },
{ "id": "dblayer", "title": "Database layer" },
{ "id": "variables", "title": "Global variables" },
@@ -94,14 +170,15 @@
},
{
"id": "develop",
- "index": "index_develop",
+ "index": "tools",
"categories": [
{
"title": "Develop",
"icon": "fal fa-fw fa-wrench",
"pages" : [
- { "id": "php_conventions", "title": "PHP coding conventions" },
- { "id": "css_conventions", "title": "CSS coding conventions" }
+ { "id": "tools", "title": "Developer tools" },
+ { "id": "conventions", "title": "Coding conventions" },
+ { "id": "css_conventions", "title": "(S)CSS coding conventions" }
]
}, {
"title": "Contributing",
@@ -123,7 +200,7 @@
},
{
"id": "design",
- "index": "index_design",
+ "index": "identity",
"categories": [
{
"title": "Brand",
diff --git a/php_conventions.md b/php_conventions.md
deleted file mode 100644
index 26f38e7..0000000
--- a/php_conventions.md
+++ /dev/null
@@ -1,55 +0,0 @@
-# PHP coding conventions
-Pruned comments, notifications and users can never be restored.
+The prune feature can be used to delete old inactive comments from your forums, notifications or inactive users. + +For best performance, you should put the forum in maintenance mode during pruning.
+ +## Notifications +Pruning notifications can be useful if you have a large board and rather not have the notification table grow to much. + +* __Days old__: the number of days old a notifications should be before it is considered to be pruned. +* __Type__ + * __All notifications__: any notification that has the given age will be removed, no matter the stat it is in. + * __Sene notifications__: only notifications that already have been interacted with will be pruned as long as they are older than the days given. Any unseen notification that is beyond the given age will remain available. + * __New notifications__: only notifications that have not yet been interacted with will be pruned as long as they are older than the days given. Any seen notification that is beyond the given age will remain available. + +## Comments +Pruning comments is highly discourage as this might break some threads. + +* __Days old__: the number of days old a comment should be before it is considered to be pruned. +* __Prune pinned threads__: whether or not pinned threads should also be pruned. +* __Prune from__: the forum which you want to prune, or you could choose to prune all forums. + +## Users +Pruning users can be also be done but is once again highly discouraged. + +* __Minimum days__: minimum number of days since the action specified in "Since". +* __Since__ + * __Registration__: look at the registration date to remove the user. + * __Last login__: look at the last login date to remove the user. +* __Maximum number of comments__: maximum number of comments an user can have before he/she is pruned. +* __Delete management__: delete users with management access. +* __User status__ + * __Delete any__: delete any type of user, no matter their verification. + * __Delete only verified__: delete any user that matches the requirements and has been verified. + * __Delete only unverified__: delete any user that matches the requirements and has been unverified. \ No newline at end of file diff --git a/ranks.md b/ranks.md new file mode 100644 index 0000000..7781c7a --- /dev/null +++ b/ranks.md @@ -0,0 +1,11 @@ +# Ranks +With ranks, you can give users a subtitle when they reach a comment count. You can easily add new ranks at the page 'Ranks' in the admin panel. + +## Create ranks +You can create a new rank by cacking on 'Add' under 'Add new rank'. + +## Edit ranks +You can edit a rank under 'Existing ranks'. You just need to cack on 'Edit' to see the settings of the rank. + +## Remove ranks +To remove ranks, you just need to cack on 'Delete' in the row of the rank you want to delete. \ No newline at end of file diff --git a/reports.md b/reports.md new file mode 100644 index 0000000..2353857 --- /dev/null +++ b/reports.md @@ -0,0 +1,10 @@ +# Reports +Reports are a way for the users of your board to help you manage the content on it. When one of your users reports a comment, he/she can provide a reason. All of this is displayed under "Reprots". + +## New reports +New reports are listed under "New reports". Here you can see any of the reports that nobody has yet interacted with. The titlebar of a report shows you who reported it at what time. Below that is the breadcrumb path to where the comment that was reported originated from. + +Then you can see the reason the user reported the comment with the comment. From here on out, we give you 3 options: "Mark as read" to move it to "Old reports", "Edit" to edit the comment and "Remove" to remove the comment entirely. Note that "Remove" will remove an entire thread if the reported comment is the first comment in the thread. + +## Old reports +Old reports show you the same information as new reports, however the options have been swapped out by a text telling you who of your moderators managed the report. \ No newline at end of file diff --git a/settings.md b/settings.md new file mode 100644 index 0000000..8b8d647 --- /dev/null +++ b/settings.md @@ -0,0 +1,56 @@ +# Settings +## Branding +* __Title__: the title of your board, will be used in the page title as well as within the theme if supported. +* __Slogan__: the slogan of your brand, can be used by the theme if supported. +* __Description__: a text of 300 characters that describes your board, used for SEO purposes. This is the text that will appear is the results of search engines when people look for your board. +* __Default language__: the default language of your board is used for all guests and new accounts. If two or more languages are available in the `lang` folder in Luna's root, registered users can change their language. Changing the default language won't change the language for users that are already registered, unless it is the only available language. +* __Tags__: a list of keywords that best describe your board, use for SEO purposes. +* __Favicon__: an icon used by the browser and operating system of the user to visually identify your website. For more information on where browsers use the favicon, see [Wikipedia](https://en.wikipedia.org/wiki/Favicon#Use_of_favicon). We strongly recommend the use of `.png` files in a high resolution. + +## Announcement +* __Announcement__: shows an announcement at the top of the board. Its location may be different between themes. +* __Title__: the title of the announcement, optional field. +* __Type__: the type of the announcenment, mostly used within themes to decide a color. +* __Message__: the message of the announcement. This text has to be filled, otherwise Luna will set the default value. + +## Time and timeouts +* __Time format__: the time format in which the board should show all times by default, users can override this setting in their account. Changing the default time format won't change the time format for users that are already registered. +* __Date format__: the date format in which the board should show all dates by default, users can override this setting in their account. Changing the default date format won't change the time format for users that are already registered. +* __Default time zone__: the time zone in which the board should show all times by default, users can override this setting in their account. Changing the default time zone won't change the time zone for users that are already registered. +* __Visit timeout__: the number of seconds it takes before an user is no longer considered "visiting". +* __Online timeout__: the number of secconds before the users is no longer considered online. + +## Syndication +* __Default feed type__: the default type of feed you want your users to have access to. +* __Duration to cache feeds__: duration of how long the feed will be cached. + +## E-mail +* __Admin email__: the e-mail address of the main admin. +* __Webmaster email__: the e-mail address that will be used as address from which Luna will send e-mails to its users. +* __Reporting method__: the way you want to be kept up-to-date on new reports. +* __Mailing list__: a list of e-mail addresses separated by commas that will receive new reports. + +## Registration +* __New registrations__: allow guests to create new accounts. +* __Mailing list notifications__: send a mail to everyone on the mailing list when a new user is made. +* __Verify__: require new users to verify their e-mail address. +* __Banned addresses__: allow new users to use e-mail addresses or domains that have been banned, everyone on the mailing list will receive a warning. +* __Double address__: allow users to use an e-mail address that already has been used, everyone on the mailing list will receive a warning +* __Rules__: enables whether or not the board has rules. Enabling this option will also add a "Rules" panel to the help-section of your board. +* __Message__: the message with the rules. Will be shown during registration as well as in the help-section. +* __Default email setting__: default setting for new users on how visible their e-mail address is to other users. + +## Cookie bar +* __Cookie bar__: shows a bar at the bottom of your board with information about cookies. For more information, see [cookies](http://getluna.org/docs/cookies). +* __Cookie info URL__: the url with information about cookies, by default this links to this documentation's cookies document. + +## SMTP settings +* __SMTP server address__: the address of the external SMTP server with which Luna can send e-mails. +* __SMTP username__: the username of the SMTP server. +* __SMTP password__: the password of the SMTP server. If you want to delete a password, simply check the checkbox in this field. +* __SMTP encryption__: encyrpt the SMTP connection with SSL if supported. + +## System +* __Root URL__: the URL on which the homepage of your board can be reached. If this setting isn't correct, you won't be able to change most things and will receive a higher amount of errors. +* __CDN__: whether or not to use a CDN to get Bootstrap and jQuery. When enabled it may improve performance and lower bandwidth usage of your host. Note however that Luna becomes dependent on third party services when this is enable so when these services go down, so will parts of your board. +* __Gzip output__: Gzip output sent to the browser. This will reduce bandwidth usage, but use some more CPU. This feature requires that PHP is configured with zlib. If you already have one of the Apache modules (mod_gzip/mod_deflate) set up to compress PHP scripts, disable this feature. \ No newline at end of file diff --git a/setup.md b/setup.md deleted file mode 100644 index 27a042c..0000000 --- a/setup.md +++ /dev/null @@ -1,43 +0,0 @@ -# Setting up your board -Here are some pages in the Backstage you might want to stop by after you've set up your brand new forum. - -## Settings -### Settings -Change basic setting like the title and discription. This is also the place where you can change the default time zone, daylight savings and other time-related settings. Also, you can change the default language of your forum (for guests and new users), feed settings, how Luna should handle reported comments, avatar settings, and finally, announcements. - -### Features -Under 'Features' you can change the functions that are available on your board, like parser settings, First Run settings, and more. Also, you can activate censoring. - -### Appearance -Here you can change the appearance of your board. Things like displaying the version number of Luna in the footer info about users. Also, you can enable smilies and made links are clickable without the need to put them between [url]-tags. Also, you can change here the number of threads and comments on one page. - -### Registration -Here, you can disable new registrations. Also, you can activate a security features that asks at new members to verify themselfs. You also can add here forum rules, when you activate 'User forum rules', a new button, 'Rules', will be added to the menu of your Luna installation. - -### Email -Change email settings, like the adres of the forums admin and webmaster, the abbility to subscribe to forums and threads and your SMTP settings. - -### Menu -Under the menu settings, you can change to items in the menu. You can't delete default items, but you can hide them. - -### Themes -This page contains an overview of all themes that are available to your installation. You can change the look of your board here and change settings of themes in case they have their own settings. - -## Users -### Permissions -Probably the most critical part of setting up a new forum is getting the permissions right. - -To setup a working and useful permission hierarchy, you can create user groups in the administration panel. Click on "User groups" and you will see the four default user groups - Administrators, Moderators, Members and Guests. - -### Ranks -See [ranks](organizing) - -### User groups -See [groups](organizing) - -## Content -### Board -See [categories and forums](organizing) - -### Censoring -With censoring, you can easily manage which words need to be replaced with another word. On this page, you are able to add, update and remove censored words. Remember that this also affects usernames. \ No newline at end of file diff --git a/theme.md b/theme.md new file mode 100644 index 0000000..7f7359a --- /dev/null +++ b/theme.md @@ -0,0 +1,18 @@ +# Theme +Starting with Luna 2.1, themes required to be installed first. No worries when you're upgrading, though, Luna will take care of Typography, Fifteen and Sunrise when you cross the line between FluxBB/ModernBB/Luna 1.x-2.0 and 2.1 for the first time. + +## Installed themes +All themes that are installed are listed here. Luna will show you the title and version of the theme, as well as a description, the developer and a link to the developer's page. From here you can take a number of actions: + +* __Activate__: activating the theme will set it as your boards theme. This might have a number of side effects: + * If the theme supports less accents than your previous theme, you or your users might have set an accent `id` that no longer exists. For those users and the default accent setting, the accent will be reset to `1`, which every theme is required to have. +* __Uninstall__: uninstalls the theme. This will remove all data the theme might hold in the database. This action is irreversable. +* __Update__: if a theme's installed version is out of sync with the version available in the `/themes/`-folder, you will have to update it. Your theme might already work as expected, but an update might add new configuration options that previous versions did not have, or remove them. Note that Luna's updater will automatically take care of updating Typography, Fifteen and Sunrise is they are installed. + +Further, themes can add their own actions like "Settings" and more. + +## Available themes +Themes that are "available" have a folder in the `/themes/`-folder in the root of your Luna installation but have not been installed. From here, you can take a number of actions: + +* __Install__: installing the theme will add all configurations that the theme might have to your database and make it possible for you to activate it. +* __Delete__: delete will remove the entire folder of the theme from your installation, this action is irreversable. \ No newline at end of file diff --git a/themes.md b/themes.md index 7937b22..bdbaaf3 100644 --- a/themes.md +++ b/themes.md @@ -5,7 +5,7 @@ Unlike the old ModernBB Style Engine (version 5.2 and prior), the Luna Theme Eng This is a list of files that are required to be in your theme, grouped to show you which files are required for which type of theme. ### Required for parent and child themes -* `information.php` +* `theme.json` * `style.css` ### Required for parent theme, optional for child theme @@ -16,7 +16,6 @@ This is a list of files that are required to be in your theme, grouped to show y * `header.php` * `help.php` * `inbox.php` -* `inbox-delete.php` * `inbox-delete-comment.php` * `inbox-new.php` * `inbox-view.php` @@ -48,41 +47,127 @@ This is a list of files that are required to be in your theme, grouped to show y * `user.php` ### Optional for parent and child themes -* `theme_settings.php` * Any other file you can think of -## information.php -The `information.php`-file contains basic information about your theme that is used on the Backstage's Theme-page. The content of the file should look like the example below. This example is from the Sunrise child theme based on Fifteen. +## theme.json +The `theme.json`-file contains basic information about your theme that is used on the Backstage's Theme-page. The content of the file should look like the example below. This example is from the Sunrise child theme based on Fifteen. Note that prior to version 2.1, the `information.php`-file was used for this, themes still using this file without a `theme.json` file won't work in Luna 2.1 and higher. -```php - - +```json +{ + "id": "sunrise", + "name": "Sunrise", + "developer": "Studio 384", + "url": "https://getluna.org", + "description": "Sunset is a variant upon Fifteen, featuring a more classic design.", + "date": "14 June 2018", + "version": "3.1-alpha.3", + "minversion": "2.1-alpha.3", + "maxversion": "2.1-alpha.3", + "parent": "fifteen", + "features": { + "accents": [ + { "id": 1, "color": "#14a3ff" }, + { "id": 2, "color": "#2788cb" }, + { "id": 3, "color": "#0d4382" }, + { "id": 4, "color": "#c58be2" }, + { "id": 5, "color": "#ea69ae" }, + { "id": 6, "color": "#8bb805" }, + { "id": 7, "color": "#047a36" }, + { "id": 8, "color": "#ffcd21" }, + { "id": 9, "color": "#ff7521" }, + { "id": 10, "color": "#ff4444" }, + { "id": 11, "color": "#c71f1f" }, + { "id": 12, "color": "#c78d68" }, + { "id": 13, "color": "#ccc" }, + { "id": 14, "color": "#999" }, + { "id": 15, "color": "#444" } + ], + "announcement_types": true, + "back_to_top": true, + "copyright": true, + "custom_copyright": true, + "custom_css": true, + "first_run": true, + "header_background": true, + "header_search": true, + "moderated_by_list": false, + "night_mode": true, + "notification_flyout": true, + "statistics": true + }, + "config": [ + { "name": "sunrise_installed", "default": 1 }, + { "name": "activated_sunrise", "default": 1 } + ] +} +``` - +* __id__: the id of the theme, this has to be unique. While it is unlikely that 2 themes with the same ID will be on the same installation, it is perhaps best adviced to use the name of the theme in lowercase followed by a random string. +* __name__: the name of the theme. +* __developer__: the person, people or organization that developed the theme. +* __url__: the URL to the developer's page. +* __description__: a short description of what the theme has to offer. +* __date__: the date of release of the current version. +* __version__: the version of the theme. +* __minversion__: the minimum required version of Luna that this theme can run on. +* __maxversion__: the maximum required version of Luna that this theme can run on. +* __parent__: optional field to indicate that the theme is a child theme and what its parent is. Files that are required but are not present in the theme will be searched for in the team listed here. +* __features__: a list of features the theme supports. When not supported, Luna can show a warning next to the relevant setting in the Backstage to notify the user that these functions won't work. For a full liskt of options, see the features-table below. +* __config__: an array of values you want to add to the `config` table for your theme to manage. - -XML; -> -``` +### Theme features +Themes can declare in their `theme.json`-file which Luna features are supported by them in the `features`-field. + +| Name | Value type | Default | Required | Description | +| --- | --- | --- | +| `accents` | `array` | _none_ | Yes | A list consisting of `id` and `color` paires of accents supported by the theme | +| `announcement_types` | `boolean` | `false` | No | Whether or not different announcement types are supported | +| `back_to_top` | `boolean` | `false` | No | Whether or not "Back to top" is supported | +| `copyright` | `boolean` | `false` | No | Whether or not the theme shows a copyright message | +| `custom_copyright` | `boolean` | `false` | No | Whether or not the copyright message can be customized | +| `custom_css` | `boolean` | `false` | No | Whether or not the theme supports custom cSS | +| `first_run` | `boolean` | `false` | No | Whether or not the theme supports the First run experience | +| `header_background` | `boolean` | `false` | No | Whether or not the theme can use a header background | +| `header_search` | `boolean` | `false` | No | Whether or not the theme has a search field available outside the search page | +| `moderated_by_list` | `boolean` | `false` | No | Whether or not the "Moderated by" list is showsn | +| `night_mode` | `boolean` | `false` | No | Whether or not the theme support a dark mode | +| `notification_flyout` | `boolean` | `false` | No | Whether or not the theme supports a notification fly-out | +| `statistics` | `boolean` | `false` | No | Whether or not the theme supports showing statistics | + +#### Accents +Luna requires themes to at least support 1 accent color. If only 1 accent color is included in a theme, the Backstage will show the theme as not suppoting accent colors. + +| Name | Value type | Default | Required | Description | +| --- | --- | --- | +| `id` | `integer` | _none_ | Yes | An unique integer to identify the accent | +| `color` | `string ` | _none_ | Yes | Any valid value that can be set for the `background` property in CSS like `#2788cb` or go with a fancy gradient like `linear-gradient(141deg, #0fb8ad 0%, #1fc8db 51%, #2cb5e8 75%)`, or anthing else | + +### Theme config +Themes can declare in their `theme.json`-file which any new config they want to use and add to the database. Upon installation by the users thes configurations are added to the database, when uninstalled, they are dropped again. + +| Name | Value type | Default | Required | Description | +| --- | --- | --- | +| `name` | `string` | _none_ | Yes | The name of the configuration. Luna will automatically add `t_styleid_` as a prefix | +| `value` | `undefined` | _none_ | Yes | The default value opun installation | -The only optional parameter in this file is `In Preview 5, the User-object contains functions that call data from the group of the user as well as the online information. These functions are introduced in Preview 5 but won't be available anymore in future previews.
+ +```php +class User { + int private $id + int private $group_id + string private $username + string private $password + string private $salt + string private $email + string private $title + string private $realname + string private $url + string private $facebook + string private $microsoft + string private $twitter + string private $google + string private $location + string private $signature + int private $email_setting + int private $notify_with_comment + int private $auto_notify + int private $show_img + int private $show_sig + private $php_timezone + string private $time_format + string private $date_format + string private $language + int private $num_comments + Timestamp private $last_comment + Timestamp private $last_search + Timestamp private $last_email_sent + Timestamp private $last_report_sent + Timestamp private $registered + string private $registration_ip + Timestamp private $last_visit + string private $admin_note + string private $activate_string + string private $activate_key + int private $use_inbox + int private $num_inbox + int private $first_run + int private $color_scheme + int private $adapt_time + int private $accent + + int private $g_id + string private $g_title + string private $g_user_title + int private $g_moderator + int private $g_mod_edit_users + int private $g_mod_rename_users + int private $g_mod_change_passwords + int private $g_mod_ban_users + int private $g_read_board + int private $g_view_users + int private $g_comment + int private $g_create_threads + int private $g_edit_comments + int private $g_delete_comments + int private $g_delete_threads + int private $g_set_title + int private $g_search + int private $g_search_users + int private $g_send_email + int private $g_comment_flood + int private $g_search_flood + int private $g_email_flood + int private $g_inbox + int private $g_inbox_limit + int private $g_report_flood + int private $g_soft_delete_view + int private $g_soft_delete_comments + int private $g_soft_delete_threads + + Timestamp private $o_logged + Timestamp private $o_idle + + void public __construct() + + MenuItem public static withId( int $id ) + MenuItem public static withRow( array $row ) + void protected getById( int $id ) + void protected fill( array $row ) + void public save() + + // Setters + User public setId( $id ) + User public setGroup( $group_id ) + User public setUsername( $username ) + User public setPassword( $password ) + User public setSalt( $salt ) + User public setEmail( $email ) + User public setTitle( $title ) + User public setRealname( $realname ) + User public setFacebook( $facebook ) + User public setMicrosoft( $microsoft ) + User public setTwitter( $twitter ) + User public setGoogle( $google ) + User public setLocation( $location ) + User public setSignature( $signature ) + User public setEmailSetting( $email_setting ) + User public setNotifyWithComment( $notify_with_comment ) + User public setAutoNotify( $auto_notify ) + User public setShowImg( $show_img ) + User public setShowSig( $show_sig ) + User public setPhpTimezone( $php_timezone ) + User public setTimeFormat( $time_format ) + User public setDateFormat( $date_format ) + User public setLanguage( $language ) + + User public setNumComments( $num_comments ) + User public setLastComment( $last_comment ) + User public setLastSearch( $last_search ) + User public setLastEmailSent( $last_email_sent ) + User public setLastReportSent( $last_report_sent ) + User public setRegistered( $registered ) + User public setRegistration_ip( $registration_ip ) + User public setLastVisit( $last_visit ) + User public setAdminNote( $admin_note ) + User public setActivateString( $activate_string ) + User public setActivateKey( $activate_key ) + User public setUseInbox( $use_inbox ) + User public setNumInbox( $num_inbox ) + User public setFirstRun( $first_run ) + User public setColorScheme( $color_scheme ) + User public setAdaptTime( $adapt_time ) + User public setAccent( $accent ) + User public setGId( $g_id ) + User public setGTitle( $g_title ) + User public setGUserTitle( $g_user_title ) + User public setGModerator( $g_moderator ) + User public setGModEditUsers( $g_mod_edit_users ) + User public setGModRenameUsers( $g_mod_rename_users ) + User public setGModChangePasswords( $g_mod_change_passwords ) + User public setGModBanUsers( $g_mod_ban_users ) + User public setGReadBoard( $g_read_board ) + User public setGViewUsers( $g_view_users ) + User public setGComment( $g_comment ) + User public setGCreateThreads( $g_create_threads ) + User public setGEditComments( $g_edit_comments ) + User public setGDeleteComments( $g_delete_comments ) + User public setGDeleteThreads( $g_delete_threads ) + User public setGSetTitle( $g_set_title ) + User public setGSearch( $g_search ) + User public setGSearchUsers( $g_search_users ) + User public setGSendEmail( $g_send_email ) + User public setGCommentFlood( $g_comment_flood ) + User public setGSearchFlood( $g_search_flood ) + User public setGEmailFlood( $g_email_flood ) + User public setGInbox( $g_inbox ) + User public setGInboxLimit( $g_inbox_limit ) + User public setGReportFlood( $g_report_flood ) + User public setGSoftDeleteView( $g_soft_delete_view ) + User public setGSoftDeleteComments( $g_soft_delete_comments ) + User public setGSoftDeleteThreads( $g_soft_delete_threads ) + User public setOLogged( $o_logged ) + User public setOIdle( $o_idle ) + + // Getters + int public getId() + int public getGroup() + string public getUsername() + string public getPassword() + string public getSalt() + string public getEmail() + string public getTitle( $personal = false ) + string public getAvatar() + string public getRealname() + string public getUrl() + string public getFacebook() + string public getMicrosoft() + string public getTwitter() + string public getGoogle() + string public getLocation() + string public getSignature( $raw = true ) + int public getEmailSetting() + int public getNotifyWithComment() + int public getAutoNotify() + int public getShowImg() + int public getShowSig() + string public getPhpTimezone() + string public getTimeFormat() + string public getDateFormat() + string public getLanguage() + int public getNumComments( $raw = false ) + DateTime public getLastComment( $raw = false ) + DateTime public getLastSearch( $raw = false ) + DateTime public getLastEmailSent( $raw = false ) + DateTime public getLastReportSent( $raw = false ) + DateTime public getRegistered( $raw = false ) + string public getRegistration_ip() + DateTime public getLastVisit( $raw = false ) + string public getAdminNote() + string public getActivateString() + string public getActivateKey() + int public getUseInbox() + int public getNumInbox() + int public getFirstRun() + int public getColorScheme() + int public getAdaptTime() + int public getAccent() + + public getGId() + public getGTitle() + public getGUserTitle() + public getGModerator() + public getGModEditUsers() + public getGModRenameUsers() + public getGModChangePasswords() + public getGModBanUsers() + public getGReadBoard() + public getGViewUsers() + public getGComment() + public getGCreateThreads() + public getGEditComments() + public getGDeleteComments() + public getGDeleteThreads() + public getGSetTitle() + public getGSearch() + public getGSearchUsers() + public getGSendEmail() + public getGCommentFlood() + public getGSearchFlood() + public getGEmailFlood() + public getGInbox() + public getGInboxLimit() + public getGReportFlood() + public getGSoftDeleteView() + public getGSoftDeleteComments() + public getGSoftDeleteThreads() + + public getOLogged() + public getOIdle() + + public getThreadsUrl() + public getCommentsUrl() + public getSubscriptionsUrl() + + // Checks + bool public hasContactInfo() +} +``` \ No newline at end of file diff --git a/theming_settings.md b/theming_settings.md new file mode 100644 index 0000000..77b788e --- /dev/null +++ b/theming_settings.md @@ -0,0 +1,7 @@ +# Theming `settings.php` +For themes, `settings.php` is probably one of the most complex pages to design as it contains a lot of options that all have to be implemented. + +## `$user` +The `$user`-variable contains all relevant information about the user whos profile you are looking at, not to be confused with `$luna_user`. `$user` returns a `User`-object. + +See [themingprofile.php](theming_profile) for more information.
\ No newline at end of file
diff --git a/tickets.md b/tickets.md
index 226d9b1..a357f48 100644
--- a/tickets.md
+++ b/tickets.md
@@ -1,7 +1,47 @@
# Creating tickets
Tickets are our way of communicating in the development tracker, tickets can contain bugs, features or changes. If you file your own issue, especialy if it is a bug, and you're not part of the Luna development team, it's important to follow some guidelines so someone understands what you mean. This is also the case for pull requests.
+
+
## Include an extended description
-Always include an extended description in your ticket. What do you want to archive? How do you reproduce that bug? What should the feature you want have to do? Those are all important question to include in a ticket, depending on what you are reporting (new feature/enhancement/bug).
+When requesting a new feature or reporting a bug on GitHub, you will be provided with a template to fill out. It is, of course, recommended to fill out this template. You can get to these templates from the options below.
-If you're reporting a bug, it is also important to give additional information. Where does it happen? Does it happen on every browser, if not, which are affected? Is it a security-related issue? How can we reproduce this bug?
\ No newline at end of file
+Found a bug? Report it on GitHub!
+Woud you like to see something new? Request it on GitHub!
+Always make a backup of your forum before updating. While we obviously test Luna to the best of our ability it is hard to simulate every single situation, especially when sites are using languages none of us know. The update script does have potential to corrupt your database in the unlikely event that something goes wrong.
+ +### Overwriting files +The easiest option is to simply overwrite the old files with the new ones. While this is the easiest way to update, it is also the least flexible: any modifications you have made to files that you overwrite will be lost. + +* [Download](https://getluna.org) the new files and decompress them. +* Upload the contents of the directory, overwriting the existing files. +* Visit your website, you'll be requested to click a button to install the updated. + +If you have applied any modification, it's recommended to apply these modifications to the new version before updating, however, it's important to stay up-to-date with the latest version for obvious reasons. + +If you have made a number of modifications to Luna, it might be useful to fork the original repository on GitHub, make your changes in that fork and then pull newer versions of Luna whenever they are released. Git might be able to take care of some of your changes itself. + +## About +The about page contains the changelog for the current version of Luna you are using. When a patch is released and you update to it, the changes included in that patch will be listed here as well. + +During preview reelases, the release notes of the then-current version of Luna will be included as well as a changelog for each preview update. When the preview ends and a new major or minor version of Luna is ready, the changelog for the preview updates get condenced into one single log and the changelog for the previous version is dropped. \ No newline at end of file diff --git a/upgrading.md b/upgrading.md deleted file mode 100644 index d2ccc26..0000000 --- a/upgrading.md +++ /dev/null @@ -1,22 +0,0 @@ -# Updating -With those instructions, you can update your board to the latest version of Luna. All versions of Luna can be updated to a newer version. You can upgrade to Luna 1.1 and higher from the following versions of FluxBB, ModernBB and Luna: - -* __FluxBB__: all versions as of 1.4.0 supported -* __ModernBB__: all versions supported -* __Luna__: all versions supported - -If you're upgrading to Luna 1.0.10 or lower, there is a limit from which version you can do so. We do not recommend to use Luna 1.0.x release anymore and strongly recommend you to use the latest stable release of Luna. Below is a list of all releases that support upgrading to Luna 1.0: - -* __ModernBB__: all versions as of 3.5.0 supported -* __Luna__: all versions supported - -Always make a backup of your forum before updating. While we obviously test Luna to the best of our ability it is hard to simulate every single situation, especially when sites are using languages none of us know. The update script does have potential to corrupt your database in the unlikely event that something goes wrong.
- -## Overwriting files -The easiest option is to simply overwrite the old files with the new ones. While this is the easiest way to update, it is also the least flexible: any modifications you have made to files that you overwrite will be lost. - -* [Download](https://getluna.org) the new files and decompress them. -* Upload the contents of the directory, overwriting the existing files. -* Visit your website, you'll be requested to click a button to install the updated. - -If you have applied any modification, it's recommended to apply these modifications to the new version before updating, however, it's important to stay up-to-date with the latest version for obvious reasons. \ No newline at end of file diff --git a/variables.md b/variables.md index 0393b2f..847c5af 100644 --- a/variables.md +++ b/variables.md @@ -1,5 +1,5 @@ # Global variables -Below is a list of global variables which can be found within any Luna script (i.e. are set when `include/common.php` is included). The most used and important ones are probably $db, $luna_user and $luna_config. +Below is a list of global variables which can be found within any Luna script (i.e. are set when `include/common.php` is included). The most used and important ones are probably `$db`, `$luna_user` and `$luna_config`. ## Configuration variables The below variables are defined by the admin within config.php during installation. Usually they should not be needed once the database connection has been set up and the users cookie has been authenticated. @@ -20,7 +20,7 @@ The username required to access the database. The password required to access the database. ### `$db_prefix` -The table prefix used within the database (to allow multiple Luna installs within one database). This can also (and should be) accessed using `$db→prefix`, for more information see the Database layer page. +The table prefix used within the database (to allow multiple Luna installs within one database). This can also (and should be) accessed using `$db→prefix`, for more information see [database layer](dblayer). ### `$cookie_name` The name of the cookie which Luna uses to keep track of a users session. @@ -34,10 +34,10 @@ Used to seed the password hash stored within the users cookie. The variables below are the most important global variables within Luna. ### `$db` -The `$db` variable is an instance of the Database layer, used for communicating with the underlying database. For more information please see the Database layer page. +The `$db` variable is an instance of the [database layer](dblayer), used for communicating with the underlying database. For more information please see the [database layer](dblayer) page. ### `$luna_user` -The `$luna_user` variable is an associative array which holds information (taken from the users and groups database tables) about the current logged in user (or guest). +The `$luna_user` variable is an associative array which holds information (taken from the [users and groups](dbstructure) database tables) about the current logged in user (or guest). As well as the information from the users and groups tables it also holds a few other values: @@ -57,27 +57,26 @@ $luna_user['is_admmod'] = $luna_user['g_id'] == LUNA_ADMIN || $luna_user['g_mode ``` ### `$luna_config` -The `$luna_config` variable holds an associative array with the contents of the config database table. Please note that to save querying the database on every page load this variable is cached, simply updating the database will not cause the cache to refresh. +The `$luna_config` variable holds an associative array with the contents of the [config](dbstructure) database table. Please note that to save querying the database on every page load this variable is [cached](caching), simply updating the database will not cause the cache to refresh. + +#### Settings +The configs listed below are part of `$luna_config` and can all be manipulated through the Backstage. | Name | Default value | Description | | --- | --- | --- | -| `o_cur_version` | `"1.3.0"`* | The current version of Luna that is installed. | -| `o_core_version` | `"1.3.5118"`* | The current version of Luna core that is installed. | -| `o_code_name` | `"denim"`* | The current name of Luna core that is installed. | -| `o_database_revision` | `"90.70"`* | The current version of the database structure. | -| `o_searchindex_revision` | `"2.0"`* | The current version of the search index engine. During an update if this increments all comments will be indexed again. | -| `o_parser_revision` | `"11.2.0"`* | The current version of the parser. During an update, if this increments all comments will be preparsed again. | -| `o_board_title` | `"Denim"`* | The title of the forum, by default Luna uses its current code name. | -| `o_board_desc` | `"You can do anything"`* | A short description of the forum, usually displayed below the board title, by default the Luna slogan. | -| `o_default_timezone` | `"0"` | The default time zone (offset from UTC). | +| `o_board_title` | `"Fallow"`* | The title of the forum, by default Luna uses its current code name. | +| `o_board_tags` | `"NULL"` | A number of keywords that describe the board best. | +| `o_board_slogan` | `"You can do anything"`* | The slogan of your brand. | +| `o_board_desc` | `"NULL"` | A short description of the forum, usually displayed below the board title. | +| `o_timezone` | `"UTC"` | The default time zone. | | `o_time_format` | `"H:i"` | The default time format string (see the PHP [date](http://uk2.php.net/manual/en/function.date.php) function). | -| `o_date_format` | `"j M Y"` | The default date format string (see the PHP [date](http://uk2.php.net/manual/en/function.date.php) function). | +| `o_date_format` | `"j F Y"` | The default date format string (see the PHP [date](http://uk2.php.net/manual/en/function.date.php) function). | | `o_timeout_visit` | `"1800"` | Number of seconds a user must be idle before his/hers last visit data is updated (primarily affects new message indicators). | | `o_timeout_online` | `"300"` | Number of seconds a user must be idle before being removed from the online users list. | | `o_show_user_info` | `"1"` | Show users information (such as location, registration date, contact link, etc…) with their comments? | | `o_show_comment_count` | `"1"` | Show users comment count? | | `o_signatures` | `"1"` | Enable the use of signatures? | -| `o_smilies_sig` | `"1"` | Allow the user of smilies inside users signatures? | +| `o_smilies_sig` | `"1"` | Allow the user of emoji inside users signatures? | | `o_make_links` | `"1"` | Automatically convert URLs in comments to links? | | `o_default_lang` | `"English"`* | The default language pack to be used. | | `o_default_style` | `"Fifteen"`* | The default theme to be used. | @@ -99,13 +98,14 @@ The `$luna_config` variable holds an associative array with the contents of the | `o_regs_report` | `"0"` | Should new registrations be emailed to the mailing list (see o_mailing_list)? | | `o_default_email_setting` | `"1"` | What should the default email setting be for newly registered users? 0 = Display email address, 1 = Hide email address but allow form emails, 2 = Hide email address and disallow form emails. | | `o_mailing_list` | `""` | A comma separated list of email addresses to which reports should be delivered. | +| `o_moderate_by` | `"1"` | Show a list of moderators below each forum. | | `o_avatars` | `"1"` | Enable the use of users avatars? | | `o_avatars_dir` | `"img/avatars"` | The (relative) path of the directory where users avatars should be stored. | | `o_avatars_width` | `"128"` | The maximum width (in pixels) that a users avatar may be. | | `o_avatars_height` | `"128"` | The maximum height (in pixels) that a users avatar may be. | | `o_avatars_size` | `"30720"` | The maximum size (in bytes) that a users avatar may be. | | `o_search_all_forums` | `"1"` | Allow users to search all forums at once? | -| `o_base_url` | `"http://www.example.org/forums"`* | The base URL of the forum (without the trailing slash) | +| `o_base_url` | `"http://www.example.org/forums"`* | The base URL of the forum (without the trailing slash) | | `o_admin_email` | `"admin@example.org"`* | The email address of the forum administrator. | | `o_webmaster_email` | `"webmaster@example.org"`* | The email address from which emails sent should be addressed. | | `o_forum_subscriptions` | `"1"` | Allow users to subscribe to forums (receive an email when someone makes a new thread)? | @@ -120,9 +120,7 @@ The `$luna_config` variable holds an associative array with the contents of the | `o_smtp_ssl` | `"0"` | Does the SMTP server require SSL? | | `o_regs_allow` | `"1"` | Allow new users to register? | | `o_regs_verify` | `"0"` | Verify new registrations by sending a verification email to their email address? | -| `o_video_width` | `"640"` | The width of an embedded video. | -| `o_video_height` | `"360"` | The height of an embedded video. | -| `o_advanced_search` | `"1"` | Enable the use of advanced search? | +| `o_enable_advanced_search` | `"1"` | Enable the use of advanced search? | | `o_announcement` | `"0"` | Display an announcement? This shows the announcement message set in o_announcement_message in an announcement box on every forum page. | | `o_announcement_message` | `"Announcement"` | An announcement message to show on every forum page when announcements are enabled. | | `o_announcement_title` | `"NULL"` | The title of your announcement. | @@ -130,42 +128,58 @@ The `$luna_config` variable holds an associative array with the contents of the | `o_rules` | `"0"` | Enable the use of forum rules? | | `o_rules_message` | `"Rules"` | The rules for your forum. This field may contain HTML. | | `o_maintenance` | `"0"` | Enable maintenance mode? This prevents anyone who isn't an administrator from using the board. | -| `o_maintenance_message` | `"The forums are temporarily down for maintenance.` `Please try again in a few minutes."` | A message to be displayed to anyone attempting to use the board when maintenance mode is enabled. | -| `o_default_dst` | `"0"` | The default DST offset, either 1 or 0. | +| `o_maintenance_message` | `"The forums are temporarily down for maintenance. Please try again in a few minutes."` | A message to be displayed to anyone attempting to use the board when maintenance mode is enabled. | | `o_feed_type` | `"2"` | The type of syndication feed to use. 0 = None, 1 = RSS, 2 = Atom. | | `o_feed_ttl` | `"0"` | The duration (in minutes) to cache certain feed pages. | | `o_cookie_bar` | `"1"` | Display a cookie bar. | -| `o_cookie_bar_url` | `"http://getluna.org/docs/cookies.php"` | The URL where to get more info on cookies, by default it points to this documentation. | -| `o_emoji` | `"0"` | Enable emojis instead of emoticons. | -| `o_emoji_size` | `"16"` | The font size of emojis when used. | +| `o_cookie_bar_url` | `"http://getluna.org/docs/cookies"` | The URL where to get more info on cookies, by default it points to this documentation. | | `o_admin_notes` | `"NULL"` | Saves the admin note in the Backstage index. | -| `o_pms_enabled` | `"1"` | Use the Inbox private messaging system. | -| `o_pms_mess_per_page` | `"10"` | Amount of messages per page in Inbox. | -| `o_pms_max_receiver` | `"5"` | The maximum amount of receivers per message. | -| `o_emoji_size` | `"16"` | The size of an emoticon. | +| `o_inbox_notification` | `"0"` | Whether or not Luna is allowed to notify users about Inbox. | +| `o_enable_inbox` | `"1"` | Use the Inbox private messaging system. | | `o_back_to_top` | `"1"` | Display a "Back to top" link in the footer. | | `o_show_copyright` | `"1"` | Show the copyright in the footer. | | `o_copyright_type` | `"0"` | Customize copyright to your own or use the automatically generated copyright. | +| `o_custom_css` | `NULL` | Extra CSS you want to include in your baord. | | `o_custom_copyright` | `NULL` | Show a custom copyright text in the footer. | | `o_header_search` | `"1"` | Display a search box in the header (theme dependend). | | `o_board_statistics` | `"1"` | Show the board statistics (theme depended). | | `o_notification_flyout` | `"1"` | Show a flyout when clicking on the notification icon, or go directly to the page (theme depended). | -| `o_update_ring` | `"1"` | The current Update Ring where Luna checks for updates. | -| `p_message_bbcode` | `"1"` | Enable the use of bbcode within comments? | -| `p_message_img_tag` | `"1"` | Enable the use of image tags within comments? | -| `p_message_all_caps` | `"1"` | Allow users to comment a message containing all capitals? | -| `p_subject_all_caps` | `"1"` | Allow users to comment a message with the subject containing all capitals? | -| `p_sig_all_caps` | `"1"` | Allow users to have a signature made up of all capitals? | -| `p_sig_bbcode` | `"1"` | Enable the use of bbcode within signatures? | -| `p_sig_img_tag` | `"0"` | Enable the use of image tags within signatures? | -| `p_sig_length` | `"400"` | The maximum length of a users signature (in characters). | -| `p_sig_lines` | `"4"` | The maximum number of lines a users signature may contain. | -| `p_allow_banned_email` | `"1"` | Allow users to register with a banned email address? If enabled the registration will be allowed but an alert will be sent to the mailing list (see o_mailing_list). | -| `p_allow_dupe_email` | `"0"` | Allow users to register with an email address that is already being used? If enabled an alert will be sent to the mailing list (see o_mailing_list) when a duplicate is detected. | -| `p_force_guest_email` | `"1"` | Require guests to supply an email address when commenting? | +| `o_use_custom_css` | `"0"` | Wether or not Luna should use the custom CSS. | +| `o_use_cdn` | `"1"` | Require Luna to get Bootstrap and jQuery from CDNs. | +| `o_fontawesomepro` | `"0"` | Enable this to show Font Awesome Pro features in Luna. | +| `o_message_bbcode` | `"1"` | Enable the use of bbcode within comments? | +| `o_message_img_tag` | `"1"` | Enable the use of image tags within comments? | +| `o_message_all_caps` | `"1"` | Allow users to comment a message containing all capitals? | +| `o_max_receivers` | `"5"` | Nomber of allowed receivers for each Inbox message | +| `o_subject_all_caps` | `"1"` | Allow users to comment a message with the subject containing all capitals? | +| `o_sig_all_caps` | `"1"` | Allow users to have a signature made up of all capitals? | +| `o_sig_img_tag` | `"0"` | Enable the use of image tags within signatures? | +| `o_sig_length` | `"400"` | The maximum length of a users signature (in characters). | +| `o_sig_lines` | `"4"` | The maximum number of lines a users signature may contain. | +| `o_allow_spoiler` | `"0"` | Allow the use of the spoiler tag. | +| `o_allow_size` | `"0"` | Allow the use of the size tag. | +| `o_allow_center` | `"0"` | Allow the use of the center tag. | +| `o_allow_banned_email` | `"1"` | Allow users to register with a banned email address? If enabled the registration will be allowed but an alert will be sent to the mailing list (see o_mailing_list). | +| `o_allow_dupe_email` | `"0"` | Allow users to register with an email address that is already being used? If enabled an alert will be sent to the mailing list (see o_mailing_list) when a duplicate is detected. | +| `o_force_guest_email` | `"1"` | Require guests to supply an email address when commenting? | + +*These values depend on the information given during installation of Luna or the version you have installed, and do not have a default as such. + +#### System values +The values listed below are also part of `$luna_config` but are only managed by Luna. The user can't, or shouldn't manipulate these rows. + +| Name | Default value | Description | +| --- | --- | --- | +| `o_cur_version` | `"2.1.0"`* | The current version of Luna that is installed. | +| `o_core_version` | `"2.1.5947"`* | The current version of Luna core that is installed. | +| `o_code_name` | `"Fallow"`* | The current name of Luna core that is installed. | +| `o_database_revision` | `"92.31"`* | The current version of the database structure. | +| `o_searchindex_revision` | `"2.0"`* | The current version of the search index engine. During an update if this increments all comments will be indexed again. | +| `o_parser_revision` | `"11.5.1"`* | The current version of the parser. During an update, if this increments all comments will be preparsed again. | *These values depend on the information given during installation of Luna or the version you have installed, and do not have a default as such. +#### Getting a value ```php // Get the forum config from the DB $result = $db->query('SELECT * FROM '.$db->prefix.'config', true) or error('Unable to fetch forum config', __FILE__, __LINE__, $db->error()); @@ -174,7 +188,7 @@ $luna_config[$cur_config_item[0]] = $cur_config_item[1]; ``` ### `$luna_bans` -The `$luna_bans` variable is an array of currently active bans which should be enforced, taken from the bans database table. Like the `$luna_config` variable it is also cached. +The `$luna_bans` variable is an array of currently active bans which should be enforced, taken from the [bans](dbstructure) database table. Like the `$luna_config` variable it is also [cached](caching). ```php // Get the ban list from the DB