Content Management: Difference between revisions

From openinverter.org wiki
Jump to navigation Jump to search
(ongoing work on categories)
Line 34: Line 34:
|the categories are part of the generic Mediawiki structure. its reflects a categorization or labeling of pages. Categories can be nested which are useful to reflect a structure of "component of" and for "is a subtype of". Multiple categories can be assigned to page, hence it can provide multiple view at once. A dedicated section of this page will cover their aspects.
|the categories are part of the generic Mediawiki structure. its reflects a categorization or labeling of pages. Categories can be nested which are useful to reflect a structure of "component of" and for "is a subtype of". Multiple categories can be assigned to page, hence it can provide multiple view at once. A dedicated section of this page will cover their aspects.
There are cases where it is not obvious whether a property or a category makes more sense. one does not prevent the other, by the way.
There are cases where it is not obvious whether a property or a category makes more sense. one does not prevent the other, by the way.
|as the wiki already as categories created and they use naming similar to Page, the categories will further be named the same way.  
|as the wiki already as categories created and they use naming similar to Page, the categories will further be named the same way.
'''''Title Case'''''
Ideally, categories shall be written in <u>plural form</u> (because it is a grouping of x)
|Battery
'''''Title Case (in plural)'''''
Connector
|Batteries
Connectors
|-
|-
|'''Property'''
|'''Property'''
Line 47: Line 48:
|'''Template'''
|'''Template'''
|SMW specific - defines which properties values shall be defined at the creation of an object. Not all pages must be created using templates, but objects which have relations between themselves are best created using templates.
|SMW specific - defines which properties values shall be defined at the creation of an object. Not all pages must be created using templates, but objects which have relations between themselves are best created using templates.
|the template name shall refer to a corresponding category name, and the template shall enforce that category at page creation.
|the template name shall refer to a corresponding category name in <u>singular</u>, and the template shall enforce that category at page creation.
'''''T/UpperCamelCase.OutputFormat'''''
'''''T/UpperCamelCase.OutputFormat'''''
|T/Connector.Infobox
|T/Connector.Infobox
Line 64: Line 65:


