Jump to content

ZelocoreCMS:Style Guide: Difference between revisions

From ZelocoreCMS Wiki

Digiwayen (talk | contribs)

3 user groups
175 edits
VisualWikitext
Style guide
 
v2.0: Comprehensive style manual with naming, structure, templates, code
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
= ZelocoreCMS Style Guide =
= 📐 ZelocoreCMS Wiki — Article Style Guide =
Follow these guidelines to ensure consistent, high-quality articles.


== Article Structure ==
<div style="background:#cee0f2;border:1px solid #a2a9b1;border-radius:4px;padding:10px 16px;margin-bottom:16px;">
All CMS platform articles should follow this structure:
This style guide is the '''official standard''' for all articles on ZelocoreCMS Wiki. Following it ensures consistency, neutrality, and quality across the entire encyclopedia.
# Overview
</div>
# Key Features
# Installation
# Extensions / Plugins
# Themes & Customization
# Developer Documentation
# Hosting & Deployment
# Security
# Comparison
# Community
# External Links


== Templates ==
__TOC__
Always use these templates:
* {{[[Template:CMS_Infobox|CMS_Infobox]]}} — at the top of every CMS page
* {{[[Template:Verified_Official|Verified_Official]]}} — only for claimed pages (added by admins)
* {{[[Template:Community_Page|Community_Page]]}} — for community-contributed pages
* {{[[Template:Stub|Stub]]}} — for incomplete articles
* {{[[Template:Outdated|Outdated]]}} — for articles needing updates


== Writing Style ==
== 📛 Naming Conventions ==
* Write in clear, neutral, encyclopedic English
* Use present tense ("WordPress uses PHP", not "WordPress used PHP")
* Link to official documentation where possible
* Avoid promotional language


== Version Information ==
=== Article titles ===
Always use {{[[Template:Version_Badge|Version_Badge|X.Y.Z]]}} for version numbers inline.
* Use '''Title Case''' with underscores for spaces: <code>Payload_CMS</code>, <code>Adobe_Experience_Manager</code>
* Do '''not''' include "The" at the start: write <code>Ghost</code> not <code>The Ghost CMS</code>
* Do '''not''' include version numbers: write <code>WordPress</code> not <code>WordPress_6.5</code>
* Sub-pages use forward slashes: <code>Strapi/API_Reference</code>, <code>WordPress/Installation</code>
 
=== Category names ===
* <code>Category:Blogging_CMS</code>
* <code>Category:Headless_CMS</code>
* <code>Category:ECommerce_CMS</code>
* <code>Category:Enterprise_CMS</code>
* <code>Category:Open_Source_CMS</code>
* <code>Category:SaaS_CMS</code>
* <code>Category:Wiki_Platforms</code>
* <code>Category:CMS_Platforms</code> — '''add to every CMS article'''
 
== 🏗ī¸ Required Article Structure ==
 
Every CMS article must follow this structure '''in this exact order''':
 
<pre>
{{CMS_Infobox | name=... | developer=... | ... }}
 
'''Platform Name''' is a [description]. (Lead paragraph — 1-2 sentences)
 
== Overview ==
== Key Features ==
== Installation ==
=== Requirements ===
=== Quick Start ===
== API Reference ==
== Pricing ==
== Pros & Cons ==
== Community & Support ==
== See Also ==
== External Links ==
[[Category:CMS_Platforms]]
[[Category:Appropriate_Category]]
</pre>
 
{{Note|The lead paragraph must not have a section heading. It appears directly after the infobox.}}
 
== 🌡ī¸ Article Quality Levels ==
 
{| class="wikitable" style="width:100%;"
! Level !! Template !! Requirements
|-
| 🌱 '''Stub''' || <code><nowiki>{{Stub}}</nowiki></code> || Has infobox and lead paragraph. Missing most sections.
|-
| 📝 '''Start''' || <code><nowiki>{{Quality_Stub|...}}</nowiki></code> || Infobox + lead + at least 3 complete sections.
|-
| ⭐ '''Good''' || ''Nominated by senior editor'' || All required sections, code examples, references. No <code>{{Stub}}</code>.
|-
| 🏆 '''Featured''' || ''Admin-awarded'' || Exceptional depth, peer reviewed, all sections complete, images included.
|}
 
== ✍ī¸ Writing Style ==
 
=== Do ===
* Write in '''third person''': "WordPress is..." not "We recommend WordPress..."
* State '''facts''': "WordPress was released in 2003" not "WordPress is old"
* Use '''present tense''' for current facts: "Strapi supports GraphQL"
* Use '''past tense''' for history: "Drupal was created by..."
* '''Link''' to official documentation for all technical claims
* Use '''code blocks''' for all command-line instructions and code examples
 
