Differences

This shows you the differences between two versions of the page.

--- wiki_kurzeinfuehrung [01 Aug 2020 06:05] – [copy and paste] lutz
+++ wiki_kurzeinfuehrung [04 Mar 2022 15:09] (current) – [new line] lutz
@@ Line 1: / Line 1: @@
 ====== Wiki Kurzeinführung ======
+===== new line =====
+Most important for wikis: How to tell the Wiki to make a new line. \\ Use a double backslash with spaces around it: %% \\ %%
 ===== Images =====
 Best inserted using the image button. If you want to have a label with an image description below the image, use the imagebox plugin:
 Just add [ ] around the image tag.
-<code>[{{ImagePath|Caption}}]</code>
+<code>
+[{{ImagePath|Caption}}]
+</code>
 The caption can be formatted. Here is an example:
+<code>
+[{{ :pasted:20200801-124136.png?nolink | This is the caption }}]
+</code>
-<code>[{{ :pasted:20200801-124136.png?nolink | This is the caption }}]</code>
 [{{ :pasted:20200801-124136.png | This is the caption }}]
-\\
+<code>
-=== copy and paste ===
+\\  ==== copy and paste ====
+</code>
 If you want to be quick, e.g. with screenshots, you can paste them (you cannot paste a file from the clipboard! You can only paste imagedata that is on the clipboard): put your cursor in the text box where you want to insert the image and press ctrl+p or whatever the equivalent on a Mac is.
@@ Line 76: / Line 93: @@
 ===== Links =====