{| class="wikitable"
{| class="wikitable"
! Level 1 !! Level 2 !! Level 3 !! Level 4
! Level 1 !! Level 2 !! Level 3 !! transferred
|-
|-
| Basics || || ||
| Basics || || ||x
|-
|-
| Parts || Inverter || ||
| Parts || Inverter || ||x
|-
|-
|  || Motor || ||  
|  || Motor || || x
|-
|-
|  || Battery || ||  
|  || Battery || || x
|-
|-
|  || Charger || ||  
|  || Charger || Rapid Charging|| x
|-
|-
|  || DC/DC || ||  
|  || DC/DC || || x
|-
|-
|  || HVJB (High Voltage Junction Box) || ||  
|  || HVJB (High Voltage Junction Box) || || x
|-
|-
|  || Contactor || ||  
|  || Contactor || || x
|-
|-
|  || PCB || ||  
|  || PCB || ||  
Line 90: Line 91:
|  || ISA Shunt || ||  
|  || ISA Shunt || ||  
|-
|-
|  || Accelerator Pedals and Position Sensors || ||  
|  || Accelerator Pedals and Position Sensors || || x
|-
|-
|  || Gearbox || ||  
|  || Gearbox || || x
|-
|-
|  || Gear Selectors || ||  
|  || Gear Selectors || || x
|-
|-
|  || Power Steering || ||  
|  || Power Steering || || x
|-
|-
|  || HVAC || ||  
|  || || ||  
|-
|-
|  || Heater Air || ||  
|  || || ||  
|-
|-
|  || Heater Coolant || ||  
|  || || ||  
|-
|-
|  || Water Pumps || ||  
|  || Water Pumps || || x
|-
|-
|  || AC Compressor || ||  
|  || Arduino || ||  
|-
|-
|  || Adapter || ||  
|  || Adapter || ||  
|-
|-
| || Arduino || ||  
|
|Thermal Management
|AC Compressor
|x
|-
| || || Heater Coolant|| x
|-
|
|
|Heater Air
|x
|-
|
|HVAC
|Coolant Fittings
|x
|-
|
|
|Coolant Valve
|x
|-
|-
| || ESP32 || ||  
| || ESP32 || || x
|-
|-
| || ESP8266 || ||  
| || ESP8266 || || x
|-
|-
| || ZombieVerter || ||  
| || ZombieVerter || || x
|-
|-
| || VCU || ||  
| || VCU || || x
|-
|-
| OEM Manufacturers || BMW || ||  
| OEM Manufacturers || BMW || || x
|-
|-
| || Bosch || ||  
| || Bosch || || x
|-
|-
| || Chevrolet || ||  
| || Chevrolet || || x
|-
|-
| || Ford || ||  
| || Ford || || x
|-
|-
| || Honda || ||  
| || Honda || || x
|-
|-
| || Hyundai || ||  
| || Hyundai || || x
|-
|-
| || Isabellenhütte || ||  
| || Isabellenhütte || || x
|-
|-
| || Land Rover || ||  
| || Land Rover || || x
|-
|-
| || Lexus || ||  
| || Lexus || || x
|-
|-
| || Mercedes-Benz || ||  
| || Mercedes-Benz || || x
|-
|-
| || MG || ||  
| || MG || || x
|-
|-
| || Mitsubishi || ||  
| || Mitsubishi || || x
|-
|-
| || Nissan || ||  
| || Nissan || || x
|-
|-
| || Opel || ||  
| || Opel || || x
|-
|-
| || Peugeot || ||  
| || Peugeot || || x
|-
|-
| || Renault || ||  
| || Renault || || x
|-
|-
| || Tesla || ||  
| || Tesla || || x
|-
|-
| || Toyota || ||  
| || Toyota || || x
|-
|-
| || VAG (Volkswagen Audi Group) || VW ||  
| || VAG (Volkswagen Audi Group) || VW || x
|-
|-
| || Vauxhall || ||  
| || Vauxhall || || x
|-
|-
| || Volvo || ||  
| || Volvo || || x
|-
|-
| Charging Systems || ChaDeMo || Chademo with Zombieverter ||  
| Charging Systems || ChaDeMo || Chademo with Zombieverter || x
|-
|-
| || CCS || ||  
| || CCS || || x
|-
|-
| || Charge Ports || ||  
| || Charge Ports || || x
|-
|-
| || Rapid Charging || ||  
| || || ||
|-
|-
| || Fast Charging || ||  
| || Fast Charging || || x
|-
|-
| Conversions || Mechanical || Parts ||  
| Conversions || Mechanical || Parts ||  
Line 188: Line 209:
| Fix Links || || ||
| Fix Links || || ||
|-
|-
| Imported Vocabulary || || ||
| || || ||
|-
|-
| Pages with Broken File Links || || ||
| || || ||
|-
|-
| Pages with Ignored Display Titles || || ||
| || || ||
|-
|-
| Request for Review || || ||
| Request for Review || || ||
Line 198: Line 219:
| Troubleshoot || || ||
| Troubleshoot || || ||
|-
|-
| Webasto || || ||
| Webasto || || ||x
|}
|}




I am proposing to shuffle the categories in such structure - italic names are to be created
I am proposing to shuffle the categories in such structure - bold/italic names are to be created
 
==== Manufacturers categories and structure ====
the structure is meant to only identifies the group of brand (as they will likely be sharing components). Therefore, if a brand leaves a group to join another, a distinct brand category must be created.
 
Model names (a specific category - see below) is attached to the brand related to its parent group (i.e. Opel Ampera is linked to GM, Opel Moka is linked to Stellantis). this structure gives us the flexibility to manage changing alliances/holdings over time.
 
