Difference between revisions of "Wiki Syntax"

From HPC Wiki
Jump to navigation Jump to search
(Die Seite wurde neu angelegt: „Zum erstellen von Code Segmenten mit Syntax Highlighting: <syntaxhighlight lang="bash"> user1@blablubb:~/test$ ls datei* datei datei1 datei2 datei3 datei4 dat…“)
 
 
(13 intermediate revisions by 5 users not shown)
Line 1: Line 1:
−
Zum erstellen von Code Segmenten mit Syntax Highlighting:
+
This page is about the Wiki source code syntax. There are also Information on [[How-to-Contribute]].
  
 +
== Pictures ==
 +
# Make sure you know or have the licenses to the uploaded material and only use it accordingly!!
 +
# Upload the picture to the Wiki:  [[File:Upload_Picture.PNG|center|1500px]]
 +
# Link the File into the article with <source>[[File:ProPE_Logo.png|1000px]]</source>
 +
# [https://www.mediawiki.org/wiki/Help:Images Format] the picture how you like it :)
 +
 +
== <span id="UsingIDs"></span> Heading IDs ==
 +
 +
When creating internal links to sections, use the id of the heading rather than the current heading name. One advantage of these types of references is, that you are not relying on the plain text of the heading, but rather an internal id. Unlike the id, the heading might change during the development of this Wiki and as a result all links to this heading will break. To create an heading with id <code>UsingIDs</code> for this section:
 +
 +
{| class="wikitable" style="width: 85%;"
 +
|
 +
Invisible span element in front of the visible heading text<br>
 +
[[#UsingIDs|internal link to id UsingIDs]]<br>
 +
[[#Heading_IDs|internal link to heading Heading_IDs]]
 +
|
 
<syntaxhighlight lang="bash">
 
<syntaxhighlight lang="bash">
 +
== <span id="UsingIDs"></span> Heading IDs ==
 +
[[#UsingIDs|internal link to id UsingIDs]]
 +
[[#Heading_IDs|internal link to heading Heading_IDs]]
 +
</syntaxhighlight>
 +
|}
 +
 +
 +
== LaTeX Formula ==
 +
 +
{| class="wikitable" style="width: 85%;"
 +
| <math> a+b = c</math> || <<nowiki />math> a+b = c<<nowiki />/math>
 +
|}
 +
 +
== Code Segments with Syntax Highlighting ==
 +
 +
{| class="wikitable" style="width: 85%;"
 +
| <syntaxhighlight lang="bash">
 
user1@blablubb:~/test$ ls datei*
 
user1@blablubb:~/test$ ls datei*
 
datei datei1 datei2 datei3 datei4 datei5 datei6  # Auch 'datei' ohne Nummer
 
datei datei1 datei2 datei3 datei4 datei5 datei6  # Auch 'datei' ohne Nummer
Line 8: Line 41:
 
user1@blablubb:~/test$ ls datei[1-3]          # Wertebereich
 
user1@blablubb:~/test$ ls datei[1-3]          # Wertebereich
 
datei1 datei2 datei3
 
datei1 datei2 datei3
−
user1@blablubb:~/test$ ls datei[135]          # Wertemenge
 
−
datei1 datei3 datei5
 
−
user1@blablubb:~/test$ touch test{1..5}        # Wertebereich für Klammernexpansion
 
−
user1@blablubb:~/test$ ls test*
 
−
test1 test2 test3 test4 test5
 
−
user1@blablubb:~/test$
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 +
| <source>
 +
<syntaxhighlight lang="bash">
 +
user1@blablubb:~/test$ ls datei*
 +
datei datei1 datei2 datei3 datei4 datei5 datei6  # Auch 'datei' ohne Nummer
 +
user1@blablubb:~/test$ ls datei?
 +
datei1 datei2 datei3 datei4 datei5 datei6
 +
user1@blablubb:~/test$ ls datei[1-3]          # Wertebereich
 +
datei1 datei2 datei3
 +
</syntaxhighlight>
 +
</source>
  
−
Latex Formeln:
+
|-
−
<math> a+b = c</math>
+
 
 +
| <syntaxhighlight lang="python">
 +
import numpy as np
 +
 
 +
def main():
 +
    # ========================================================================
 +
    # Initialisation
 +
    # ----- Switches --------------------------------------------------------
 +
    debug=False
 +
    call_gnuplot=False ## call gnuplot automatically generates gnuplot
 +
</syntaxhighlight>
 +
 
 +
| <source>
 +
<syntaxhighlight lang="python">
 +
import numpy as np
 +
 
 +
def main():
 +
    # ========================================================================
 +
    # Initialisation
 +
    # ----- Switches --------------------------------------------------------
 +
    debug=False
 +
    call_gnuplot=False ## call gnuplot automatically generates gnuplot
 +
</syntaxhighlight>
 +
</source>
 +
|}

Latest revision as of 13:31, 7 July 2022

This page is about the Wiki source code syntax. There are also Information on How-to-Contribute.

Pictures

  1. Make sure you know or have the licenses to the uploaded material and only use it accordingly!!
  2. Upload the picture to the Wiki:
    Upload Picture.PNG
  3. Link the File into the article with 
    [[File:ProPE_Logo.png|1000px]]
  4. Format the picture how you like it :)

Heading IDs

When creating internal links to sections, use the id of the heading rather than the current heading name. One advantage of these types of references is, that you are not relying on the plain text of the heading, but rather an internal id. Unlike the id, the heading might change during the development of this Wiki and as a result all links to this heading will break. To create an heading with id UsingIDs for this section:

Invisible span element in front of the visible heading text
internal link to id
internal link to heading 

== <span id="UsingIDs"></span> Heading IDs ==
[[#UsingIDs|internal link to id UsingIDs]]
[[#Heading_IDs|internal link to heading Heading_IDs]]


LaTeX Formula

<math> a+b = c</math>

Code Segments with Syntax Highlighting

user1@blablubb:~/test$ ls datei*
datei datei1 datei2 datei3 datei4 datei5 datei6  # Auch 'datei' ohne Nummer
user1@blablubb:~/test$ ls datei?
datei1 datei2 datei3 datei4 datei5 datei6
user1@blablubb:~/test$ ls datei[1-3]          # Wertebereich
datei1 datei2 datei3

<syntaxhighlight lang="bash">
user1@blablubb:~/test$ ls datei*
datei datei1 datei2 datei3 datei4 datei5 datei6  # Auch 'datei' ohne Nummer
user1@blablubb:~/test$ ls datei?
datei1 datei2 datei3 datei4 datei5 datei6
user1@blablubb:~/test$ ls datei[1-3]          # Wertebereich
datei1 datei2 datei3
</syntaxhighlight>
import numpy as np

def main():
    # ========================================================================
    # Initialisation
    # ----- Switches --------------------------------------------------------
    debug=False
    call_gnuplot=False ## call gnuplot automatically generates gnuplot

<syntaxhighlight lang="python">
import numpy as np

def main():
    # ========================================================================
    # Initialisation
    # ----- Switches --------------------------------------------------------
    debug=False
    call_gnuplot=False ## call gnuplot automatically generates gnuplot
</syntaxhighlight>
Retrieved from "https://hpc-wiki.info/hpc/index.php?title=Wiki_Syntax&oldid=4867"