Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
get_started [2025/03/13 07:15] – adminget_started [2025/03/13 18:00] (current) – [1. Page Naming Rules] admin
Line 4: Line 4:
  
 ===== 1. Page Naming Rules ===== ===== 1. Page Naming Rules =====
-  * **Namespace Structure**: All new pages must be created within a namespace. +  * **Namespace Structure**: All new pages must follow the hierarchical structure outlined below: 
-    * **First Level Namespace**: Use the manufacturer or platform name (e.g., `Solar MD`, `myPower24`, `myWork24`). +   * **First Level Namespace**: Specify the main category, such as `low_voltage`, `high_voltage`, `compatibility_matrix`, or `monitoring_control`.  
-    * **Second Level Namespace**: Specify the specific device or platform's highest-level module (e.g., `BmsEx` for devices or `plant_control`, `dashboard` for platforms). +   * **Second Level Namespace**: Define the specific product, platform, or module (e.g., `SS4083`, `BmsEx`, `plant_control`). 
-    * **Third Level Namespace**: Define the type of content on the page (e.g., `manual`, `troubleshooting`, `installation`). +   * **Third Level Namespace**: Specify the page content type, such as `datasheet`, `manual`, or `troubleshooting`. 
-    * Example: `Solar_MD:BmsEx:installation_guide` or `myPower24:dashboard:troubleshooting_steps` + 
-  * **Descriptive Titles**: Beyond the namespaces, titles should describe the content clearly.+  * 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.   * **Use Lowercase Letters**: Except for proper nouns or acronyms.
   * **Avoid Special Characters**: Stick to alphanumeric characters and underscores.   * **Avoid Special Characters**: Stick to alphanumeric characters and underscores.
  
-===== 2. Formatting Standards =====+===== 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.   * **Use Headings**: Organize content using `======` for main titles and `=====`, `====`, etc., for subsections.
   * **Bullet Points & Tables**: Use lists and tables for clarity whenever possible.   * **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.   * **Consistent Style**: Write in a neutral tone, and use the active voice for clarity.
  
-===== 3. Adding Content =====+===== 4. Adding Content =====
   * **Ensure Accuracy**: Verify all information before adding it to the page.   * **Ensure Accuracy**: Verify all information before adding it to the page.
   * **Citations**: Provide links or references where appropriate.   * **Citations**: Provide links or references where appropriate.
   * **No Duplicates**: Check if a similar page already exists before creating a new one.   * **No Duplicates**: Check if a similar page already exists before creating a new one.
  
-===== 4. Template Usage =====+===== 5. Template Usage =====
   * **Use Page Templates**: For specific types of content (e.g., FAQs, guides), use the pre-defined templates.   * **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]]`).   * **Link to Templates**: Include a link to available templates here (e.g., `[[templates:example_template]]`).
- 
-===== 5. Categories and Tags ===== 
-  * **Tagging**: Use relevant tags for easy navigation and searchability. 
-  * **Categories**: Assign the page to the appropriate category. 
- 
-===== 6. Review and Publish ===== 
-  * **Peer Review**: Ask a colleague to review the page for accuracy and formatting. 
-  * **Preview Before Publishing**: Use the "Preview" function to ensure everything looks correct. 
-  * **Approval**: Submit for approval if required by your team's workflow. 
- 
-===== 7. Maintenance ===== 
-  * **Updates**: Regularly update pages to keep them current. 
-  * **Clean-Up**: Remove outdated or redundant information. 
- 
-===== 8. Examples ===== 
-Here’s an example of a well-formatted new page: 
-  * Title: `Solar_MD:BmsEx:manual` 
-  * Content: Clear headings, concise explanations, and relevant tags. 
  
 ===== Final Note ===== ===== Final Note =====