Cars are being sold with different names (Opel/Vauxhall, Renault/Mitsubishi etc), therefore, while the Page Name may refer to a specific brand-model combination, the car model <u>shall not</u> be a category on its own.
 
 
The OEM Manufacturers shall include the groups that are delivering parts to car makers (Bosch, Magnetti Marelli etc)
{| class="wikitable"
{| class="wikitable"
|+
|+
!Top level
!Top level
!first level
!Group
!second level
!Brand
!third level
!Note
|-
|OEM Manufacturers
|'''''BMW Group'''''
|BMW
|
|-
|
|
|'''''Mini'''''
|
|-
|
|'''''General Motors'''''
|Chevrolet
|
|-
|
|
|'''''Opel (<2017)'''''
|the Opel Ampera was still under GM, so it is a completely different affiliation than today
|-
|
|'''''Stellantis'''''
|Opel (2017-)
|
|-
|
|
|Vauxhall
|
|-
|
|
|Peugeot
|
|-
|
|
|'''''Citroen'''''
|
|-
|
|'''''Toyota Motor Corporation'''''
|Toyota
|
|-
|
|
|Lexus
|
|-
|
|'''''Hyundai Motor Group'''''
|Hyundai
|
|-
|
|
|'''''Kia'''''
|
|-
|
|'''''Renault-Nissan-Mitsubishi Alliance'''''
|Mitsubishi
|
|-
|
|
|Renault
|
|-
|
|
|Nissan
|
|-
|
|'''''Ford Motor Corporation'''''
|Ford
|
|-
|
|'''''Tata Motors'''''
|Land Rover
|
|-
|
|
|'''''Jaguar'''''
|
|-
|
|VAG (Volkswagen Audi Group)
|'''''Volkswagen'''''
|
|-
|
|
|'''''Audi'''''
|
|-
|
|
|'''''Skoda'''''
|
|-
|
|'''''Geely Holding Group'''''
|Volvo
|
|-
|
|'''''SAIC Motor Europe'''''
|MG
|
|-
|
|Honda
|
|
|-
|
|Bosch
|
|
|-
|
|Isabellenhütte
|
|
|-
|
|Mercedes-Benz
|
|
|-
|
|'''''BYD'''''
|
|
|-
|
|Tesla
|
|
|-
|
|Webasto
|
|moved under OEM Manufacturers
|-
|
|'''''TE Connectivity'''''
|
|build connectors (notably for BMW)
|-
|
|'''''Aptiv'''''
|
|build connectors (notably for Nissan)
|-
|
|'''''Molex'''''
|
|build connectors (notably for Tesla)
|-
|
|
|
|
|-
|
|
|
|
|-
|
|
|
|
|-
|
|
|
|
|-
|
|
|
|
|-
|
|
|
|
|}
 
==== Parts (Components) ====
{| class="wikitable"
!Top level
!2nd level
!3rd level
!Note
|-
|Parts
|Inverter
|
|
|-
|-
|Manufacturer
|
|
|Motor
|
|
|
|
|-
|-
|
|
|Brake Assist
|
|
|
|
|-
|
|
|'''''Battery Packs'''''
|'''''Battery modules'''''
|this is a split of the battery cateogy
|-
|-
|
|
|
|BMS
|moved under Battery packs
|-
|
|
|Contactor
|where SBOX, VBOX and Isabellenhutte should belong. moved under battery packs
|-
|
|DC/DC
|
|
|-
|
|HVJB (High Voltage Junction Box)
|
|
|-
|
|Accelerator Pedals and Position Sensors
|
|
|-
|
|Gearbox
|
|
|-
|
|Gear Selectors
|
|
|-
|
|Power Steering
|
|
|-
|
|Charging Systems
|ChaDeMo
|
|-
|
|
|CCS
|
|-
|
|
|Charge Ports
|
|-
|
|
|Fast Charging
|moved out of charger and under charging systems
|-
|
|
|Charger
|moved under charging systems
|-
|
|Thermal Management
|AC Compressor
|
|-
|
|
|Heater Coolant
|
|-
|
|
|Heater Air
|
|-
|
|
|Water Pumps
|
|-
|
|
|HVAC
|
|-
|
|
|Coolant Fittings
|
|-
|
|
|Coolant Valve
|
|-
|
|'''''Connectors'''''
|
|
|-
|
|'''''Cables'''''
|
|
|-
|
|
|VCU
|
|-
|
|
|ESP32
|
|-
|
|
|ESP8266
|
|-
|
|
|
|
|-
|
|
|
|
|}
==== Software and Electronics ====
{| class="wikitable"
!Top level
!2nd level
!3rd level
!Note
|-
|'''Electronics'''
|VCU
|Zombieverter
|
|-
|
|
|ESP32
|
|-
|
|
|ESP8266
|
|-
|
|
|
|
|}
==== Other categories ====
{| class="wikitable"
!Top level
!2nd level
!3rd level
!Note
|-
|Basics
|Tutorials
|
|covers the necessary understanding required before envisaging a conversion project (maybe merge the 2 categories?)
|-
|Conversion
|
|
|ongoing and succesful conversion projects
|}
==== Proposed for deletion ====
{| class="wikitable"
!Name
!Number of Pages
!Reason for request for deletion
|-
|Accessories
|0
|what is mandatory? What is an accessory? better consider they are parts. the category has 0 page so far
|-
|Hardware
|0
|better call it parts - 0 page
|-
|
|
|
|
|
|
|}
|}

