From 2a5297c09093893a5136c9e1f8585c4a422a53c8 Mon Sep 17 00:00:00 2001 From: UBlueberry <161545003+UBlueberry@users.noreply.github.com> Date: Mon, 19 Aug 2024 21:08:39 -0400 Subject: [PATCH 1/5] attempt one --- .../tips/writing-guidebook-entries.md | 42 +++++++++++++++++-- 1 file changed, 38 insertions(+), 4 deletions(-) diff --git a/src/en/general-development/tips/writing-guidebook-entries.md b/src/en/general-development/tips/writing-guidebook-entries.md index 663cfcfc3..ce20aa93f 100644 --- a/src/en/general-development/tips/writing-guidebook-entries.md +++ b/src/en/general-development/tips/writing-guidebook-entries.md @@ -18,13 +18,14 @@ Thus, the simplest entry you can make looks like this: ``` -Any text written in the bounds of the tag will be displayed plainly on the guide. But, if you write a guide with only plain text, you will write an incredibly boring guide that will make my eyes glaze over and make me keel over and die. +Any text written in the bounds of the tag will be displayed plainly on the guide. But, if you write a guide with only plain text, eye explosion (and subsequent death) rates will skyrocket globally. -To alleviate my oncoming death, consider using the (small) variety of markdown tags that are supported: +Save hundreds of l-eye-ves and use the (small) variety of markdown tags that are supported: - `#` creates a title - `##` creates a heading - `-` creates a list entry - `[color=hex][/color]` colors the text inside the tags with the specified hex color. +- `[bold][/bold]` and `[italic][/italic]` make text inside the tags bold or italic respectively. ### Example Here is an example guidebook entry, `magboots.xml` @@ -171,14 +172,47 @@ Here's an example: guides: - MachineUpgrading #this is the guide that is opened ``` +## Using Markdown +For consistency across the guidebook, it's easier to pick one way to use each markdown tag and stick to it. + +A good way to use each tag is listed here. +- `[color=cyan]` should be used to highlight keywords or phrases directly related to the subheader. +- `[bold]` is good for keywords or phrases of a paragraph (but not necessarily a subheader). +- `[italic]` is good for emphasis on sentences or clauses that may be important to read. +- Highlight allegiances, departments or roles with `[color=someotherrelevantcolorthatisn'tcyanprobably]`. +- Text links make the guidebook more interactive and can be done with `[textlink="text" link="guide.xml"]`. +- `[color=#a4885c][italic]` is good for actions or text found in the context menu. +- `[color=yellow][bold][keybind="function"]` is a superb combo to bring attention to keybinds which may be short. +- And of course, it may become clear that you need to use `[color=red]`. + +All of this comes together in this example that may or may not be based on reality: +```xml +## What I had for lunch today +Today I decided to have a [color=cyan]burrito[/color] because it was easy to make and I was feeling lazy. + +[bold]Knowing how to roll a burrito[/bold] is vital to consistently making good ones. + +[bold]Cheese[/bold] is simply a requirement. If you don't put any in your burrito, [italic]I'll refuse to eat it.[/italic] + +I think [bold]Rat Kings[/bold] should find a burrito or two every time when they [color=#a4885c][italic]Rummage[/italic][/color]. + +If you're holding a burrito in your hand, you can press [color=yellow][bold][keybind="ActivateItemInHand"][/bold][/color] to eat it. + +[color=#cb0000]Security[/color] hates burritos. That's why I joined [color=#66FF00]The Spider Clan[/color]. + +If you hate burritos, [color=red]I'll be very very mad at you.[/color] I hope the [color=pink]Clown[/color] slips you. +``` +![image](https://github.com/user-attachments/assets/9327f98f-bd40-44a7-981e-1ac4cf9b7a6b) + +Important text is highlighted, it's got visual appeal, and it's easy to read. Success! ## Best Practices Here are some general tips for writing good guides: - Keep titles clear and concise. Players don't want to search around for what they need. - Keep entries short. You can always add child entries if you want to elaborate more on the topic. -- Use boxes, embedded entities, and text colors to give entries visual interest. - - A commonly used color for emphasis is `#a4885c`. +- Use a healthy amount of boxes, embedded entities, and markdown tags. + - Remember not to overdo it, though. If most of the text has a markdown tag, it's too much. - Refrain from including specific advice and "meta" strategies. The guide should be an impartial source of information. - Articles should be written in a neutral tone. - Encourage interacting with the guide. From 884fc2cce8652059b6671b68e0a4a8e16162d61a Mon Sep 17 00:00:00 2001 From: UBlueberry <161545003+UBlueberry@users.noreply.github.com> Date: Mon, 19 Aug 2024 21:23:54 -0400 Subject: [PATCH 2/5] attempt one and a half stuff i meant to come back to --- .../tips/writing-guidebook-entries.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/src/en/general-development/tips/writing-guidebook-entries.md b/src/en/general-development/tips/writing-guidebook-entries.md index ce20aa93f..f6bf360e5 100644 --- a/src/en/general-development/tips/writing-guidebook-entries.md +++ b/src/en/general-development/tips/writing-guidebook-entries.md @@ -21,11 +21,14 @@ Thus, the simplest entry you can make looks like this: Any text written in the bounds of the tag will be displayed plainly on the guide. But, if you write a guide with only plain text, eye explosion (and subsequent death) rates will skyrocket globally. Save hundreds of l-eye-ves and use the (small) variety of markdown tags that are supported: -- `#` creates a title -- `##` creates a heading -- `-` creates a list entry +- `#` creates a title. +- `##` creates a heading. +- `-` creates a list entry. - `[color=hex][/color]` colors the text inside the tags with the specified hex color. - `[bold][/bold]` and `[italic][/italic]` make text inside the tags bold or italic respectively. +- `[keybind=""]` will display the user's keybind for the function in the quotation marks. + - The list of functions can be found in `keybinds.yml`. +- `[textlink="text" link="guideID"]` will allow users to jump to the article linked. ### Example Here is an example guidebook entry, `magboots.xml` @@ -180,7 +183,7 @@ A good way to use each tag is listed here. - `[bold]` is good for keywords or phrases of a paragraph (but not necessarily a subheader). - `[italic]` is good for emphasis on sentences or clauses that may be important to read. - Highlight allegiances, departments or roles with `[color=someotherrelevantcolorthatisn'tcyanprobably]`. -- Text links make the guidebook more interactive and can be done with `[textlink="text" link="guide.xml"]`. +- Text links make the guidebook more interactive and can be done with `[textlink="text" link="guideID"]`. - `[color=#a4885c][italic]` is good for actions or text found in the context menu. - `[color=yellow][bold][keybind="function"]` is a superb combo to bring attention to keybinds which may be short. - And of course, it may become clear that you need to use `[color=red]`. From bf1e9637c5930fa20d203c801055047ac67973c0 Mon Sep 17 00:00:00 2001 From: UBlueberry <161545003+UBlueberry@users.noreply.github.com> Date: Mon, 19 Aug 2024 22:46:27 -0400 Subject: [PATCH 3/5] creds to CS Ghost Animation i mean uhh Moomoobeef --- .../tips/writing-guidebook-entries.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/src/en/general-development/tips/writing-guidebook-entries.md b/src/en/general-development/tips/writing-guidebook-entries.md index f6bf360e5..4b9186d45 100644 --- a/src/en/general-development/tips/writing-guidebook-entries.md +++ b/src/en/general-development/tips/writing-guidebook-entries.md @@ -186,7 +186,7 @@ A good way to use each tag is listed here. - Text links make the guidebook more interactive and can be done with `[textlink="text" link="guideID"]`. - `[color=#a4885c][italic]` is good for actions or text found in the context menu. - `[color=yellow][bold][keybind="function"]` is a superb combo to bring attention to keybinds which may be short. -- And of course, it may become clear that you need to use `[color=red]`. +- And of course, `[color=red]` adds a lot of impact to your sentences, but remember to use it sparingly! Most of the time, you can use boldface instead. All of this comes together in this example that may or may not be based on reality: ```xml @@ -209,6 +209,22 @@ If you hate burritos, [color=red]I'll be very very mad at you.[/color] I hope th Important text is highlighted, it's got visual appeal, and it's easy to read. Success! +### Department Colors (hex) +Credit to Moomoobeef, who has included these in his user profile on the wiki. https://wiki.spacestation14.com/wiki/User:Moomoobeef +- `#cb0000` Security +- `#c96dbf` Science +- `#5b97bc` Medical +- `#b18644` Cargo +- `#f39f27` Engineering +- `#ff2fff` Clown +- `#9fed58` Service +- `#6e6e6e` Passenger +- `#1b67a5` Command (blue) +- `#009100` CentCom (green) +- `#134975` NanoTrasen (blue) +- `#ff0000` Syndicate +- `#66ff00` Spider Clan + ## Best Practices Here are some general tips for writing good guides: From aa1513284479ca32bdca5233d0a86b3e3077e398 Mon Sep 17 00:00:00 2001 From: UBlueberry <161545003+UBlueberry@users.noreply.github.com> Date: Mon, 19 Aug 2024 22:47:53 -0400 Subject: [PATCH 4/5] forgot one --- src/en/general-development/tips/writing-guidebook-entries.md | 1 + 1 file changed, 1 insertion(+) diff --git a/src/en/general-development/tips/writing-guidebook-entries.md b/src/en/general-development/tips/writing-guidebook-entries.md index 4b9186d45..67e0dbd54 100644 --- a/src/en/general-development/tips/writing-guidebook-entries.md +++ b/src/en/general-development/tips/writing-guidebook-entries.md @@ -211,6 +211,7 @@ Important text is highlighted, it's got visual appeal, and it's easy to read. Su ### Department Colors (hex) Credit to Moomoobeef, who has included these in his user profile on the wiki. https://wiki.spacestation14.com/wiki/User:Moomoobeef +- `#a4885c` Highlight text (old, use cyan) - `#cb0000` Security - `#c96dbf` Science - `#5b97bc` Medical From dd8cdd90dd2307e823364b8f12a1d4ab23c59fbc Mon Sep 17 00:00:00 2001 From: UBlueberry <161545003+UBlueberry@users.noreply.github.com> Date: Tue, 20 Aug 2024 20:24:05 -0400 Subject: [PATCH 5/5] markdown more like markfrown --- .../tips/writing-guidebook-entries.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/en/general-development/tips/writing-guidebook-entries.md b/src/en/general-development/tips/writing-guidebook-entries.md index 67e0dbd54..c1ae119e0 100644 --- a/src/en/general-development/tips/writing-guidebook-entries.md +++ b/src/en/general-development/tips/writing-guidebook-entries.md @@ -20,7 +20,7 @@ Thus, the simplest entry you can make looks like this: Any text written in the bounds of the tag will be displayed plainly on the guide. But, if you write a guide with only plain text, eye explosion (and subsequent death) rates will skyrocket globally. -Save hundreds of l-eye-ves and use the (small) variety of markdown tags that are supported: +Save hundreds of l-eye-ves and use the (small) variety of richtext tags that are supported: - `#` creates a title. - `##` creates a heading. - `-` creates a list entry. @@ -175,8 +175,8 @@ Here's an example: guides: - MachineUpgrading #this is the guide that is opened ``` -## Using Markdown -For consistency across the guidebook, it's easier to pick one way to use each markdown tag and stick to it. +## Using Richtext +For consistency across the guidebook, it's easier to pick one way to use each richtext tag and stick to it. A good way to use each tag is listed here. - `[color=cyan]` should be used to highlight keywords or phrases directly related to the subheader. @@ -231,8 +231,8 @@ Credit to Moomoobeef, who has included these in his user profile on the wiki. ht Here are some general tips for writing good guides: - Keep titles clear and concise. Players don't want to search around for what they need. - Keep entries short. You can always add child entries if you want to elaborate more on the topic. -- Use a healthy amount of boxes, embedded entities, and markdown tags. - - Remember not to overdo it, though. If most of the text has a markdown tag, it's too much. +- Use a healthy amount of boxes, embedded entities, and richtext. + - Remember not to overdo it, though. If most of the text is bold or colored, it's too much. - Refrain from including specific advice and "meta" strategies. The guide should be an impartial source of information. - Articles should be written in a neutral tone. - Encourage interacting with the guide.