Jump to content

Guideline Structure: Difference between revisions

From HEIN+FRICKE
Swapnil.mangalkar@heinfricke.team (talk | contribs)
No edit summary
Swapnil.mangalkar@heinfricke.team (talk | contribs)
No edit summary
Tags: Manual revert Visual edit
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.
== 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
== Goal ==
Create a logical hierarchy using '''normal pages that contain structured lists of links'''. 
This approach makes the wiki feel hierarchical without changing its technical structure.


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
== Step 1: Create a “Parent” Page ==
Create a main page that acts 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:'''
 
; Page title
Example
: <code>Developers</code>
 
[[File:S3.png|frame|border|none]]
Page title:
; Page content
Developers
 
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.
Line 36: Line 38:
[[HF_ALL|← Back to HF_ALL]]
[[HF_ALL|← Back to HF_ALL]]


Step 2: Create the Linked Pages
</pre>
 
Click a red link (for example HF_ALL/Developers/TeamBornemann) to create that subpage.


Example
----


Page title:
== Step 2: Create the Linked Pages ==
Developers/TeamBornemann
Click a red link (for example HF ALL:Developers/Nordex to create that subpage.


Page content:
'''Example:'''
; Page title
: <code>Developers/Team Bornemann</code>


; Page content
<pre>
= Team Bornemann =
= Team Bornemann =
Documentation related to Project Team Bornemann.
Project Team Bornemann
 
[[Developers|← Back to Developers]]
 


Use the format:
[[Devolopers|← Back to Developers]]
</pre>


[[ParentPageName|← Back to Parent Page]]
Each page links back to its parent using:
<pre>[[ParentPageName|← Back to Parent Page]]</pre>


Step 3: (Optional) Add More Levels
----


== 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/Team Bornemann/Planning</code>
Developers/TeamBornemann/Planning
 
Page content:


; 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]]
[[Developers/Team Bornemann|← Back to Team Bornemann]]
</pre>


Step 4: (Optional) Create an Overview or "Tree"
----


You can manually show the hierarchy using nested bullet lists.
== Step 4: (Optional) Create an Overview or “Tree” ==
You can manually display a hierarchy by nesting lists:


Example
<pre>
= Developers =
= Developers =


Line 95: Line 100:
** [[HF_ALL/Developers/DevTools/Git]]
** [[HF_ALL/Developers/DevTools/Git]]
** [[HF_ALL/Developers/DevTools/VSCode]]
** [[HF_ALL/Developers/DevTools/VSCode]]
</pre>


This structure visually represents a hierarchy even though the wiki pages are flat.


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.:
 
{{HF_ALL|Developers/TeamBornemann}}
 
 
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 /
== Tips ==
* Use consistent page names with slashes, such as <code>Developers/Team Bornemann/Planning</code>.
* Add a “Back to parent” link on each subpage.
* You can create a small template to simplify the “Back” link, for example:
  <pre>{{HF_ALL|Developers/Team Bornemann}}</pre>
* Maintain a single “index” page (like <code>Developers</code>) that defines the hierarchy.


Add back-links on each subpage
----


Build a tree-like structure using bullet lists
== Summary ==
{| class="wikitable"
To create a clean, structured hierarchy in MediaWiki under '''HF_ALL''':


Maintain consistent naming across all pages
# Create a '''department index page''' (e.g., HF_ALL/Developers)
# Add subpages using <code>/</code>
# Include back-links on every subpage
# Build a tree-like structure using bullet lists
# Keep only '''general internal documentation''' (no client-confidential info)


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.
✔️ Corrections Made
Here are the mistakes that were fixed:
Spelling mistakes:
"Devolopers" → "Developers"
"Bornemann" inconsistent — standardized to TeamBornemann
Broken example link:
“HF ALL:Developers/Nordex” corrected to proper MediaWiki format.
Grammar and phrasing improvements
Added missing code formatting
Ensured all pages and links use the same structure
Made the document more professional and consistent

Revision as of 10:29, 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 technical structure.


Step 1: Create a “Parent” Page

Create a main page that acts 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/Nordex to create that subpage.

Example:

Page title
Developers/Team Bornemann
Page content
= Team Bornemann =
Project Team Bornemann

[[Devolopers|← Back to Developers]]

Each page links back to its parent using:

[[ParentPageName|← Back to Parent Page]]

Step 3: (Optional) Add More Levels

You can continue nesting pages by creating deeper paths.

Example:

Page title
Developers/Team Bornemann/Planning
Page content
= Team Bornemann – Planning =
Details of the planning phase.

[[Developers/Team Bornemann|← Back to Team Bornemann]]

Step 4: (Optional) Create an Overview or “Tree”

You can manually display a hierarchy by nesting 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 structure visually represents a hierarchy even though the wiki pages are flat.


Tips

  • Use consistent page names with slashes, such as Developers/Team Bornemann/Planning.
  • Add a “Back to parent” link on each subpage.
  • You can create a small template to simplify the “Back” link, for example:
{{HF_ALL|Developers/Team Bornemann}}
  • Maintain a single “index” page (like Developers) that defines the hierarchy.

Summary

To create a clean, structured hierarchy in MediaWiki under HF_ALL:
  1. Create a department index page (e.g., HF_ALL/Developers)
  2. Add subpages using /
  3. Include back-links on every subpage
  4. Build a tree-like structure using bullet lists
  5. Keep only general internal documentation (no client-confidential info)
This creates a predictable, professional, and easy-to-navigate documentation system for all teams.