# Kinglet User and Programming Documentation

markdown=yes
#kinglet - #api - #rest - #json


Example usage: [http://soupmode.com](http://soupmode.com)

## User Help

### Create an Account

* User visits the sign-up page.
* User enters a username and an e-mail address.
* If configured, the system will send an e-mail with an auto-generated password and a link to activate the account. If the system is set to debug mode, then the password and the activation link will be sent to the browser. In debug mode, a user does not need to provide a valid e-mail address, since no e-mail is sent. But the user needs to provide an e-mail with valid syntax.
* User clicks the link to activate the account.


### Login

* At the homepage or on the login page, the user enters the e-mail address, used to create the account and the password, generated by the system.
* Optionally, a user can check the save login box to avoid having to login the next time the user accesses the site. If using multiple devices, the save login box will have to be checked for each device if the user wants to avoid logging in on all devices.


### Profile Page

* To change password, e-mail address, or profile description information, the user clicks on his or her username, located in the navigation bar at the top of the site. 
* Next, the user clicks on "Change your password, e-mail address, or description info" and follows the form fields accordingly. 




homepage           "Homepage",       "show_homepage"   
stream             "Homepage",       "show_homepage"   
showerror          "Function",       "do_invalid_function"    
addmessage         "AddMessage",     "add_message"     
addreply           "AddMessage",     "add_reply"  
showmessage        "ShowMessage",    "show_message" 
compose            "Compose",        "show_new_message_form" 
reply              "Compose",        "show_new_reply_form"  
replies            "Replies",        "show_replies" 
threads            "Threads",        "show_threads"    
user               "Profile",        "show_user"   
logout             "LogoutUser",     "logout"  
settings           "Profile",        "show_user_settings_form" 
customizeuser      "Profile",        "customize_user" 
changepassword     "Profile",        "change_password"  
newpassword        "Profile",        "create_new_password"  
requestapproval    "Approval",       "request_approval"  
requestsreceived   "Approval",       "show_requests_received"   
approverequest     "Approval",       "approve_request"  
rejectrequest      "Approval",       "reject_request"