-  * **simple link to a page:** %%[[name of the wiki page|optional text for the link]]%% \\
+  * **simple link to a page:**  <nowiki>[[name of the wiki page|optional text for the link]]</nowiki>
-  * **link to a section within the same page:** %%[[#name of the section|optional text for the link]]%% \\
+  * **link to a section within the same page:**  <nowiki>[[#name of the section|optional text for the link]]</nowiki>
-  * **link to a section of a different wiki page:** %%[[name of the wiki page#name of the section|optional text for the link]]%% \\
+  * **link to a section of a different wiki page:**  <nowiki>[[name of the wiki page#name of the section|optional text for the link]]</nowiki>
-  * **link to the www:** %%[[url|optional text for the link]]%% \\
+  * **link to the www:**  <nowiki>[[url|optional text for the link]]</nowiki> i_tip_icon use the button with the chain and the globe to select and insert a link using a helpful dialog.
-i_tip_icon use the button with the chain and the globe to select and insert a link using a helpful dialog.
 ===== Tag =====
+<code>
-  {{tag>[list of tags]}}
+{{tag>[list of tags]}}
-^ [list of tags] | a space separated list of tags that describe the content of the current page | required |
+</code>
+^[list of tags]|a space separated list of tags that describe the content of the current page|required|
 Examples:
-  * ''%%{{tag>tag1 tag2 tag3}}%%''
-  * with namespaces: ''%%{{tag>ns1:tag1 ns1:tag2 ns2:subns1:tag3}}%%''
-==== Topic ====
+  * ''<nowiki>{{tag>tag1 tag2 tag3}}</nowiki>''
+  * with namespaces: ''<nowiki>{{tag>ns1:tag1 ns1:tag2 ns2:subns1:tag3}}</nowiki>''
-  {{topic>[tag]&[flags]}}
-^ [tag] | the category tag for which you want a list of pages | required |
-^ [flags] | pagelist flags delimited by ''&'', see [[pagelist#flags]] | optional |
-Example:
-  * ''%%{{topic>tag1 -tag2}}%%'' -- Lists all pages tagged with tag1 but not with tag2.
-  * ''%%{{topic>tag1 +tag2}}%%'' -- Lists all pages tagged with tag1 and tag2.
-  * ''%%{{topic>tag1 tag2}}%%'' -- Lists all pages tagged with either tag1 or tag2 or both.
-  * ''%%{{topic>ns1?tag1 tag2}}%%'' -- List all pages inside namespace ns1 tagged with either tag1 or tag2
-  * ''%%{{topic>.?tag1 tag2}}%%'' -- List all pages inside the current namespace tagged with either tag1 or tag2
-  * ''%%{{topic>tag1 tag2 tag3&nodate&desc&sort}}%%'' (Adding [[:plugin:pagelist|pagelist]] options to change the design)
 ==== Count ====
+<code>
-  {{count>[tag]}}
+{{count>[tag]}}
+</code>
-^ [tag] | the category tag for which you want the list the occurrence | required |
+^[tag]|the category tag for which you want the list the occurrence|required|
 Example:
-  * ''%%{{count>+}}%%'' -- List all tags with related occurrences.
-  * ''%%{{count>tag1 tag2}}%%'' -- List the occurrence of tag1 and tag2.
-  * ''%%{{count>tag1 tag2 tag3&. ns1 ns2}}%%'' -- List all occurrences for the given tags inside the namespaces (the dot specifies the root namespace)
+  * ''<nowiki>{{count>+}}</nowiki>''  – List all tags with related occurrences.
+  * ''<nowiki>{{count>tag1 tag2}}</nowiki>''  – List the occurrence of tag1 and tag2.
+  * ''<nowiki>{{count>tag1 tag2 tag3&. ns1 ns2}}</nowiki>''  – List all occurrences for the given tags inside the namespaces (the dot specifies the root namespace)
 ===== Stichwörter =====
 <code>
 {{keywords>art in the park,Sheffield,urban,street,creative}}
 </code>
-===== Ändern einer Seite ======
+===== Ändern einer Seite =====
-Einfach "Bearbeiten/Seite bearbeiten" oder so ähnlich im Menü verwenden oder - je nach Wiki - auf der rechten Seite den Bearbeiten Schalter anklicken.
-Was immer geht: **Shift+Alt+e** (manchmal auch Strg+Alt+e, kommmt auf den Browser an)
-Die geänderte Seite wird gespeichert durch **Strg+Alt+s**, oder den Speichern Schalter.
-===== Anlegen einer neuen Seite ======
+Einfach "Bearbeiten/Seite bearbeiten" oder so ähnlich im Menü verwenden oder - je nach Wiki - auf der rechten Seite den Bearbeiten Schalter anklicken. Was immer geht: **Shift+Alt+e**  (manchmal auch Strg+Alt+e, kommmt auf den Browser an) Die geänderte Seite wird gespeichert durch **Strg+Alt+s**, oder den Speichern Schalter.
-  - Um eine neue Seite anzulegen, wird zunächst in einer bestehenden Seite ein Verweis darauf angelegt mit %%[[%%//Name der neuen Seite//%%]]%%. Diese Seite speichern.
+===== Anlegen einer neuen Seite =====
+  - Um eine neue Seite anzulegen, wird zunächst in einer bestehenden Seite ein Verweis darauf angelegt mit <nowiki>[[</nowiki>//Name der neuen Seite//<nowiki>|]]</nowiki>. Diese Seite speichern.
   - Dann auf den neuen Link klicken. Auf der Zielseite, die als nicht existent angegeben wird, einfach wie üblich Seite editieren (siehe oben) wählen.
-===== Nützliches für den Editiermodus ======
+===== Nützliches für den Editiermodus =====
-  * **Keine Umbrüche verwenden**: Möglichst keine Umbrüche mit Enter erzeugen. Die Wiki soll das selbst regeln. Nur wenn wirklich ein Umbruch explizit gewünscht ist, kann er mit zwei Mal Enter forciert werden. \\ Zwei Backslashs eingeleitet und gefolgt von einem Leerzeichen haben ebenfalls einen Umbruch zur Folge.
+  * **Keine Umbrüche verwenden**: Möglichst keine Umbrüche mit Enter erzeugen. Die Wiki soll das selbst regeln. Nur wenn wirklich ein Umbruch explizit gewünscht ist, kann er mit zwei Mal Enter forciert werden. Zwei Backslashs eingeleitet und gefolgt von einem Leerzeichen haben ebenfalls einen Umbruch zur Folge.
-  * **<nowiki>** Text **</nowiki>** : Text innerhalb eines Paares doppelter Sternchen wird fett formatiert
+  * **<nowiki>** Text **</nowiki>**  : Text innerhalb eines Paares doppelter Sternchen wird fett formatiert
   * Zwei Leerzeichen und ein * erzeugen einen unnummerierten Listenpunkt
   * Zwei Leerzeichen und ein - erzeigen einen nummerierten Listenpunkt
-  * **<nowiki>%% Text %%</nowiki>** : Alles innerhalb eines Paars doppelter Prozentzeichen wird von der Wiki nicht interpretiert.<nowiki>%%[[Test]]%%</nowiki> ergibt in der Ausgabe %%[[Test]]%%. Das gleiche kann man mit %%<nowiki>%% und %%</nowiki>%% erreichen.
+  * **<nowiki>%% Text %%</nowiki>**  : Alles innerhalb eines Paars doppelter Prozentzeichen wird von der Wiki nicht interpretiert.<nowiki>%%[[Test|]]%%</nowiki> ergibt in der Ausgabe <nowiki>[[Test|]]</nowiki>. Das gleiche kann man mit %%<nowiki>%% und <nowiki></nowiki></nowiki> erreichen.
   * Überschriften lassen sich am Besten mit den Schaltern erzeugen
-  * **Links zu einer anderen Wiki-Seite** Auch dafür eignet sich ein Schalter am Besten: Die Kettenglieder ohne Weltkugel
+  * **Links zu einer anderen Wiki-Seite**  Auch dafür eignet sich ein Schalter am Besten: Die Kettenglieder ohne Weltkugel
   * **Links ins WWWW*** Dazu eignet sich der Schalter mit den Kettengliedern und der Weltkugel
 ==== Code ====
 Syntax Highlighting
-DokuWiki can highlight sourcecode, which makes it easier to read. It uses the GeSHi Generic Syntax Highlighter – so any language supported by GeSHi is supported. The syntax uses the same code and file blocks described in the previous section, but this time the name of the language syntax to be highlighted is included inside the tag, e.g. %%<code java> or <file java>%%.
+DokuWiki can highlight sourcecode, which makes it easier to read. It uses the GeSHi Generic Syntax Highlighter – so any language supported by GeSHi is supported. The syntax uses the same code and file blocks described in the previous section, but this time the name of the language syntax to be highlighted is included inside the tag, \\
+e.g. <nowiki><code java> or <file java></nowiki>.
+=== sxh syntax highlighter ===
+Another option is:
+<code>
+<sxh [brush][; options]>
+... code/text ...
+</sxh>
+</code>
+and the brushes are here: [[https://github.com/crazy-max/dokuwiki-plugin-syntaxhighlighter4]].
+Most importantly it does support powershell and typescript. And it does look a bit more appealing, I think.
+==== icons and labels ====
+The smiley button in the editor shows a selection of icons. But you can also just type the label's name into the editor. Some labels should be used only for a certain purpose (we search for them):
+^ command ^ looks like ^ meaning ^
+| %%i_todo_icon%% |i_todo_icon |Something needs to be done. |
+| %%i_depr%% |i_depr | Correct information for a current version but a change is planned in the future.  |
 ==== folding ====
+we have two section toggle plugins installed:
+the first one corresponds with the "fold/unfold all" button in the menu:
 <code>
 ++++ Title |
@@ Line 161: / Line 189: @@
 ++++
 </code>
+The second one does not, but is a bit more obviously styled:
+<code>
+<hidden my title>
+content to be folded /unfolded.
+</hidden>
+</code>
+===== discussions =====
+just add:
+<code>
+~~DISCUSSION~~
+</code>
+~~DISCUSSION~~
+==== how to add your own avatar ====
+that's a bit tricky. Go here: [[:user:user-namespace|user]].