Adding a content style guide page - #191
Conversation
|
This should include something about logs being in first person without using first person pronouns. |
TheGiraffe3
added
the
enhancement
|
I believe @bene-dictator was also working on a Google doc style guide a while ago, might be useful |
|
Yeah, I remember seeing something about that, and I tried to look for it, but I couldn't find it, so I just started from scratch. |
|
This is my style guide, if it's of any use. It'll be a bit outdated: https://docs.google.com/document/d/1QTrh2HnSHH-iAwXCp7Xpb6h16Q5PLiohoaUZsM03Fd4/edit?usp=sharing |
|
I'll see if there's anything I missed that you covered that I can copy into here. |
Co-authored-by: Anarchist2 <60202690+Anarchist2@users.noreply.github.com>
@bene-dictator I honestly space conversations based on vibes. Spacing before every label often feels like too much, while not having any extra spacing within a conversation can feel claustrophobic, especially for larger conversations. I'm not really sure how to cover spacing within conversations here. I think I added everything else that you covered that I hadn't. |
| Consider the following example: | ||
| ```html | ||
| mission "Example Mission" | ||
| description `Destroy the "Test Dummy."` |
There was a problem hiding this comment.
Wouldn't we normally want to use <npc> here?
| ``` | ||
|
|
||
| In this mission, each token would fall into the three categories as follows: | ||
| 1. Engine keywords: `mission`, `source`, `attributes`, `npc`, `personality` `government` `ship`. These are all roots of particular objects in the game. `mission` is the root of a [Mission](CreatingMissions), `source` of a [LocationFilter](LocationFilters), `npc` of an [NPC](CreatingMissions#non-player-characters-npcs), etc. |
|
|
||
| # Missions | ||
|
|
||
| The identifiers for missions should generally be defined in the following format: `<storyline>: <arc> <part>`. For example, the mission `"Wanderers: Unfettered Diplomacy 1"` is part 1 of the Unfettered Diplomacy arc in the Wanderers storyline. Sometimes, the "arc" is a single mission long, in which case the "part" number should omitted. |
There was a problem hiding this comment.
Maybe you should mention how some missions use the <storyline> <arc> <part> format (and human missions often just do <arc>).
There was a problem hiding this comment.
As noted at the top of the page:
Note that many of these style requirements have been developed over the years, so not all of the game's content may adhere to this guide 100%.
The goal of this guide isn't just to say what we already do, but also solidify what we should be doing going forward.
|
|
||
| # Missions | ||
|
|
||
| The identifiers for missions should generally be defined in the following format: `<storyline>: <arc> <part>`. For example, the mission `"Wanderers: Unfettered Diplomacy 1"` is part 1 of the Unfettered Diplomacy arc in the Wanderers storyline. Sometimes, the "arc" is a single mission long, in which case the "part" number should omitted. |
There was a problem hiding this comment.
As noted at the top of the page:
Note that many of these style requirements have been developed over the years, so not all of the game's content may adhere to this guide 100%.
The goal of this guide isn't just to say what we already do, but also solidify what we should be doing going forward.
Co-authored-by: Loymdayddaud <145969603+TheGiraffe3@users.noreply.github.com>
|
|
||
| Similar to the [C++ style guide](C++-Style-Guide), this page acts as a style guide for all of the game's content (i.e. anything defined in the game's [data format](DataFormat)). For specifics on how different data nodes behave in the game, see the other pages in the wiki relevant to those nodes. The purpose of this page is to define how data should be laid out stylistically so as to improve readability and maintainability of all contributed content. | ||
|
|
||
| Note that many of these style requirements have been developed over the years, so not all of the game's content may adhere to this guide 100%. |
There was a problem hiding this comment.
| Note that many of these style requirements have been developed over the years, so not all of the game's content may adhere to this guide 100%. | |
| Note that many of these style requirements have been developed over the years, so not all of the game's existing content necessarily adheres to this guide 100%. |
| `ship` `Sparrow` `Test Dummy` | ||
| ``` | ||
|
|
||
| The additional quotation marks everywhere makes such a mission unnecessarily visually busy. There is also a question of whether to use single-quotes or double-quoets for quotations inside of a token. (i.e. `'Test Dummy'` vs `"Test Dummy"`). |
There was a problem hiding this comment.
| The additional quotation marks everywhere makes such a mission unnecessarily visually busy. There is also a question of whether to use single-quotes or double-quoets for quotations inside of a token. (i.e. `'Test Dummy'` vs `"Test Dummy"`). | |
| The additional quotation marks everywhere makes such a mission unnecessarily visually busy. There is also a question of whether to use single-quotes or double-quotes for quotations inside of a token. (i.e. `'Test Dummy'` vs `"Test Dummy"`). |
6 participants
Started work on a content style guide. This is not exhaustive or complete in any way, and what is here is open for discussion. This is just what I could come up with off the top of my head over the course of about an hour and a half. I stopped when I got bored.
This is a pre-requisite for endless-sky/endless-sky#9834.