Jump to content

Guideline Structure: Difference between revisions

From HEIN+FRICKE
Swapnil.mangalkar@heinfricke.team (talk | contribs)
No edit summary
Suraj.mali@heinfricke.team (talk | contribs)
No edit summary
 
(4 intermediate revisions by one other user not shown)
Line 2: Line 2:


== Problem ==
== Problem ==
Wikipedia and other MediaWiki-based wikis do not have a true folder or hierarchical page structure.
Wikipedia and other MediaWiki-based wikis do not have a true folder or hierarchical page structure. All pages exist in a flat namespace.
All pages exist in a flat namespace.


== Goal ==
== Goal ==
Create a logical hierarchy using '''normal pages that contain structured lists of links'''.
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.
This approach makes the wiki feel hierarchical without changing its 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:'''
'''Example:'''
Line 25: Line 23:


== 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]]
* [[HF_ALL/Developers/DevTools]]
* [[HF_ALL/Developers/BestPractices]]
 
[[HF_ALL|← Back to HF_ALL]]
 
</pre>
</pre>


Line 43: Line 31:


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


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


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


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


----
----
Line 67: Line 54:
'''Example:'''
'''Example:'''
; Page title
; Page title
: <code>Developers/Team Bornemann/Planning</code>
: <code>Developers/TeamBornemann/Planning</code>


; Page content
; Page content
Line 73: Line 60:
= 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>
</pre>


Line 80: Line 66:


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


<pre>
<pre>
Line 86: Line 72:


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

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}}

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.