ImpressCMS proudly uses SourceForge
ImpressCMS on Ohloh.net
[Index :: This page]  
Tags: Documentation   Guidelines   community  

Contributing Documentation

One of the most important aspects of any product is proper documentation for a variety of users - casual users, veteran users, administrators and developers. Each group will need a variety of documentation - tips, tricks, best practices and recommendations, user guides and administrator guides. This wiki will serve as central library to collect all the wisdom of the ImpressCMS user and developer communities. We may also through in some information on general web technologies and strategies, just to keep things interesting. If you have a question about ImpressCMS and you can't find the answer here or in the forums, please let us know and we will help you find the answer and with creating the new documentation needed. There are 3 basic needs for ImpressCMS documentation - creating documentation, editing documentation and translating documentation. We'll cover each of these below. Most of all - if you have something you have learned while using ImpressCMS, we encourage you to share it with the rest of the community and participate with the spirit of open source we all share. Here's a quick look at pages that need to be started - Special:Wantedpages And, these need to be finished - Category: Not Completed

Creating Documentation

This wiki is open to all who want to contribute and it is maintained by a dedicated group of users like you to provide the best source of information about ImpressCMS and its uses and applications. This group has been assembled from some of the best minds in organizing and presenting information in a user-friendly manner. They will, at times, suggest changes to your documents, rename the pages, or move them to different categories, but in most cases, will only offer guidance and make small contributions to your project. Remember, this is a wiki and a single article may have hundreds of authors and continue to be edited for months and years to come. Also, please respect the work of others. If you find information you think would be useful on another site, please consult with the original author before copying it to our wiki, even if it was published under Creative Commons or other open license, someone worked hard to put that information together. Give credit, cite sources and check your facts. The best user documentation is written from a user's perspective - be original!

Page Names

Our wiki is a multinational wiki and we have established a naming convention for our pages to assist with linking pages to different translations -

  • All pages will consist of an English page name and a language code, except for English language pages

Example: English page = [[Upgrading]] Spanish page = [[Upgrading/es]]

  • The page name should be as simple as possible and links to the page will utilize the pipe | to customize the text for the link

Example: English = [[Upgrading|Upgrading_to_the_latest_version]] Spanish = [[Upgrading/es|Spanish for "Upgrading to the latest version"]] For assistance in determining the best page name, please visit the forums for suggestions

Categorizing Pages

Every page will belong to, at least, 2 categories, probably more. The first category a page has is its language category. You add the categories at the bottom of every page - Example: [[Category:English]] The next category will be the primary topic for the article - Example: [[Category:Modules]] If the article is in Spanish and for a module, use the following - Example: [[Category:Español/es]] [[Category:Modules/es]]

Templates

For most types of articles, we have provided templates to help you create documentation. First, we suggest navigating to the primary category for your topic. Then, at the top of the page, type your page name into the textbox to create a new page in that category. Once you are at the editing page for your new article, type in subst:the category name in your page and save it. For example, to create a new article about a module, type subst:Modules. If you are creating an article in another language, remember to include the language code at the end of the category name - for example, for a Spanish article about a module, use subst:Modules/es The templates will also include the code to add the language bar for the page. Should you be creating a document in a new category, please add <[Languages |Your Page Name[/language code]]> to the bottom of your page. Example: <[Languages |Contributing Documentation]> Will add the language bar to the English language article Contributing Documentation

Editing Documentation

To repeat what we have stated earlier - this is a wiki and all information is open to editing. As you read an article, you may think some editing is needed - it may be as simple as a spelling correction, or a more complex reorganization of the article. Please, please, please! View the history of the article, look at the talk page for the article and visit the forums before making any major changes to an article. Every change is recorded and we can revert articles to a previous state, but we can make a better wiki by simply communicating whenever we make an edit to an existing page. Every time you make an edit, please use the Summary field to provide other wiki contributors with a quick comment about the changes made - it's a lot easier to follow the history of edits when comments are provided.

Translating Documentation

There are 3 things to remember about articles in this wiki

  1. All articles and categories are based on English titles
  2. It is best to wait for an article to be completed before beginning translation
  3. Online translators, such as Google and Babelfish can assist with translation, but cannot be the only source of translation

 

Last modified on 2010/11/25 by fiammybe
This page was created on 2010/11/11 by skenow
This page has been viewed 5103 time(s)

Comments
The comments are owned by the poster. We aren't responsible for their content.
ImpressCMS proudly uses SourceForge
ImpressCMS on Ohloh.net