=== Do Not ===
* ❌ Use marketing language: "best", "industry-leading", "revolutionary", "powerful"
* ❌ State opinions: "WordPress is better than Joomla"
* ❌ Speculate about unreleased features
* ❌ Include pricing speculation — only state official published prices
* ❌ Copy text directly from official websites (copyright violation)
* ❌ Use first person: "I", "we", "our"
 
== 🎨 Formatting Rules ==
 
=== Headings ===
* Level 2 (<code>== Heading ==</code>) for main sections
* Level 3 (<code>=== Heading ===</code>) for sub-sections
* Never use Level 1 headings (<code>= Heading =</code>) in article body — that's the article title
 
=== Bold and Italic ===
* '''Bold''' (<code><nowiki>'''text'''</nowiki></code>): First mention of the platform name in the lead paragraph, key terms
* ''Italic'' (<code><nowiki>''text''</nowiki></code>): Titles of books, foreign terms, emphasis
 
=== Links ===
* Link to other articles: <code><nowiki>[[WordPress]]</nowiki></code>
* Link with custom text: <code><nowiki>[[WordPress|the WordPress platform]]</nowiki></code>
* External links: <code><nowiki>[https://wordpress.org Official Website]</nowiki></code>
* Categories: <code><nowiki>[[Category:Blogging_CMS]]</nowiki></code>
 
=== Code ===
* Inline code: <code><nowiki><code>npm install strapi</code></nowiki></code>
* Code blocks use SyntaxHighlight:
<pre><nowiki>
<syntaxhighlight lang="bash">
npm install strapi
</syntaxhighlight>
</nowiki></pre>
Supported languages: <code>bash</code>, <code>javascript</code>, <code>python</code>, <code>php</code>, <code>json</code>, <code>yaml</code>, <code>sql</code>, <code>html</code>, <code>css</code>
 
=== Tables ===
Always use wikitable class for data tables:
<pre>
{| class="wikitable sortable"
! Header 1 !! Header 2 !! Header 3
|-
| Data 1 || Data 2 || Data 3
|}
</pre>
 
== đŸ–ŧī¸ Images ==
 
* Upload images at [[Special:Upload]]
* Use descriptive filenames: <code>Strapi-admin-dashboard.png</code> not <code>screenshot1.png</code>
* Always add alt text: <code><nowiki>[[File:Image.png|300px|right|Caption text]]</nowiki></code>
* Platform logos belong in the infobox via <code>{{CMS_Infobox|logo=Filename.png}}</code>
* Screenshots should be at least 800px wide
 
== đŸ“Ļ Template Reference ==
 
{| class="wikitable" style="width:100%;font-size:.9em;"
! Template !! Usage !! When to use
|-
| <code><nowiki>{{CMS_Infobox}}</nowiki></code> || Right-side info panel || '''Every''' CMS article
|-
| <code><nowiki>{{Stub}}</nowiki></code> || Stub notice || Articles missing major sections
|-
| <code><nowiki>{{Quality_Stub|needs_install=yes}}</nowiki></code> || Specific stub notice || When you know what's missing
|-
| <code><nowiki>{{Official_Page|company=X}}</nowiki></code> || Official maintainer badge || Claimed/verified articles only
|-
| <code><nowiki>{{Note|text}}</nowiki></code> || Blue info box || Important notes and tips
|-
| <code><nowiki>{{Warning|text}}</nowiki></code> || Orange warning box || Security warnings, breaking changes
|-
| <code><nowiki>{{Tip|text}}</nowiki></code> || Green tip box || Best practices, shortcuts
|-
| <code><nowiki>{{Under_Construction}}</nowiki></code> || WIP notice || Actively being written
|-
| <code><nowiki>{{Review_Request|user=X}}</nowiki></code> || Review request || When expert review is needed
|}
 
== 🔗 External Links Section Format ==
 
The External Links section must use this format:
<pre>
== External Links ==
* [https://platform.com Official Website]
* [https://docs.platform.com Documentation]
* [https://github.com/org/repo GitHub Repository]
* [https://community.platform.com Community Forum]
</pre>
 
== ❓ Questions? ==
 
* Ask on the [[ZelocoreCMS:Community_Portal|Community Portal]]
* Talk to an [[Special:ListAdmins|administrator]]
* Compare with Wikipedia's [https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style Manual of Style] for general guidance
 
[[Category:ZelocoreCMS]]

Latest revision as of 22:03, 29 July 2026

📐 ZelocoreCMS Wiki — Article Style Guide

This style guide is the official standard for all articles on ZelocoreCMS Wiki. Following it ensures consistency, neutrality, and quality across the entire encyclopedia.

📛 Naming Conventions

Article titles

  • Use Title Case with underscores for spaces: Payload_CMS, Adobe_Experience_Manager
  • Do not include "The" at the start: write Ghost not The Ghost CMS
  • Do not include version numbers: write WordPress not WordPress_6.5
  • Sub-pages use forward slashes: Strapi/API_Reference, WordPress/Installation

Category names

  • Category:Blogging_CMS
  • Category:Headless_CMS
  • Category:ECommerce_CMS
  • Category:Enterprise_CMS
  • Category:Open_Source_CMS
  • Category:SaaS_CMS
  • Category:Wiki_Platforms
  • Category:CMS_Platforms — add to every CMS article

🏗ī¸ Required Article Structure

Every CMS article must follow this structure in this exact order: 

{{CMS_Infobox | name=... | developer=... | ... }}

'''Platform Name''' is a [description]. (Lead paragraph — 1-2 sentences)

== Overview ==
== Key Features ==
== Installation ==
=== Requirements ===
=== Quick Start ===
== API Reference ==
== Pricing ==
== Pros & Cons ==
== Community & Support ==
== See Also ==
== External Links ==
[[Category:CMS_Platforms]]
[[Category:Appropriate_Category]]
ℹī¸ The lead paragraph must not have a section heading. It appears directly after the infobox.

🌡ī¸ Article Quality Levels

Level Template Requirements
🌱 Stub {{Stub}} Has infobox and lead paragraph. Missing most sections.
📝 Start {{Quality_Stub|...}} Infobox + lead + at least 3 complete sections.
⭐ Good Nominated by senior editor All required sections, code examples, references. No
📝 Stub — This article is incomplete. You can help ZelocoreCMS Wiki by expanding it.
.
🏆 Featured Admin-awarded Exceptional depth, peer reviewed, all sections complete, images included.

✍ī¸ Writing Style

Do

  • Write in third person: "WordPress is..." not "We recommend WordPress..."
  • State facts: "WordPress was released in 2003" not "WordPress is old"
  • Use present tense for current facts: "Strapi supports GraphQL"
  • Use past tense for history: "Drupal was created by..."
  • Link to official documentation for all technical claims
  • Use code blocks for all command-line instructions and code examples

Do Not

  • ❌ Use marketing language: "best", "industry-leading", "revolutionary", "powerful"
  • ❌ State opinions: "WordPress is better than Joomla"
  • ❌ Speculate about unreleased features
  • ❌ Include pricing speculation — only state official published prices
  • ❌ Copy text directly from official websites (copyright violation)
  • ❌ Use first person: "I", "we", "our"

🎨 Formatting Rules

Headings

  • Level 2 (== Heading ==) for main sections
  • Level 3 (=== Heading ===) for sub-sections
  • Never use Level 1 headings (= Heading =) in article body — that's the article title

Bold and Italic

  • Bold ('''text'''): First mention of the platform name in the lead paragraph, key terms
  • Italic (''text''): Titles of books, foreign terms, emphasis
  • Link to other articles: [[WordPress]]
  • Link with custom text: [[WordPress|the WordPress platform]]
  • External links: [https://wordpress.org Official Website]
  • Categories: [[Category:Blogging_CMS]]

Code

  • Inline code: <code>npm install strapi</code>
  • Code blocks use SyntaxHighlight:
<syntaxhighlight lang="bash">
npm install strapi
</syntaxhighlight>

Supported languages: bash, javascript, python, php, json, yaml, sql, html, css

Tables

Always use wikitable class for data tables: 

{| class="wikitable sortable"
! Header 1 !! Header 2 !! Header 3
|-
| Data 1 || Data 2 || Data 3
|}

đŸ–ŧī¸ Images

  • Upload images at Special:Upload
  • Use descriptive filenames: Strapi-admin-dashboard.png not screenshot1.png
  • Always add alt text: [[File:Image.png|300px|right|Caption text]]
  • Platform logos belong in the infobox via
Style Guide
Status 🤝 Community
Type
License
Language
Database
Latest Version
Release Date
Website [ Official Site]
  • Screenshots should be at least 800px wide

đŸ“Ļ Template Reference

Template Usage When to use
{{CMS_Infobox}} Right-side info panel Every CMS article
{{Stub}} Stub notice Articles missing major sections
{{Quality_Stub|needs_install=yes}} Specific stub notice When you know what's missing
{{Official_Page|company=X}} Official maintainer badge Claimed/verified articles only
{{Note|text}} Blue info box Important notes and tips
{{Warning|text}} Orange warning box Security warnings, breaking changes
{{Tip|text}} Green tip box Best practices, shortcuts
{{Under_Construction}} WIP notice Actively being written
{{Review_Request|user=X}} Review request When expert review is needed

The External Links section must use this format: 

== External Links ==
* [https://platform.com Official Website]
* [https://docs.platform.com Documentation]
* [https://github.com/org/repo GitHub Repository]
* [https://community.platform.com Community Forum]

❓ Questions?

Retrieved from "https://zelocorecms.org/index.php?title=ZelocoreCMS:Style_Guide&oldid=150"