The material here uses the following notation. This is especially helpful if you contribute content, so we keep the content consistent.
If you like to see the details on how to create them in the markdown documents, you can to look at the file source while clicking on the cloud in the heading of the Notation section (@sec:notation). This brings you to the markdown text. However, to see it you still have to look at the raw content to see the details.
☁️ or 
If you click on the ☁️ or
in a heading, you can go directly to the document in GitHub that contains the next content. This is convenient to fix errors or make additions to the content. The cloud is automatically added upon the inclusion of a new markdown file that includes in its first line a section header.
$
Content in bash is marked with verbatim text and a dollar sign
$ This is a bash text
[@las14cloudmeshmultiple]
References are indicated with a number and are included in the reference chapter [@las14cloudmeshmultiple]. Use it in markdown with
[@las14cloudmeshmultiple]. References must be added to thereferences.bibfile in BibTex format.
Chapters marked with this emoji are not yet complete or have some issue that we know about. These chapters need to be fixed. If you like to help us fixing this section, please let us know. Use it in markdown with
:o2:or if you like to use the image with.
REST 36:02Example for a video with the
emoji. Use it in markdown with[ REST 36:02](https://youtu.be/xjFuA6q5N_U)
Slides 10Example for slides with the
emoji. These slides may or may not include audio.
Slides 10Slides without any audio. They may be faster to download. Use it in markdown with
[ Slides 10](TBD).
A set of learning objectives with the
emoji.
A section is released when it is marked with this emoji in the syllabus. Use it in markdown with
.
Indicates opportunities for contributions. Use it in markdown with
.
Indicates sections that are worked on by contributors. Use it in markdown with
.
Sections marked by the contributor with this emoji
when they are ready to be reviewed.
Sections that need modifications are indicated with this emoji
.
A warning that we need to look at in more detail
Notes are indicated with a bulb
Other emojis
Other emojis can be found at https://gist.github.com/rxaviers/7360908. However, note that emojis may not be viewable in other formats or on all platforms. We know that some emojis do not show in Calibre, but they do show in macOS iBooks and MS Edge
This is the list of emojis that can be converted to PDF. So if you like a PDF, please limit your emojis to
:cloud: ☁️
:o2: :relaxed: :sunny: ☀️
:baseball: ⚾
:spades: :hearts: :clubs: :diamonds: :hotsprings: ♨️
:warning: :parking: :a: :b: :recycle: ♻️
:copyright: ©️
:registered: ®️
:tm: ™️
:bangbang: :interrobang: :scissors: ✂️
:phone: ☎️
Figures have a caption and can be referred to in the ePub simple with a number. We show such a reference pointer while referring to @fig:code-example.
![Figure example [@las14cloudmeshmultiple]](/cloudmesh-community/book/blob/main/chapters/preface/images/code.png)
{#fig:code-example width=1in}
Figures must be written in the md as
![Figure example [@las14cloudmeshmultiple]](images/code.png){#fig:code-example width=1in}Note that the text must be in one line and must not be broken up even if
it is longer than 80 characters. You can refer to them with
@fig:code-example. Please note for numbering to work, figure
references must include the #fig: followed by a unique identifier.
Please note that identifiers must be unique and that identifies
such as #fig:cloud or similar simple identifiers are a poor choice and
will likely not work. To check, please list all lines with an identifier,
such as. Also not that if the image is copied form the internet you must
not use the http link, but you must copy the image into the images folder.
In addition for these images you must create a bibtex entru to the
source where this image originated from. This applies also to images
that you reused in other papers of yours. However if you have created
the image yoruslef and it is not just a redrawing of somone elses work,
you do not need a citation.
$ grep -R "#fig:" chaptersand see if your identifier is genuinely unique.
To create hyperlinks in the document other than images, we need to use proper markdown syntax in the source. This is achieved with a reference, for example, in sections headers. Let us discuss the reference header for this section, e.g., Notation. We have augmented the section header as follows:
# Notation {#sec:notation}
Now we can use the reference in the text as follows:
In @sec:notation we explain ...
It will be rendered as: In @sec:notation we explain ...
Equations can be written as
$$a^2+b^2=c^2$${#eq:pythagoras}
and used in text:
It will render as: As we see in @eq:pythagoras.
The equation number is optional. Inline equations just use one dollar sign and do not need an equation number:
This is the Pythagoras theorem: $a^2+b^2=c^2$
Which renders as:
This is the Pythagoras theorem:
Tables can be placed in the text as follows:
: Sample Data Table {#tbl:sample-table}
x y z
--- --- ---
1 2 3
4 5 42
--- --- ---
As usual, make sure the label is unique. When compiling, it results in
an error if labels are not unique. Additionally, there are several md
table generators available on the internet and make creating table more
efficient.