Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| get_started [2025/03/12 18:35] – admin | get_started [2025/04/11 08:01] (current) – [Final Note] mike | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== | + | ====== |
| - | ===== Low Voltage ===== | + | Welcome to the rules for creating new pages in our DokuWiki! Please follow these guidelines carefully to maintain consistency, |
| - | * **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]] | + | |
| - | | + | * **Second Level Namespace**: Define the specific product, platform, or module (e.g., `SS4083`, `BmsEx`, `plant_control`). |
| - | | + | |
| - | | + | |
| - | | + | |
| - | | + | |
| - | * [[troubleshooting|Troubleshooting]] | + | |
| - | | + | |
| - | * [[datasheet|Datasheet]] | + | |
| - | * [[manual|Manual]] | + | |
| - | * [[troubleshooting|Troubleshooting]] | + | |
| - | * **Compatibility Guide** | + | |
| - | * [[sma-si-x|SMA SI-X]] | + | |
| - | * [[goodwe|GoodWe]] | + | |
| - | * [[deye|Deye]] | + | |
| - | ===== Compatibility Matrix ===== | + | * Example: `low_voltage: |
| - | * **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. |
| - | | + | * **Avoid Special Characters**: Stick to alphanumeric characters and underscores. |
| - | | + | |
| - | * [[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: |
| - | | + | |
| - | * [[manual|Manual]] | + | * **File Types**: Use common file formats (e.g., `.png`, `.jpg`, `.pdf`) for compatibility. |
| - | | + | |
| - | | + | ===== 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. |
| - | | + | |
| - | * [[datasheet|Datasheet]] | + | ===== 4. Adding Content ===== |
| - | | + | * **Ensure Accuracy**: Verify all information before adding it to the page. |
| - | | + | * **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]] | + | |
| - | * **HV – BMU (Battery Management Unit)** | + | * **Link to Templates**: Include a link to available templates here (e.g., `[[templates: |
| - | * [[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]] | + | |
| - | * **Plant Controller** | + | |
| - | * [[datasheet|Datasheet]] | + | |
| - | * [[manual|Manual]] | + | |
| - | * [[troubleshooting|Troubleshooting]] | + | |