From f2cae01a6543e0e16eeb29e4484e3b98d1183413 Mon Sep 17 00:00:00 2001 From: Andrei Kurosh Date: Sat, 20 Apr 2024 17:21:34 +0200 Subject: [PATCH] English translations for guidelines and markdown rules. --- .../Admin/Views/Help/Guidelines.en-US.cshtml | 57 +++++++++++++ .../Admin/Views/Help/Markdown.en-US.cshtml | 82 +++++++++++++++++++ 2 files changed, 139 insertions(+) create mode 100644 src/Bonsai/Areas/Admin/Views/Help/Guidelines.en-US.cshtml create mode 100644 src/Bonsai/Areas/Admin/Views/Help/Markdown.en-US.cshtml diff --git a/src/Bonsai/Areas/Admin/Views/Help/Guidelines.en-US.cshtml b/src/Bonsai/Areas/Admin/Views/Help/Guidelines.en-US.cshtml new file mode 100644 index 0000000..f02e144 --- /dev/null +++ b/src/Bonsai/Areas/Admin/Views/Help/Guidelines.en-US.cshtml @@ -0,0 +1,57 @@ +@{ + Layout = "HelpLayout.cshtml"; + ViewBag.Title = "Style"; +} + + + +

Text style recommendations

+ +

+ The purpose of this website is storage and arrangement of the family history. + To make it pleasant and interesting to read, all authors should adhere to the following recommendations. +

+

Please, keep them in mind while writing and editing articles.

+ +
    +
  1. + Objectivity:
    + Be fair and focus on the facts. Avoid personal opinions: they can be disputable and change overtime. +
  2. +
  3. + Positivity:
    + When possible, pay more attention to good things. Such stories will make a more pleasant reading. +
  4. +
  5. + Informativity:
    + Think of the things which will still be important and interesting to people reading your article in 50 or 100 years. Omit insignificant details and keep the language simple. +
  6. +
  7. + Order:
    + Describe events in chronological order: birth, childhood, study, work, family, old age. Avoid flashforwards. If there is enough information, split it into chapters by using headers. +
  8. +
  9. + Appearance:
    + Write in proper English, use spellcheckers if necessary. Split the text into paragraphs and add links to mentioned pages. +
  10. +
  11. + Accuracy:
    + Partial information is better than none. If you are unsure about some particular fact (date, name, place) - write as you remember. Someone might improve it later. +
  12. +
+ +

Media recommendation

+ +
    +
  1. This website is not Instagram Stories: upload only important things. Best ratio is 5 photos and videos per person per year.
  2. +
  3. Use tags to link to people depicted on photos and videos.
  4. +
  5. Prefer well taken photos. If needed, use retouching software to process them before uploading.
  6. +
  7. Do not upload photos with nudity, especially of kids, even if you perceive it as cute.
  8. +
\ No newline at end of file diff --git a/src/Bonsai/Areas/Admin/Views/Help/Markdown.en-US.cshtml b/src/Bonsai/Areas/Admin/Views/Help/Markdown.en-US.cshtml new file mode 100644 index 0000000..76f2935 --- /dev/null +++ b/src/Bonsai/Areas/Admin/Views/Help/Markdown.en-US.cshtml @@ -0,0 +1,82 @@ +@{ + Layout = "HelpLayout.cshtml"; + ViewBag.Title = "Markup"; +} + + + +

Text formatting

+

Text decoration is done in the Markdown language. It allows using headers, links, images and other styles in plain text.

+ +
Headers
+

Use the # symbols to denote a header (more is smaller).

+
+# Huge first level header
+## Second level header (a bit smaller)
+###### Smallest header
+
+ +
Text styles
+
+_This line will be written in italics_
+**This one is bold**
+And naturally, _these can be **combined** freely_
+
+ +
Lists
+

Unordered lists start with the * symbol. For nested lists use 4 space indentation.

+
+* Element 1
+* Element 2
+    * Element 2.2
+
+

For ordered lists use the number and the dot.

+
+1. Element 1
+    1. Element 1.1
+2. Element 2
+
+ +
Links
+

The easiest way to create a link is to press @@ and start typing the page name. A pop-up menu will appear where you can select the desired page with arrow keys or mouse.

+

Extended search can be performed by clicking the "link" icon in the text editor toolbar. The list of options there is longer and can be filtered by type.

+

Link to a page is written in double square brackets. First goes the full page ID, then a vertical pipe, then the link's text':

+
+Link to [[John_Smith|John's]] page will be here.
+
+ +
Images
+

Images can be added to the text using the same square brackets and the media: prefix.

+

The easiest way is to click the "image" icon in the text editor toolbar and pick the image from it.

+

The following options are available:

+ + +
+[[media:12345]] - small image on the left side
+[[media:12345|align:right]] - medium image on the right side
+[[media:12345|align:center|size:large]] - a huge one right in the center
+
\ No newline at end of file