Scribd
Upload
25 views5 pages

Markdown Formating

Uploaded by

cmerve05
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
25 views5 pages

Markdown Formating

Uploaded by

cmerve05
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 5

Markdown Formatting

List of fields where markdown formatting is allowed

If the field is not listed here and you consider it necessary, then first you need to get approval
from IT about using markdown and IT has to implement markdown parsing for this field. Then
this field has to be added below.

LCN
- School description (this is the online field from school update form so far)
- City description
- Country description
- Online course: specific text related to reviews
- Course descriptions

HD
- Product descriptions
- Category descriptions

UG
- University/business school descriptions, pro, cons
- City description
- Country descriptions
- Country guides (if not setup finally via wordpress, which may be better)

Expected benefits
- faster implementation of formating for copywriters
- creation of better formatted structured texts for better readability and better google rankings
- more formatting options available to copywriters
- less time for IT for formatting issues and less need for time consuming atomic splitting of texts
- less occurrences of formatting errors within the translation process
- easier maintenance of texts
- better readability of code for non-programmers
Markdown formatting that is allowed to be used

Basic syntax of markdown


All formatting of basic syntax is allowed as outlined here
https://www.markdownguide.org/basic-syntax/
But you should always stick to primary formatting for each formatting. E.g. for bold only **
should be used and not the alternatives.

Advanced syntax of markdown


If anybody feels the need to use any formatting from advanced syntax then this must be
approved. In general we probably will only approve:
a) Footnotes:
Use only if absolutely necessary. Avoid using footnotes wherever possible and if not
possible then ask for approval, but keep in mind footnotes work only in a way that
footnotes are showing directly at the end of the text you write.
b) Tables:
Only very simple tables may be allowed. In most cases we will have to build tables in
html
c) Emojis:
Complete list here: https://www.webfx.com/tools/emoji-cheat-sheet/
We should only use symbols of emojis. Most emojis may look too informal and therefore
may not be suitable for our web content.
You can use emoji code exactly as indicated below e.g. :copyright:
Examples of suitable emojis:

:copyright:

:x:

:heavy_exclamation_mark:

:heavy_plus_sign:

:heavy_minus_sign:

:ballot_box_with_check:

:heavy_check_mark:
:white_check_mark:

:arrow_right:

:link:

:information_source:

:question:

:grey_question:

:grey_exclamation:

:star:
d) Table of Contents (ToC):
Generation of a table of contents is automatic. The table of contents location must be
specified by using the tag: [TOC]

e.g. markdown content:

[TOC]

## Level 2 Heading
This is a sample document that starts with a level 2 heading

### Level 3 Heading


This is a sample document that starts with a level 3 heading

e) Youtube video embed:


Youtube videos can be embedded using pure html. Via iframe with embed url

e.g.
<iframe width="600" height="300"
src="http://www.youtube.com/embed/J---aiyznGQ?autoplay=1" frameborder="0"
allowfullscreen="1"></iframe>

Another option allowed is using the youtube video url (as it appears in the browsers
address bar) as follows:

e.g.
[](https://www.youtube.com/watch?v=J---aiyznGQ)

Named anchor markdown


Manually adding links to auto generated ToC anchors

Instructions for copywriting with markdown


Important point to keep in mind:
- Many formattings will break if you miss or add a space before or after or in between.
When in doubt you can always test your code by simply copying it here in this online
markdown editor: https://dillinger.io/
E.g. bold parts must be encapsulated with ** without spaces.
For bullet list, no space allowed before the - AND there must be a space after the -

- Final version of longer texts must always be tested before submission by copying into
this online editor https://dillinger.io/. Bookmark this link and link it from your browser
bookmark bar.

- You need to be careful with header formattings. Header formattings # or ## or ### need
to be in coherence with other HTML header hierarchy we already use on the page. So
in case your text is not the only text on this page (apart from header and footer) you
need to ask IT which is the highest header hierarchy you are allowed to use so that your
text fits in semantically correctly into the existing page.
E.g. if your page appears in an existing page under an <h3> then you can only use
headers with 4 or more hashtags such as #### or ##### etc.

Official markdown Instructions to read


https://www.markdownguide.org/cheat-sheet/
https://www.markdownguide.org/basic-syntax/
https://www.markdownguide.org/extended-syntax/

https://secure.languagecourse.net/sf/control-page/school-data.php?a=4534005

You might also like