wip #865: first go at docs

README.rst

@@ -54,6 +54,7 @@ As of now Misago implements all features considered "must have" on live internet
 * Ban system allows you to ban existing users as well as forbid certain user names, e-mails or IP addresses from registering accounts.
 * Permission system allowing you to control which features are available to users based on their rank, roles or category they are in.
 * Private threads feature allowing users to create threads visible only to them and those they've invited. 
+* Python-based profile fields framework letting site owners to define custom fields for users to fill in complete with powerful customization options for custom requirements, display or validation logic.
 * Rich polls  system, allowing polls with public and private voters, single and multiple choices as well as ones that allow vote change or limit voting tp limited period of time.
 * Post attachments complete thumbnailing and gif's animation removal.
 * Posts edits log allowing you to see how user messages used to look in past as well as revert function protecting you from malignant users emptying their posts contents.
@@ -63,9 +64,9 @@ As of now Misago implements all features considered "must have" on live internet
 Even more features will follow in future releases:
 
 * Achievements and awards system.
-* Custom profile fields letting site owners to define custom fields for users to fill in.
 * Content reporting for users to report offensive content.
 * Forum-wide JS routing further reducing navigation times.
+* IP search for moderators to find `sock puppets <https://en.wikipedia.org/wiki/Sockpuppet_(Internet)>`_ or bot nets.
 * Notifications for users to notice content and events of concern faster.
 * Post accurate read tracker that lets moderators spot unapproved replies and non-moderators spot approved posts.
 * Sign in with Facebook/Google/Github/Steam/etc/ect.

docs/ProfileFields.md

@@ -0,0 +1,17 @@
+Profile fields
+==============
+
+Misago allows your users to fill in additional details about themselves for other users to see on their profiles, such as their real name, gender, short bio or contact options such as homepage address or Twitter/Skype handles.
+
+In addition to those, Misago also uses "read only" profile fields to displays users IP addresses on their profiles for forum moderators.
+
+
+## Writing custom profile field
+
+## Read only profile fields
+
+## Obtaining list of profile fields keys existing in database
+
+## Removing profile fields from database
+
+## Using logging for controling profile fields usage

docs/SUMMARY.md

@@ -21,6 +21,7 @@
 * [Sending mails](./Mails.md)
 * [Markup](./Markup.md)
 * [Posting process](./PostingProcess.md)
+* [Profile fields](./ProfileFields.md)
 * [Threads types](./ThreadTypes.md)
 * [Extending pages](./ExtendingPages.md)
 * [Validating registrations](./ValidatingRegistrations.md)

docs/settings/Core.md

@@ -177,6 +177,30 @@ Controls number of posts displayed on thread page. Greater numbers can increase
 Defines minimal number of posts for thread's last page. If number of posts on last page is smaller or equal to one specified in this setting, last page will be appended to previous page instead.
 
 
+## `MISAGO_PROFILE_FIELDS`
+
+Defines list of groups of profile fields used on users profiles "details" tab.
+
+Should be list of dicts defining `name` key that's string with name of fields group and `fields` that is list of paths to Python types implementing fields: 
+
+    MISAGO_PROFILE_FIELDS = [
+        {
+            'name': _("Personal"),
+            'fields': [
+                'misago.users.profilefields.default.FullNameField',
+                'misago.users.profilefields.default.GenderField',
+            ],
+        },
+        {
+            'name': _("Contact"),
+            'fields': [
+                'misago.users.profilefields.default.TwitterHandleField',
+                'misago.users.profilefields.default.WebsiteField',
+            ],
+        },
+    ]
+
+
 ## `MISAGO_RANKING_LENGTH`
 
 Some lists act as rankings, displaying users in order of certain scoring criteria, like number of posts or likes received.