====== Guidelines for Creating New Pages ====== Welcome to the rules for creating new pages in our DokuWiki! Please follow these guidelines carefully to maintain consistency, clarity, and usability across our documentation. ===== 1. Page Naming Rules ===== * **Namespace Structure**: All new pages must follow the hierarchical structure outlined below: * **First Level Namespace**: Specify the main category, such as `low_voltage`, `high_voltage`, `compatibility_matrix`, or `monitoring_control`. * **Second Level Namespace**: Define the specific product, platform, or module (e.g., `SS4083`, `BmsEx`, `plant_control`). * **Third Level Namespace**: Specify the page content type, such as `datasheet`, `manual`, or `troubleshooting`. * Example: `low_voltage:SS4083:manual` or `monitoring_control:BmsEx:troubleshooting` * **Descriptive Titles**: Beyond the namespaces, the content should clearly describe the subject. * **Use Lowercase Letters**: Except for proper nouns or acronyms. * **Avoid Special Characters**: Stick to alphanumeric characters and underscores. ===== 2. Media File Organization ===== * **Namespace-Specific Media Files**: All media files (e.g., images, documents) must be stored in the same namespace or folder as the page that uses them. * Example: If the page is `low_voltage:SS4083:manual`, the media files should be stored in `low_voltage:SS4083:media`. * **Naming Media Files**: Use descriptive and concise names for media files to make them easily identifiable. * **File Types**: Use common file formats (e.g., `.png`, `.jpg`, `.pdf`) for compatibility. ===== 3. Formatting Standards ===== * **Use Headings**: Organize content using `======` for main titles and `=====`, `====`, etc., for subsections. * **Bullet Points & Tables**: Use lists and tables for clarity whenever possible. * **Consistent Style**: Write in a neutral tone, and use the active voice for clarity. ===== 4. Adding Content ===== * **Ensure Accuracy**: Verify all information before adding it to the page. * **Citations**: Provide links or references where appropriate. * **No Duplicates**: Check if a similar page already exists before creating a new one. ===== 5. Template Usage ===== * **Use Page Templates**: For specific types of content (e.g., FAQs, guides), use the pre-defined templates. * **Link to Templates**: Include a link to available templates here (e.g., `[[templates:example_template]]`). ===== Final Note ===== By following these rules, we ensure our DokuWiki remains an efficient and user-friendly resource for everyone. Happy documenting!