Conventions & Policies
This Wiki is based on a number of conventions on how to structure the content. Please try to keep to these written or unwritten conventions in order to maintain consistency and to make it easy for users to orient and find contents quickly.
All contents created in this Wiki are licensed under the Attribution-Share Alike V2.0 Generic License. So if you contribute to this Wiki, your contributions will be licensed under these terms.
How to Get Editing Permissions?
We want to encourage every experienced ]po[ user and community member to contribute to this Wiki.
However, please understand that we reserve the right of admission.
Wiki vs. Forum
This Wiki is designed like an encyclopedia with specific concepts (see below) and their respective pages. Interactive contents don't fit very well into this structure. Also, we would like to maintain our SourceForge space for user interaction. So please:
In contrast, we may publish specific FAQs etc. here on the Wiki.
Page Types & Naming
Pages should be named in a similar manner to those previously created pages. Words should be separated and delimited by using the underscore "_" character.
- Tutorial Pages
- Purpose: Publish PDF and PPT documents & tutorials
- Audience: Mainly for ]po[ beginners, but tutorials could also be for other groups.
- Naming: tutorial_xxx (ex: tutorial_po_wiki)
- Contents: The page should contain a GIF of the tutorial's first page with a link to the tutorial
- Comment: We decided to setup a Wiki page for each tutorial as opposed to linking directly to PDF or PPT files, so that these files can be tagged and so that users can leave comments. Also, we might want to keep different versions of a manual or move the manuals easily between different servers without having to update all references in the entire Wiki.
- Object Type Pages
- Purpose: Document ]po[ object types
- Audience: Developers and Application Administrators
- Naming: object_type_xxx where xxx is the full ]po[ object type name with underscores (ex: object-type-im-project). The "im" prefix denotes that the object type belongs to the ]po[ part of the system. OpenACS object types do not include the "im". "im" was chosen to represent "intranet" because "in" was already taken...
- Contents: A short description/definition of what the object type is, followed by the database fields of the object type and addition information for SQL Developers.
- Package Pages
- Purpose: Document the available ]po[ packages. "Packages" are installable units of code.
- Audience: Technically oriented users and Application Administrators.
- Naming: package_xxx where xxx is the full ]po[ package name with underscores (ex: package-intranet-core).
- Comment: We want to list mainly packages that are part of the ]po[ product. We include OpenACS packages only if they are particularly interesting to ]po[ users or may become part of the product in the future.
- Module Pages
- Purpose: Describe ]po[ functionality on a high level
- Audience: Normal users, particularly during the process of evaluating the product.
- Naming: module_xxx where xxx is a description of the module (ex: module-finance)
- Comment: Modules are a somehow fuzzy grouping of packages (ex: "Finance Module"). The main idea here is to provide occasional readers with a high-level idea about the functionality.
- Category Pages
- Purpose: Categories are important during configuration process
- Audience: Application Administrators and technically gifted managers.
- Naming: category_xxx where xxx is the exact ]po[ "Category Type" in lower case and with underscores (ex: category-intranet-project-type).
- Language Pages
- Purpose: Show all information available for the localization of ]po[ to a specific language, such as maturity status, glossary entries, links to discussions etc.
- Audience: Localizers (]po[ partners and users involved in localization) and interested users during the product evaluation.
- Naming: language_xxx where xxx is the tow-letter ISO name of the language (ex: language-de for German)
- Policy: Each language page should be managed by a "language lead" ]po[ partner.
- Layout: All organizations actively involved in the L10n can display their logo at the right-hand side of the page.
- Installation Pages
- Purpose: Provide users with installation descriptions for the specific operating system
- Audience: System Administrators of potential and existing customers
- Naming: install_xxx where xxx is an OS (ex: install-debian). The page may link to sub-pages named install_xxx_yyy for specific OS versions (ex: install-debian-etch), but these pages should not be included in the "Installation" category in order to avoid cluttering the table of contents.
- Policy: Each installer should be managed by a specific "installation lead" ]po[ partner.
- Layout: Organizations involved in the maintaining the installer can include their logos at the right-hand side of the page.
- Image Names
- Company logos should be named: "company-name-logo.gif"
- Filenames for screenshots should indicate the location (URL) and if applicable the portlet name of the page the screenshot is taken from.
Prefered file format is PNG
- ... please extend for other types of images.