Help:Conventions/en: Difference between revisions
(Created page with "Regarding meetings, we use the following naming convention:") |
(Created page with "In order to efficiently organize the wiki, we defined some usage conventions.") |
||
| (7 intermediate revisions by the same user not shown) | |||
| Line 3: | Line 3: | ||
== Introduction == | == Introduction == | ||
In order to efficiently organize the wiki, we defined some usage conventions. | |||
== Categories == | == Categories == | ||
| Line 24: | Line 24: | ||
Regarding meetings, we use the following naming convention: | Regarding meetings, we use the following naming convention: | ||
Workgroup/Meeting/DD MM YYYY | |||
<!--T:14--> | <!--T:14--> | ||
Example: [[Pirate Lab/Meeting/25 03 2017]] | |||
* | * '''Workgroup''' is the team organizing the meeting. Since there can be several workgroups organizing the same meeting, the page is named after the main workgroup. | ||
* ''' | * '''DD''', '''MM''' and '''YYYY''' are the day, month and year of the meeting, respectively. | ||
We also ask meetings' organizers to include the [[Template:MeetingSidebar|MeetingSidebar template]]. As for crews, this template is used to indicate the date and time of the meeting, the address, etc. It allows us, amongst other things, to display each meeting on a map. | |||
== | == Projects == | ||
We haven't defined a naming convention for project yet (see [[WikiSquad/Project/Improving the Wiki]]). | |||
Latest revision as of 10:13, 3 March 2017
Introduction
In order to efficiently organize the wiki, we defined some usage conventions.
Categories
The naming convention used for categories is the following:
- Categories are singular. Example: Crew instead of Crews.
- Categories are in English, if possible. Example: Crew, instead of Equipage.
- Categories start with an uppercase. Example: Crew, instead of crew.
- Categories composed of several words have those words separated by spaces. Example: Crew in Brussels.
Crews
There isn't any naming convention for crews. Note that, for historical reasons, most crew's names start with Crew Something, but this is not mandatory at all.
However, we ask that every crew includes the CrewSidebar template. This template is used to indicate the member list, the captain's name, navigator's name (if they exist), anchoring point (location where most meetings are organized), etc. It also automatically generates categories related to the crew, and semantic properties (status, city, province, region, etc). More concretely, this template allows us to display each crew on a map.
Meetings
Regarding meetings, we use the following naming convention:
Workgroup/Meeting/DD MM YYYY
Example: Pirate Lab/Meeting/25 03 2017
- Workgroup is the team organizing the meeting. Since there can be several workgroups organizing the same meeting, the page is named after the main workgroup.
- DD, MM and YYYY are the day, month and year of the meeting, respectively.
We also ask meetings' organizers to include the MeetingSidebar template. As for crews, this template is used to indicate the date and time of the meeting, the address, etc. It allows us, amongst other things, to display each meeting on a map.
Projects
We haven't defined a naming convention for project yet (see WikiSquad/Project/Improving the Wiki).