Luna 2.1 documentation update

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.
+You can easly remove unverified accounts through the prune options under 'Maintenance'.

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.

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).

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.

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. |

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()`

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.

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.