Commit 1715d544 authored by Marcel Huber's avatar Marcel Huber
Browse files

Solutions enabled

parent 0e0b24a9
# Gitlab-Pandoc Markdown Cheat Sheet
This file as [PDF
output](/../builds/artifacts/master/file/CheatSheet/CheatSheet.pdf?job=CheatSheet)
The full list of supported *gitlab flavoured markdown* can be found
[here](https://docs.gitlab.com/ce/user/markdown.html)
## Filters
Content filtering using python scripts.
## References / Links
<table style="width:19%;">
<colgroup>
<col width="6%" />
<col width="6%" />
<col width="6%" />
</colgroup>
<thead>
<tr class="header">
<th align="left">
<strong>Reference Type</strong>
</th>
<th align="left">
<strong>Markdown</strong>
</th>
<th align="left">
<strong>Rendered</strong>
</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td align="left">
External Reference I
</td>
<td align="left">
<code>[pgAdmin](https://www.pgadmin.org/)</code>
</td>
<td align="left">
<a href="https://www.pgadmin.org/">pgAdmin</a>
</td>
</tr>
<tr class="even">
<td align="left">
External Reference II
</td>
<td align="left">
<code>&lt;https://www.pgadmin.org/&gt;</code>
</td>
<td align="left">
<a href="https://www.pgadmin.org/" class="uri">https://www.pgadmin.org/</a>
</td>
</tr>
<tr class="odd">
<td align="left">
Reference to repository file or directory
</td>
<td align="left">
<code>[pandoc prelude](CheatSheet/README.pandoc_prelude)</code>
</td>
<td align="left">
<a href="CheatSheet/README.pandoc_prelude">pandoc prelude</a>
</td>
</tr>
<tr class="even">
<td align="left">
Reference to file/dir on different branch
</td>
<td align="left">
<code>[Solutions
Readme](/../tree/Demo-Solutions/CheatSheet/README.solutions.md)</code>
</td>
<td align="left">
<a href="/../tree/Demo-Solutions/CheatSheet/README.solutions.md">Solutions
Readme</a>
</td>
</tr>
<tr class="odd">
<td align="left">
Reference to artifacts file
</td>
<td align="left">
<code>[PDF
output](/../builds/artifacts/master/file/CheatSheet/CheatSheet.pdf?job=CheatSheet)</code>
</td>
<td align="left">
<a href="/../builds/artifacts/master/file/CheatSheet/CheatSheet.pdf?job=CheatSheet">PDF
output</a>
</td>
</tr>
<tr class="even">
<td align="left">
Internal reference to heading (anchor)
</td>
<td align="left">
<code>[Filters](#filters)</code>
</td>
<td align="left">
<a href="#filters">Filters</a>
</td>
</tr>
<tr class="odd">
<td align="left">
</td>
<td align="left">
</td>
<td align="left">
</td>
</tr>
<tr class="even">
<td align="left">
</td>
<td align="left">
</td>
<td align="left">
</td>
</tr>
</tbody>
</table>
Using the `gfm_cleanup.py` filter, `/../` prefixes in internal references will
be replaced with the correct project url.
## Source Code formatting / Code Blocks
Please stick to the following convention to specify code blocks.
- Multi line blocks should be introduced with three backticks followed by a
space and the language
``` sql
SELECT * from Angestellter;
```
results in
``` sql
SELECT * from Angestellter;
```
- Inline Code blocks use single backticks and can not contain language
specifiers on gitlab.
`int main()`
## Tables
It is best to stick with pipe-tables.
| **titel** | **bitmap**|
|:-----------|-----------:|
| Prof. | 1000111101|
| Dr. | 0110000010|
| Dr. habil. | 0001000000|
results in
| **titel** | **bitmap**|
|:-----------|-----------:|
| Prof. | 1000111101|
| Dr. | 0110000010|
| Dr. habil. | 0001000000|
## Images / Figures
tbd.
## Plantuml / Graphviz
``` plantuml
a->b
```
``` plantuml
a->b
```
## Math (\LaTeX style Math)
$`a^2+b^2=c^2`$
$`a^2+b^2=c^2`$
$`N + M * \frac{N}{(B-2)} = 50 + 1000 * \frac{50}{50} = 1050`$
$`N + M * \frac{N}{(B-2)} = 50 + 1000 * \frac{50}{50} = 1050`$
## Hidden content, aka solution
To conditionally hide content from being shown on gitlab and in an output file,
wrap it inside an html comment block like shown here:
<!-- SOLUTION
- Lösungsvorschlag
Optimierung nicht möglich aufgrund fehlender Selektivität und Ausgabe von
nicht-Index Spalten.
SOLUTION -->
To enable its content, the `inline_solutions.py` filter is used. See the full
PDF output
[here](/../builds/artifacts/master/file/CheatSheet/CheatSheet-Solutions.pdf?job=CheatSheet)
- Lösungsvorschlag
Optimierung nicht möglich aufgrund fehlender Selektivität und Ausgabe von
nicht-Index Spalten.
## Emoji and Special/Unicode characters
I recommend using latex Boxes for best result in bot gitlab and pdf output:
- $`\Box`$ latex `\Box`
- $`\boxtimes`$ latex `\boxtimes`
Maybe in the future we can make use of something different like:
- \[ \] Hallo
- \[X\] Gugus
- ◻️ unchecked
- ☑️ checked
- ☐ unchecked unicode [Unicode
Chars](http://unexpected-vortices.com/doc-notes/some-common-unicode-characters.html)
- ☑ checkmarked unicode
- ☒ checked unicode
`:zap:` Emoji requires special \LaTeX configuration and font settings. This is
also not possible at the moment.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment