Skip to content

Commit

Permalink
English translations for guidelines and markdown rules.
Browse files Browse the repository at this point in the history
  • Loading branch information
impworks committed Apr 22, 2024
1 parent 47cc79f commit f2cae01
Show file tree
Hide file tree
Showing 2 changed files with 139 additions and 0 deletions.
57 changes: 57 additions & 0 deletions src/Bonsai/Areas/Admin/Views/Help/Guidelines.en-US.cshtml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
@{
Layout = "HelpLayout.cshtml";
ViewBag.Title = "Style";
}

<ul class="nav justify-content-center">
<li class="nav-item">
<a class="nav-link" href="@Url.Action("Markdown")">Markup</a>
</li>
<li class="nav-item">
<a class="nav-link disabled" href="#">Style</a>
</li>
</ul>

<h3>Text style recommendations</h3>

<p>
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.
</p>
<p>Please, keep them in mind while writing and editing articles.</p>

<ol>
<li>
<strong>Objectivity</strong>:<br />
Be fair and focus on the facts. Avoid personal opinions: they can be disputable and change overtime.
</li>
<li>
<strong>Positivity</strong>:<br />
When possible, pay more attention to good things. Such stories will make a more pleasant reading.
</li>
<li>
<strong>Informativity</strong>:<br />
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.
</li>
<li>
<strong>Order</strong>:<br />
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.
</li>
<li>
<strong>Appearance</strong>:<br />
Write in proper English, use spellcheckers if necessary. Split the text into paragraphs and add links to mentioned pages.
</li>
<li>
<strong>Accuracy</strong>:<br />
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.
</li>
</ol>

<h3>Media recommendation</h3>

<ol>
<li>This website is not Instagram Stories: upload only important things. Best ratio is 5 photos and videos per person per year.</li>
<li>Use tags to link to people depicted on photos and videos.</li>
<li>Prefer well taken photos. If needed, use retouching software to process them before uploading.</li>
<li>Do not upload photos with nudity, especially of kids, even if you perceive it as cute.</li>
</ol>
82 changes: 82 additions & 0 deletions src/Bonsai/Areas/Admin/Views/Help/Markdown.en-US.cshtml
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
@{
Layout = "HelpLayout.cshtml";
ViewBag.Title = "Markup";
}

<ul class="nav justify-content-center">
<li class="nav-item">
<a class="nav-link disabled" href="#">Markup</a>
</li>
<li class="nav-item">
<a class="nav-link" href="@Url.Action("Guidelines")">Style</a>
</li>
</ul>

<h3>Text formatting</h3>
<p>Text decoration is done in the <b>Markdown</b> language. It allows using headers, links, images and other styles in plain text.</p>

<h5>Headers</h5>
<p>Use the <code>#</code> symbols to denote a header (more is smaller).</p>
<pre>
# Huge first level header
## Second level header (a bit smaller)
###### Smallest header
</pre>

<h5>Text styles</h5>
<pre>
_This line will be written in italics_
**This one is bold**
And naturally, _these can be **combined** freely_
</pre>

<h5>Lists</h5>
<p>Unordered lists start with the <code>*</code> symbol. For nested lists use 4 space indentation.</p>
<pre>
* Element 1
* Element 2
* Element 2.2
</pre>
<p>For ordered lists use the number and the dot.</p>
<pre>
1. Element 1
1. Element 1.1
2. Element 2
</pre>

<h5>Links</h5>
<p>The easiest way to create a link is to press <code>@@</code> and start typing the page name. A pop-up menu will appear where you can select the desired page with arrow keys or mouse.</p>
<p>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.</p>
<p>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':</p>
<pre>
Link to [[John_Smith|John's]] page will be here.
</pre>

<h5>Images</h5>
<p>Images can be added to the text using the same square brackets and the <code>media:</code> prefix.</p>
<p>The easiest way is to click the "image" icon in the text editor toolbar and pick the image from it.</p>
<p>The following options are available:</p>
<ul>
<li>
<p>Size:</p>
<ul>
<li><code>size:small</code> - smallest size</li>
<li><code>size:medium</code> - average size</li>
<li><code>size:large</code> - biggest size</li>
</ul>
</li>
<li>
<p>Alignment:</p>
<ul>
<li><code>align:left</code> - goes left</li>
<li><code>align:center</code> - in the middle</li>
<li><code>align:right</code> - goes right</li>
</ul>
</li>
</ul>

<pre>
[[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
</pre>

0 comments on commit f2cae01

Please sign in to comment.