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/12 18:35] – adminget_started [2025/03/13 18:00] (current) – [1. Page Naming Rules] admin
Line 1: Line 1:
-====== DokuWiki Navigation Tree ======+====== Guidelines for Creating New Pages ======
  
-===== Low Voltage ===== +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.
-  * **SS4083** +
-    * [[datasheet|Datasheet]] +
-    * [[manual|Manual]] +
-    * [[troubleshooting|Troubleshooting]] +
-  * **SS4143** +
-    * [[datasheet|Datasheet]] +
-    * [[manual|Manual]] +
-    * [[troubleshooting|Troubleshooting]] +
-  * **SS214** +
-    * [[datasheet|Datasheet]] +
-    * [[manual-ss214|Manual SS214]] +
-    * [[manual-cb35-36|Manual CB35-36]] +
-    * [[troubleshooting|Troubleshooting]] +
-  * **Compatibility Guide** +
-    * [[victron|Victron]] +
-    * [[sma|SMA]]+
  
-===== High Voltage ===== +===== 1. Page Naming Rules ===== 
-  * **SS6143** +  * **Namespace Structure**: All new pages must follow the hierarchical structure outlined below: 
-    * [[datasheet|Datasheet]] +   * **First Level Namespace**: Specify the main category, such as `low_voltage`, `high_voltage`, `compatibility_matrix`, or `monitoring_control`.  
-    * [[manual|Manual]] +   * **Second Level Namespace**: Define the specific product, platform, or module (e.g., `SS4083`, `BmsEx`, `plant_control`). 
-    * [[troubleshooting|Troubleshooting]] +   * **Third Level Namespace**: Specify the page content type, such as `datasheet`, `manual`, or `troubleshooting`.
-  * **SS70xx** +
-    * [[datasheet|Datasheet]] +
-    * [[manual-cb5x|Manual CB5x]] +
-    * [[troubleshooting|Troubleshooting]] +
-  * **Outdoor Cabinet** +
-    * [[datasheet|Datasheet]] +
-    * [[manual|Manual]] +
-    * [[troubleshooting|Troubleshooting]] +
-  * **Compatibility Guide** +
-    * [[sma-si-x|SMA SI-X]] +
-    * [[goodwe|GoodWe]] +
-    * [[deye|Deye]]+
  
-===== Compatibility Matrix ===== +  * Example: `low_voltage:SS4083:manual` or `monitoring_control:BmsEx:troubleshooting` 
-  * **BESS** +  * **Descriptive Titles**: Beyond the namespaces, the content should clearly describe the subject. 
-    * [[containerized-solutions|Containerized Solutions]] +  * **Use Lowercase Letters**: Except for proper nouns or acronyms. 
-      * [[datasheet|Datasheet]] +  * **Avoid Special Characters**: Stick to alphanumeric characters and underscores.
-      * [[manual|Manual]] +
-      * [[troubleshooting|Troubleshooting]] +
-    * **Containerized Components** +
-      * [[cabw|CABW]] +
-      * [[fire-protection|Fire Protection]] +
-  * **Compatibility Guide** +
-    * [[sungrow|Sungrow]] +
-    * [[kehua|Kehua]]+
  
-===== Monitoring & Control ===== +===== 2. Media File Organization ===== 
-  * **BMS (Battery Management System)** +  * **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. 
-    * **BMS-EM** +    * Example: If the page is `low_voltage:SS4083:manual`, the media files should be stored in `low_voltage:SS4083:media`. 
-      * [[datasheet|Datasheet]] +  * **Naming Media Files**: Use descriptive and concise names for media files to make them easily identifiable. 
-      * [[manual|Manual]] +  * **File Types**: Use common file formats (e.g., `.png`, `.jpg`, `.pdf`) for compatibility. 
-      * [[troubleshooting|Troubleshooting]] + 
-    * **BMS-ES** +===== 3. Formatting Standards ===== 
-      * [[datasheet|Datasheet]] +  * **Use Headings**: Organize content using `======` for main titles and `=====`, `====`, etc., for subsections. 
-      * [[manual|Manual]] +  * **Bullet Points & Tables**: Use lists and tables for clarity whenever possible. 
-      * [[troubleshooting|Troubleshooting]] +  * **Consistent Style**: Write in a neutral tone, and use the active voice for clarity. 
-    * **BMS-EX** + 
-      * [[datasheet|Datasheet]] +===== 4. Adding Content ===== 
-      * [[manual|Manual]] +  * **Ensure Accuracy**: Verify all information before adding it to the page. 
-      * [[troubleshooting|Troubleshooting]] +  * **Citations**: Provide links or references where appropriate. 
-    * **Logger V2** +  * **No Duplicates**: Check if a similar page already exists before creating a new one. 
-      * [[datasheet|Datasheet]] + 
-      * [[manual|Manual]] +===== 5. Template Usage ===== 
-      * [[troubleshooting|Troubleshooting]] +  * **Use Page Templates**: For specific types of content (e.g., FAQs, guides), use the pre-defined templates. 
-  * **HV – BMU (Battery Management Unit)** +  * **Link to Templates**: Include a link to available templates here (e.g., `[[templates:example_template]]`). 
-    * [[datasheet|Datasheet]] + 
-    * [[manual|Manual]] +===== Final Note ===== 
-    * [[troubleshooting|Troubleshooting]] +By following these rules, we ensure our DokuWiki remains an efficient and user-friendly resource for everyone. 
-  * **Supported Energy Meters** + 
-    * [[carlo-gavazy|Carlo Gavazy]] +Happy documenting!
-    * [[eastron|Eastron]] +
-    * [[sma|SMA]] +
-    * [[chint|Chint]] +
-  * **Modbus API** +
-  * **EMS | mypower24** +
-    * **Account Setup** +
-      * [[mobile-application|Mobile Application]] +
-        * [[datasheet|Datasheet]] +
-        * [[manual|Manual]] +
-        * [[troubleshooting|Troubleshooting]] +
-      * [[web-application|Web Application]] +
-        * [[datasheet|Datasheet]] +
-        * [[manual|Manual]] +
-        * [[troubleshooting|Troubleshooting]] +
-    * **Plant Controller** +
-      * [[datasheet|Datasheet]] +
-      * [[manual|Manual]] +
-      * [[troubleshooting|Troubleshooting]]+