User Tools

Site Tools


links:syntax

Differences

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

Link to this comparison view

Next revision
Previous revision
links:syntax [2024/08/03 08:51] – created - external edit 127.0.0.1links:syntax [2025/07/30 18:48] (current) – [News Item] va7fi
Line 1: Line 1:
 ====== Editing Mode ====== ====== Editing Mode ======
-{{  howto:edit1.png}}+{{  links:edit1.png}}
   * In order to edit this site, you must first ''Log In'' (top right corner).   * In order to edit this site, you must first ''Log In'' (top right corner).
   * After that, the "pen icon" will appear on the right, which allows you to edit the entire page.   * After that, the "pen icon" will appear on the right, which allows you to edit the entire page.
   * Alternatively, each section will have an <key>Edit</key> button that allows you to edit only that section.   * Alternatively, each section will have an <key>Edit</key> button that allows you to edit only that section.
-\\ + 
-\\ +
-\\+
  
 ====== News Item ====== ====== News Item ======
 To post a news item: To post a news item:
   - Make sure you are logged in.   - Make sure you are logged in.
-  - Click on the ''Create a News Item'' button on the front page\\ {{howto:newsfeed.png}} +  - Click on the ''Create a News Item'' link on the front page, which will show the following instruction:  \\ {{links:newsfeed.png}} 
-  - Enter a **short** title+  - Once you have entered your short title in the box, and clicked on <key>Create this page</key>, a new page will open with your title at the top.  You'll want to insert a line above it and type ''~~NOTOC~~'' at the very top to suppress the automatic Tables Of Contents
-  - Write the article below the title (make sure you leave the title between the 6 equal signs as is). +  - For more details on the syntax you can use, see the rest of this page.
-  - Before you save, select the "default" Blog option+
-  - Write the year and month (first three letters) in the tags field. +
- +
-Here's a short video demonstration: +
- +
-{{ youtube>hbU6BHIUUM8 }}+
  
 +To see the full list of articles, click on the ''See the full News Feed'' link.
  
 +Here's a (not-so brief) tutorial on how to add a news item with various formatting tricks:
 +{{ youtube>AR6cyoyViBw? }}
 +You can see the [[/blog/2025-07-30/news_item_example |News Item Example]] and click on the edit button to see the code behind it.
 ====== Formatting Syntax ====== ====== Formatting Syntax ======
  
-[[doku>DokuWiki]] supports some simple markup language, which tries to make the datafiles to be as readable as possible. This page contains all possible syntax you may use when editing the pages. Simply have a look at the source of this page by pressing "Edit this page". If you want to try something, just use the [[howto:playground|playground]] page. The simpler markup is easily accessible via [[doku>toolbar|quickbuttons]], too.+[[doku>DokuWiki]] supports some simple markup language, which tries to make the datafiles to be as readable as possible. This page contains all possible syntax you may use when editing the pages. Simply have a look at the source of this page by pressing "Edit this page". If you want to try something, just use the [[links:playground|playground]] page. The simpler markup is easily accessible via [[doku>toolbar|quickbuttons]], too.
  
 ===== Basic Text Formatting ===== ===== Basic Text Formatting =====
