Admin CP Help Docs
Contents |
[edit] Add
The Add page lets you either add a help doc section or add a help doc.
[edit] Add Help Doc Section
This lets you add a "section" for adding help docs to, to keep your help section more organized.
- Section Name
- This is the name of the section; for instance, User Maintenance or Posting
- Description
- This is a description of what the section is for
- Use Translation
- This setting lets you choose whether you wish to use the translation or not.
- Enabled
- This setting lets you choose whether you want the section to actually show up on the help page or not.
- Display Order
- This is the order in which you want it to display in relation to the other sections.
[edit] Add Help Doc
This will add an help doc to the section you specify.
- Document Title
- This is the title of the help document.
- Description
- This is a basic description that will be displayed on the main help page, and not the viewing page of this particular help document.
- Document
- This is the content of the help document. You can use HTML but NOT MyCode.
- Use Translation
- This setting lets you choose whether you wish to use the translation or not.
- Enabled
- This setting lets you choose whether you want the section to actually show up on the help page or not.
- Display Order
- This is the order in which you want it to display in relation to the other help docs in the section.
- Document Section
- This is the section that you want the document to show up in.
[edit] Modify/Delete
This lets you edit some of the settings for the built-in help documents, and lets you edit completely or delete any custom help documents you have made. From this page you can also click on "Add Help Section / Document" and go to the "Add" page discussed above.
[edit] Editing Built-In Help Sections
First, you must click on [edit] next to the section you wish to edit, which will take you to a page with the following options:
- Section ID
- You cannot edit this, this is simply telling you the ID of the section you are editing.
- Enabled
- This lets you enable or disable the section. If you wanted to replace the built-in ones with custom ones, you could disable all of the built in ones so they will not show up.
- Display Order
- This is the order the section will display in relation to the other sections.
[edit] Editing Built-In Help Documents
First, you must click on [edit] next to the document you wish to edit, which will take you to a page with the following options:
- Document ID
- This is the ID of the document you are editing. You cannot edit this.
- Enabled
- This lets you enable or disable the document from being shown on the help page. If you wanted to replace the built-in documents with your own, you could disable all of the built-in documents and replace them with your own.
- Display Order
- This is the order the document is displayed in relation to the other help documents in the section it is in.
- Document Section
- This is the section that the help document will be displayed in.
[edit] Editing or Deleting Custom Help Sections
You can both edit and delete custom help sections. To edit one, click on [edit] next to it, and to delete one, click on [delete] next to it. When clicking on [edit], you will be taken to a page with the following options:
- Section ID
- You cannot edit this, this is simply telling you the ID of the section you are editing.
- Section Name
- This is the name of the section; for instance, User Maintenance or Posting.
- Description
- This is a description of what the section is for
- Use Translation
- This setting lets you choose whether you wish to use the translation or not.
- Enabled
- This setting lets you choose whether you want the section to actually show up on the help page or not.
- Display Order
- This is the order in which you want it to display in relation to the other sections.
[edit] Editing or Deleting Custom Help Documents
You can both edit and delete custom help documents. To edit one, click on [edit] next to it, and to delete one, click on [delete] next to it. You can distinguish custom help documents by built-in documents because only custom help documents have the [delete] link next to it. When clicking on [edit], you will be taken to a page with the following options:
- Document ID
- This is the identification number for the help document - you cannot edit this.
- Document Title
- This is the title of the help document.
- Description
- This is a basic description that will be displayed on the main help page, and not the viewing page of this particular help document.
- Document
- This is the content of the help document. You can use HTML but NOT MyCode.
- Use Translation
- This setting lets you choose whether you wish to use the translation or not.
- Enabled
- This setting lets you choose whether you want the section to actually show up on the help page or not.
- Display Order
- This is the order in which you want it to display in relation to the other help docs in the section.
- Document Section
- This is the section that you want the document to show up in.
| Moderation | Standard Thread Moderation - Inline Thread Moderation - Inline Post Moderation - Warning System |
| Mod CP | Home - Forums and Posts - Users |
| Admin CP | Home - Configuration - Forums & Posts - Users & Groups - Templates & Style - Tools & Maintenance |
| Templates & Themes | Images - Postbit - Templates - Themes |
| Developer | Database Methods - Database Tables |
| Miscellaneous | Cookies - UTF8 Setup |