Revision as of 14:22, 10 May 2025

DRAFT - DRAFT - DRAFT

the objective of this page is to explain how the content of the wiki page could be structured using Semantic for Mediawiki (SMW) to build a scalable and object-based wiki (for search and relation-building aspects) and still keeping the freedom for authors to create their content. There needs to be a trade-off to be found between freedom and structure.

Why Semantic for Mediawiki?

SMW allows to have a form-based creation of objects. the form asks the users some key information then create the corresponding page and render the entered information in a consistent way, assign the category accordingly etc.

Because the page created is based on a template, changing the template modifies the instantiation of the created pages.

SMW also allows to create dynamic queries inside pages. The content will be modified based on other pages content. this is a powerful manner to make references to other pages without doing manual maintenance of the page. A practical and basic example would be that if the query below was inserted a page creation (a template being called by a form): 

{{#ask:
  [[FoundIn.Page::{{PAGENAME}}]]
  | format=list
  | link=all
 }}

The page content will update itself to list all other pages that refer to this new page. There are much more granular type of queries to be done (including on categories) which then become really handy.

General Principles and Naming Convention

SMW uses multiple notions. They are key to be used properly for good use.

Object Usage Naming Convention Example
Page the core component of the wiki and what readers are consuming. By default, there is no hierarchical structure of pages - and categories are the better way for structuring a wiki each Word is start with a capital letter. Spaces and brackets are allowed. mutiple words are recommended to be separated by a space (mediawiki uses underscore instead of %20 for URL)

Title Case

Nissan Leaf (2010-2017)
Category the categories are part of the generic Mediawiki structure. its reflects a categorization or labeling of pages. Categories can be nested which are useful to reflect a structure of "component of" and for "is a subtype of". Multiple categories can be assigned to page, hence it can provide multiple view at once. A dedicated section of this page will cover their aspects.

There are cases where it is not obvious whether a property or a category makes more sense. one does not prevent the other, by the way.

as the wiki already as categories created and they use naming similar to Page, the categories will further be named the same way.

Ideally, categories shall be written in plural form (because it is a grouping of x) Title Case (in plural)

Batteries

Connectors

Property SMW specific - it defines a relation between 2 objects, or assign an attribute to an object. the target (called Special:Types) can be a list, another page. When defining a property, it would make sense to refer to a specific category of object (for instance, FoundIn would be referring to a Vehicle or a Component), but the type of object we can refer to are Pages, Numbers, Date,... nothing to do with category. UpperCamelCase.DestinationObjectType or UpperCamelCase.DestinationAttributeType FoundIn.Page

HasWeight.Qty

Template SMW specific - defines which properties values shall be defined at the creation of an object. Not all pages must be created using templates, but objects which have relations between themselves are best created using templates. the template name shall refer to a corresponding category name in singular, and the template shall enforce that category at page creation.

T/UpperCamelCase.OutputFormat

T/Connector.Infobox

T/Battery.PlainText

Form SMW specific - A Form is an helper for the author to create a templated object. The form allows to create a consistent visual structure to pages F/UpperCamelCase - the Form refers to a corresponding Template, but the output format will not be referred to in the form name.

A form can also call multiple templates - in such case its name will refer to the first one

F/Connector

F/Battery

Categories

At the time of writing, the following category structure exist: (in the absence of CategoryTree extension, doing my best to represent it):

