Guideline Structure: Difference between revisions
No edit summary |
No edit summary |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
HOWTO: Simulate a Hierarchy in Wikipedia Using Linked Pages | = HOWTO: Simulate a Hierarchy in Wikipedia Using Linked Pages = | ||
== Problem == | |||
Wikipedia and other MediaWiki-based wikis do not have a true folder or hierarchical page structure. All pages exist in a flat namespace. | Wikipedia and other MediaWiki-based wikis do not have a true folder or hierarchical page structure. All pages exist in a flat namespace. | ||
Goal | == Goal == | ||
Create a logical hierarchy using normal pages that contain structured lists of links. This approach makes the wiki ''feel'' hierarchical without changing its underlying technical structure. | |||
---- | |||
== Step 1: Create a “Parent” Page == | |||
Create a main page that serves as a directory or table of contents for a topic. | Create a main page that serves as a directory or table of contents for a topic. | ||
Example | '''Example:''' | ||
; Page title | |||
Page title: | : <code>Developers</code> | ||
Developers | [[File:S3.png|frame|border|none]] | ||
; Page content | |||
Page content | |||
<pre> | |||
= Developers = | = Developers = | ||
This page contains all general developer-related information, guidelines, and processes. | This page contains all general developer-related information, guidelines, and processes. | ||
== Developer Teams == | == Developer Teams == | ||
* [[HF_ALL/Developers/TeamBornemann]] | * [[HF_ALL/Developers/TeamBornemann]]* [[HF_ALL/Developers/TeamOdoo]]* [[HF_ALL/Developers/TeamNordex]]* [[HF_ALL/Developers/TeamMercedes]] | ||
* [[HF_ALL/Developers/TeamOdoo]] | |||
* [[HF_ALL/Developers/TeamNordex]] | |||
* [[HF_ALL/Developers/TeamMercedes]] | |||
== General Documentation == | == General Documentation == | ||
* [[HF_ALL/Developers/Onboarding]] | * [[HF_ALL/Developers/Onboarding]]* [[HF_ALL/Developers/CodeStandards]]* [[HF_ALL/Developers/DevTools]]* [[HF_ALL/Developers/BestPractices]][[HF_ALL|← Back to HF_ALL]] | ||
* [[HF_ALL/Developers/CodeStandards]] | </pre> | ||
* [[HF_ALL/Developers/DevTools]] | |||
* [[HF_ALL/Developers/BestPractices]] | |||
---- | |||
Step 2: Create the Linked Pages | == Step 2: Create the Linked Pages == | ||
Click a red link (for example <code>HF_ALL/Developers/TeamBornemann</code>) to create that subpage. | |||
'''Example:''' | |||
; Page title | |||
Example | : <code>Developers/TeamBornemann</code> | ||
Page title: | |||
Developers/TeamBornemann | |||
; Page content | |||
<pre> | |||
= Team Bornemann = | = Team Bornemann = | ||
Documentation related to Project Team Bornemann. | Documentation related to Project Team Bornemann. | ||
[[Developers|← Back to Developers]] | |||
[[Developers|← Back to Developers]] | </pre> | ||
Use the format: | Use the format: | ||
<pre>[[ParentPageName|← Back to Parent Page]] </pre> | |||
---- | |||
== Step 3: (Optional) Add More Levels == | |||
You can continue nesting pages by creating deeper paths. | You can continue nesting pages by creating deeper paths. | ||
Example | '''Example:''' | ||
; Page title | |||
Page title: | : <code>Developers/TeamBornemann/Planning</code> | ||
Developers/TeamBornemann/Planning | |||
; Page content | |||
<pre> | |||
= Team Bornemann – Planning = | = Team Bornemann – Planning = | ||
Details of the planning phase. | Details of the planning phase. | ||
[[Developers/TeamBornemann|← Back to Team Bornemann]] | |||
</pre> | |||
---- | |||
== Step 4: (Optional) Create an Overview or “Tree” == | |||
You can manually show the hierarchy using nested bullet lists. | You can manually show the hierarchy using nested bullet lists. | ||
<pre> | |||
= Developers = | = Developers = | ||
== Teams == | == Teams == | ||
* [[HF_ALL/Developers/TeamBornemann]] | * [[HF_ALL/Developers/TeamBornemann]]* [[HF_ALL/Developers/TeamOdoo]]* [[HF_ALL/Developers/TeamNordex]]* [[HF_ALL/Developers/TeamMercedes]] | ||
* [[HF_ALL/Developers/TeamOdoo]] | |||
* [[HF_ALL/Developers/TeamNordex]] | |||
* [[HF_ALL/Developers/TeamMercedes]] | |||
== Documentation == | == Documentation == | ||
* [[HF_ALL/Developers/Onboarding]] | * [[HF_ALL/Developers/Onboarding]]* [[HF_ALL/Developers/CodeStandards]]** [[HF_ALL/Developers/CodeStandards/Python]]** [[HF_ALL/Developers/CodeStandards/JavaScript]] | ||
* [[HF_ALL/Developers/CodeStandards]] | * [[HF_ALL/Developers/DevTools]]** [[HF_ALL/Developers/DevTools/Git]]** [[HF_ALL/Developers/DevTools/VSCode]] | ||
** [[HF_ALL/Developers/CodeStandards/Python]] | </pre> | ||
** [[HF_ALL/Developers/CodeStandards/JavaScript]] | |||
* [[HF_ALL/Developers/DevTools]] | |||
** [[HF_ALL/Developers/DevTools/Git]] | |||
** [[HF_ALL/Developers/DevTools/VSCode]] | |||
This visually represents a hierarchy even though the wiki itself is flat. | This visually represents a hierarchy even though the wiki itself is flat. | ||
---- | |||
== Tips == | |||
Add a "Back to parent" link on each subpage. | * Use consistent page names with slashes (e.g., <code>Developers/TeamBornemann/Planning</code>). | ||
* Add a "Back to parent" link on each subpage. | |||
* Consider creating a template to simplify “Back” links, e.g.: | |||
* Maintain a single “index” page (e.g., <code>HF_ALL/Developers</code>) that defines the hierarchy. | |||
* Store only internal documentation—avoid client-confidential content. | |||
---- | |||
== Summary == | |||
To create a clean, structured hierarchy in MediaWiki under <code>HF_ALL</code>: | |||
* Create a department index page (e.g., <code>HF_ALL/Developers</code>) | |||
* Add subpages using <code>/</code> | |||
* Add back-links on each subpage | |||
* Build a tree-like structure using bullet lists | |||
* Maintain consistent naming across all pages | |||
This creates a predictable, professional, and easy-to-navigate documentation system for all teams. | |||
<code><nowiki>{HF_ALL|Developers/TeamBornemann}}</nowiki></code> | |||
{| class="wikitable" | |||
To create a clean, structured hierarchy in MediaWiki under '''HF_ALL''': | |||
# Create a '''department index page''' (e.g., HF_ALL/Developers) | |||
# Add subpages using <code>/</code> | |||
Create a department index page (e.g., HF_ALL/Developers) | # Include back-links on every subpage | ||
# Build a tree-like structure using bullet lists | |||
Add subpages using / | # Keep only '''general internal documentation''' (no client-confidential info) | ||
Build a tree-like structure using bullet lists | |||
This creates a predictable, professional, and easy-to-navigate documentation system for all teams. | This creates a predictable, professional, and easy-to-navigate documentation system for all teams. | ||
Latest revision as of 11:11, 1 December 2025
HOWTO: Simulate a Hierarchy in Wikipedia Using Linked Pages
Problem
Wikipedia and other MediaWiki-based wikis do not have a true folder or hierarchical page structure. All pages exist in a flat namespace.
Goal
Create a logical hierarchy using normal pages that contain structured lists of links. This approach makes the wiki feel hierarchical without changing its underlying technical structure.
Step 1: Create a “Parent” Page
Create a main page that serves as a directory or table of contents for a topic.
Example:
- Page title
Developers
- Page content
= Developers = This page contains all general developer-related information, guidelines, and processes. == Developer Teams == * [[HF_ALL/Developers/TeamBornemann]]* [[HF_ALL/Developers/TeamOdoo]]* [[HF_ALL/Developers/TeamNordex]]* [[HF_ALL/Developers/TeamMercedes]] == General Documentation == * [[HF_ALL/Developers/Onboarding]]* [[HF_ALL/Developers/CodeStandards]]* [[HF_ALL/Developers/DevTools]]* [[HF_ALL/Developers/BestPractices]][[HF_ALL|← Back to HF_ALL]]
Step 2: Create the Linked Pages
Click a red link (for example HF_ALL/Developers/TeamBornemann) to create that subpage.
Example:
- Page title
Developers/TeamBornemann
- Page content
= Team Bornemann = Documentation related to Project Team Bornemann. [[Developers|← Back to Developers]]
Use the format:
[[ParentPageName|← Back to Parent Page]]
Step 3: (Optional) Add More Levels
You can continue nesting pages by creating deeper paths.
Example:
- Page title
Developers/TeamBornemann/Planning
- Page content
= Team Bornemann – Planning = Details of the planning phase. [[Developers/TeamBornemann|← Back to Team Bornemann]]
Step 4: (Optional) Create an Overview or “Tree”
You can manually show the hierarchy using nested bullet lists.
= Developers = == Teams == * [[HF_ALL/Developers/TeamBornemann]]* [[HF_ALL/Developers/TeamOdoo]]* [[HF_ALL/Developers/TeamNordex]]* [[HF_ALL/Developers/TeamMercedes]] == Documentation == * [[HF_ALL/Developers/Onboarding]]* [[HF_ALL/Developers/CodeStandards]]** [[HF_ALL/Developers/CodeStandards/Python]]** [[HF_ALL/Developers/CodeStandards/JavaScript]] * [[HF_ALL/Developers/DevTools]]** [[HF_ALL/Developers/DevTools/Git]]** [[HF_ALL/Developers/DevTools/VSCode]]
This visually represents a hierarchy even though the wiki itself is flat.
Tips
- Use consistent page names with slashes (e.g.,
Developers/TeamBornemann/Planning). - Add a "Back to parent" link on each subpage.
- Consider creating a template to simplify “Back” links, e.g.:
- Maintain a single “index” page (e.g.,
HF_ALL/Developers) that defines the hierarchy. - Store only internal documentation—avoid client-confidential content.
Summary
To create a clean, structured hierarchy in MediaWiki under HF_ALL:
- Create a department index page (e.g.,
HF_ALL/Developers) - Add subpages using
/ - Add back-links on each subpage
- Build a tree-like structure using bullet lists
- Maintain consistent naming across all pages
This creates a predictable, professional, and easy-to-navigate documentation system for all teams.
{HF_ALL|Developers/TeamBornemann}}
- Create a department index page (e.g., HF_ALL/Developers)
- Add subpages using
/ - Include back-links on every subpage
- Build a tree-like structure using bullet lists
- Keep only general internal documentation (no client-confidential info)