Line 122: Line 119:
   [[https://php.net|{{wiki:dokuwiki-128.png}}]]   [[https://php.net|{{wiki:dokuwiki-128.png}}]]
  
-[[https://php.net|{{howto:dokuwiki-128.png}}]]+[[https://php.net|{{links:dokuwiki-128.png}}]]
  
 Please note: The image formatting is the only formatting syntax accepted in link names. Please note: The image formatting is the only formatting syntax accepted in link names.
Line 154: Line 151:
 You can include external and internal [[doku>images|images, videos and audio files]] with curly brackets. Optionally you can specify the size of them. You can include external and internal [[doku>images|images, videos and audio files]] with curly brackets. Optionally you can specify the size of them.
  
-Real size:                        {{howto:dokuwiki-128.png}}+Real size:                        {{links:dokuwiki-128.png}}
  
-Resize to given width:            {{howto:dokuwiki-128.png?50}}+Resize to given width:            {{links:dokuwiki-128.png?50}}
  
-Resize to given width and height((when the aspect ratio of the given width and height doesn't match that of the image, it will be cropped to the new ratio before resizing)): {{howto:dokuwiki-128.png?200x50}}+Resize to given width and height((when the aspect ratio of the given width and height doesn't match that of the image, it will be cropped to the new ratio before resizing)): {{links:dokuwiki-128.png?200x50}}
  
 Resized external image:           {{https://php.net/images/php.gif?200x50}} Resized external image:           {{https://php.net/images/php.gif?200x50}}
Line 170: Line 167:
 By using left or right whitespaces you can choose the alignment. By using left or right whitespaces you can choose the alignment.
  
-{{ howto:dokuwiki-128.png}}+{{ links:dokuwiki-128.png}}
  
-{{howto:dokuwiki-128.png }}+{{links:dokuwiki-128.png }}
  
-{{ howto:dokuwiki-128.png }}+{{ links:dokuwiki-128.png }}
  
   {{ wiki:dokuwiki-128.png}}   {{ wiki:dokuwiki-128.png}}
Line 182: Line 179:
 Of course, you can add a title (displayed as a tooltip by most browsers), too. Of course, you can add a title (displayed as a tooltip by most browsers), too.
  
-{{ howto:dokuwiki-128.png |This is the caption}}+{{ links:dokuwiki-128.png |This is the caption}}
  
   {{ wiki:dokuwiki-128.png |This is the caption}}   {{ wiki:dokuwiki-128.png |This is the caption}}
Line 203: Line 200:
   {{wiki:dokuwiki-128.png?linkonly}}   {{wiki:dokuwiki-128.png?linkonly}}
  
-{{howto:dokuwiki-128.png?linkonly}} This is just a link to the image.+{{links:dokuwiki-128.png?linkonly}} This is just a link to the image.
  
 ==== Fallback Formats ==== ==== Fallback Formats ====
Line 278: Line 275:
 ==== Text to HTML Conversions ==== ==== Text to HTML Conversions ====
  
-Typography: [[wiki:dokuwiki]] can convert simple text characters to their typographically correct entities. Here is an example of recognized characters.+Typography: DokuWiki can convert simple text characters to their typographically correct entities. Here is an example of recognized characters.
  
 -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
Line 426: Line 423:
 ==== Syntax Highlighting ==== ==== Syntax Highlighting ====
  
-[[wiki:DokuWiki]] can highlight sourcecode, which makes it easier to read. It uses the [[https://qbnz.com/highlighter/|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></nowiki>'' or ''<nowiki><file java></nowiki>''.+DokuWiki can highlight sourcecode, which makes it easier to read. It uses the [[https://qbnz.com/highlighter/|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></nowiki>'' or ''<nowiki><file java></nowiki>''.
  
 <code java> <code java>
Line 490: Line 487:
  
 ===== RSS/ATOM Feed Aggregation ===== ===== RSS/ATOM Feed Aggregation =====
-[[wiki:dokuwiki]] can integrate data from external XML feeds. For parsing the XML feeds, [[https://simplepie.org/|SimplePie]] is used. All formats understood by SimplePie can be used in DokuWiki as well. You can influence the rendering by multiple additional space separated parameters:+DokuWiki can integrate data from external XML feeds. For parsing the XML feeds, [[https://simplepie.org/|SimplePie]] is used. All formats understood by SimplePie can be used in DokuWiki as well. You can influence the rendering by multiple additional space separated parameters:
  
 ^ Parameter  ^ Description ^ ^ Parameter  ^ Description ^
Line 501: Line 498:
 | //n//[dhm] | refresh period, where d=days, h=hours, m=minutes. (e.g. 12h = 12 hours). | | //n//[dhm] | refresh period, where d=days, h=hours, m=minutes. (e.g. 12h = 12 hours). |
  
-The refresh period defaults to 4 hours. Any value below 10 minutes will be treated as 10 minutes. [[wiki:DokuWiki]] will generally try to supply a cached version of a page, obviously this is inappropriate when the page contains dynamic external content. The parameter tells [[wiki:DokuWiki]] to re-render the page if it is more than //refresh period// since the page was last rendered.+The refresh period defaults to 4 hours. Any value below 10 minutes will be treated as 10 minutes. DokuWiki will generally try to supply a cached version of a page, obviously this is inappropriate when the page contains dynamic external content. The parameter tells DokuWiki to re-render the page if it is more than //refresh period// since the page was last rendered.
  
 By default the feed will be sorted by date, newest items first. You can sort it by oldest first using the ''reverse'' parameter, or display the feed as is with ''nosort''. By default the feed will be sorted by date, newest items first. You can sort it by oldest first using the ''reverse'' parameter, or display the feed as is with ''nosort''.
links/syntax.1722700307.txt.gz · Last modified: by 127.0.0.1