Level 1 Level 2 Level 3 transferred
Basics x
Parts Inverter x
Motor x
Battery x
Charger Rapid Charging x
DC/DC x
HVJB (High Voltage Junction Box) x
Contactor x
PCB
CAN
LIN
ISA Shunt
Accelerator Pedals and Position Sensors x
Gearbox x
Gear Selectors x
Power Steering x
Water Pumps x
Arduino
Adapter
Thermal Management AC Compressor x
Heater Coolant x
Heater Air x
HVAC Coolant Fittings x
Coolant Valve x
ESP32 x
ESP8266 x
ZombieVerter x
VCU x
OEM Manufacturers BMW x
Bosch x
Chevrolet x
Ford x
Honda x
Hyundai x
Isabellenhütte x
Land Rover x
Lexus x
Mercedes-Benz x
MG x
Mitsubishi x
Nissan x
Opel x
Peugeot x
Renault x
Tesla x
Toyota x
VAG (Volkswagen Audi Group) VW x
Vauxhall x
Volvo x
Charging Systems ChaDeMo Chademo with Zombieverter x
CCS x
Charge Ports x
Fast Charging x
Conversions Mechanical Parts
OpenInverter Projects
OEM Repurposing
Obsolete
Accessories
Education
Errors
Fix Links
Request for Review
Troubleshoot
Webasto x


I am proposing to shuffle the categories in such structure - bold/italic names are to be created

Manufacturers categories and structure

the structure is meant to only identifies the group of brand (as they will likely be sharing components). Therefore, if a brand leaves a group to join another, a distinct brand category must be created.

Model names (a specific category - see below) is attached to the brand related to its parent group (i.e. Opel Ampera is linked to GM, Opel Moka is linked to Stellantis). this structure gives us the flexibility to manage changing alliances/holdings over time.

Cars are being sold with different names (Opel/Vauxhall, Renault/Mitsubishi etc), therefore, while the Page Name may refer to a specific brand-model combination, the car model shall not be a category on its own.


The OEM Manufacturers shall include the groups that are delivering parts to car makers (Bosch, Magnetti Marelli etc)

Top level Group Brand Note
OEM Manufacturers BMW Group BMW
Mini
General Motors Chevrolet
Opel (<2017) the Opel Ampera was still under GM, so it is a completely different affiliation than today
Stellantis Opel (2017-)
Vauxhall
Peugeot
Citroen
Toyota Motor Corporation Toyota
Lexus
Hyundai Motor Group Hyundai
Kia
Renault-Nissan-Mitsubishi Alliance Mitsubishi
Renault
Nissan
Ford Motor Corporation Ford
Tata Motors Land Rover
Jaguar
VAG (Volkswagen Audi Group) Volkswagen
Audi
Skoda
Geely Holding Group Volvo
SAIC Motor Europe MG
Honda
Bosch
Isabellenhütte
Mercedes-Benz
BYD
Tesla
Webasto moved under OEM Manufacturers
TE Connectivity build connectors (notably for BMW)
Aptiv build connectors (notably for Nissan)
Molex build connectors (notably for Tesla)

Parts (Components)

Top level 2nd level 3rd level Note
Parts Inverter
Motor
Brake Assist
Battery Packs Battery modules this is a split of the battery cateogy
BMS moved under Battery packs
Contactor where SBOX, VBOX and Isabellenhutte should belong. moved under battery packs
DC/DC
HVJB (High Voltage Junction Box)
Accelerator Pedals and Position Sensors
Gearbox
Gear Selectors
Power Steering
Charging Systems ChaDeMo
CCS
Charge Ports
Fast Charging moved out of charger and under charging systems
Charger moved under charging systems
Thermal Management AC Compressor
Heater Coolant
Heater Air
Water Pumps
HVAC
Coolant Fittings
Coolant Valve
Connectors
Cables
VCU
ESP32
ESP8266

Software and Electronics

Top level 2nd level 3rd level Note
Electronics VCU Zombieverter
ESP32
ESP8266

Other categories

Top level 2nd level 3rd level Note
Basics Tutorials covers the necessary understanding required before envisaging a conversion project (maybe merge the 2 categories?)
Conversion ongoing and succesful conversion projects

Proposed for deletion

Name Number of Pages Reason for request for deletion
Accessories 0 what is mandatory? What is an accessory? better consider they are parts. the category has 0 page so far
Hardware 0 better call it parts - 0 page
Retrieved from "https://openinverter.org/wiki/index.php?title=Content_Management&oldid=5773"