Welcome to the docs! This is a living document so please make changes as we go to improve our process and make this better.
Lets go over some quick guidelines on creating new articles, editing articles and marking articles for review. These are going to help us with work flows so we can keep track of what is new, what is ready to be edited and what is complete.
The scope of the PageLines Docs is specific to the installation, use and integration of PageLines software. General guides on technologies outside of PageLines should not be a part of these Docs.
For example, a general guide on CSS is outside the scope of the Docs. However, a guide on how to use CSS inside of Platform is within the Scope. A guide on how to configure the Vanilla forum is outside of the scope. While a guide on how to integrate the Vanilla forum to work within PageLines is inside the scope.
If this is the first page you have visisted and you have not created a user page yet -- do it now!
To create your User Page after registering, click your User Name link at the very top of the Codex screen. [Until you put some content onto that page, the link will be red indicating a wiki page that doesn't yet exist.]
What should you do with this page?
Before you add a new page, search around to see if there is an existing page about the same topic. Edit this page instead of creating a new one.
Naming your pages:
Pages should be named based on what they are describing. If the page is explaining How-To add a feature slider, the page should be named "Add a Feature Slider"
If you need to create a new page there are two methods:
There are few setup steps when creating a new page.
Glossary items are added to the Glossary page and should be a short definition of the term with a related example if applicable.
All glossary entries should be added to the [[Category:Glossary]] category.
A How-To page should first be written instructions on how-to accomplish a specific task related to PageLines.
The instructions should include images where applicable. Images should show before and after changes when using PageLines settings.
How-to's may also contain a video made from the script in the page.
Videos SHOULD NOT be started until the text, which becomes the video script, is complete and the page has been reviewed by an admin.
All How-To entries should be added to the [[Category:How-To]] category.
You can use the discussion button in the wiki navigation to offer suggestions to authors.
If you are not the author of a particular page use the discussion section unless the author has marked the page as a draft and it is ready to edit.
As your page develops you might want some help from everyone else to add to it or edit your content.
If you don't want your writing read, scrutinized, edited, slashed or deleted -- write on your personal blog, we wont touch it.
To mark your page as open for editing add a draft category link to the bottom of your page.
Any time you make a page edit, please add a note about what you changed.
Avoid deleting entire articles without first asking the author.
If the article does not describe the title or is poorly written, communicate this with the author. This helps us all improve.
Answer the following questions before considering the page complete.
If yes to all, mark it complete by:
Completed pages will be reviewed by an admin and either sent back to the author or added into the Docs structure.