meta data for this page
  •  

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
wiki:advanced_user_hints [21 February 2015 04:03] – linkfix knaak@iqo.uni-hannover.dewiki:advanced_user_hints [26 April 2022 15:03] (current) – [Excel style calculations] more explicit knaak@iqo.uni-hannover.de
Line 1: Line 1:
-====== Advanced editor hints ====== +====== Advanced features of the AP Wiki ====== 
-This page mostly deals with issues specific to the IQwiki. For general help on dokuwiki see the [[wiki:syntax|local dokuwiki syntax help]] and/or the [[doku>manual|official manual]].+This page mostly deals with issues specific to the APwiki. For general help on dokuwiki see the [[wiki:syntax|local dokuwiki syntax help]] and/or the [[doku>manual|official manual]].
  
 ===== How to add a page ===== ===== How to add a page =====
Line 11: Line 11:
   : Add a wiki link on an existing page, save, click on the red link, click on the topmost button on the far right of the dokuwiki window ("create page"). This enters the dokuwiki text editor.   : Add a wiki link on an existing page, save, click on the red link, click on the topmost button on the far right of the dokuwiki window ("create page"). This enters the dokuwiki text editor.
   ? offline:   ? offline:
-  : Write the page offline with a text editor. Ask [[wiki:ap-admins|an admin]] to copy the file to the appropriate place in the tree of dokuwiki pages. +  : Write the page offline with a text editor. Ask [[apwiki-admins|an admin]] to copy the file to the appropriate place in the tree of dokuwiki pages. 
      
 ===== How to move a page ===== ===== How to move a page =====
Line 18: Line 18:
 The easiest way to move a single page is to start a new page, copy-paste the contents and delete the original. A side effect is the loss of the archive of versions. The easiest way to move a single page is to start a new page, copy-paste the contents and delete the original. A side effect is the loss of the archive of versions.
  
-Copy-paste quickly becomes excessively tedious if you intend to move a whole hierarchy of pages. The [[doku>plugin:move|move plugin]] was written to deal with mass moves gracefully. However, this plugin needs special permissions as it must access protected areas of the dokuwiki data set. Kindly ask an [[wiki:ap-admins|APwiki admin]] to execute the move.+Copy-paste quickly becomes excessively tedious if you intend to move a whole hierarchy of pages. The [[doku>plugin:move|move plugin]] was written to deal with mass moves gracefully. However, this plugin needs special permissions as it must access protected areas of the dokuwiki data set. Kindly ask an [[apwiki-admins|APwiki admin]] to execute the move.
  
 ===== How to delete a page ===== ===== How to delete a page =====
-The standard way to delete a page is to enter the dokuwiki editor, remove all content and save. Empty folders are automatically removed by dokuwiki. If there are many pages to remove, you can ask [[wiki:ap-admins|an admin]] to delete them directly in the file system of the server.\\+The standard way to delete a page is to enter the dokuwiki editor, remove all content and save. Empty folders are automatically removed by dokuwiki. If there are many pages to remove, you can ask [[apwiki-admins|an admin]] to delete them directly in the file system of the server.\\
 Page removal is permanent and includes all previous versions of the page. It may be possible to recover pages from global back-ups of the server at RRZN. This is a tedious process, though, which is not guaranteed to succeed. Page removal is permanent and includes all previous versions of the page. It may be possible to recover pages from global back-ups of the server at RRZN. This is a tedious process, though, which is not guaranteed to succeed.
  
Line 61: Line 61:
  
 ==== Excel style calculations ==== ==== Excel style calculations ====
-The plugin [[doku>plugin:tablecalc|tablecalc]] adds the ability to do excel style calculations. There is a number of math functions. One of the most useful is ''sum(range)''. Check the table below for a simple example. The [[doku>plugin:tablecalc|manual of the plugin]] shows how more complex stuff can be done.+The plugin [[doku>plugin:tablecalc|tablecalc]] adds the ability to do excel style calculations. There is a number of math functions. One of the most useful is ''sum(range)''. Check the table below for a simple example. The [[doku>plugin:tablecalc|manual of the tablecalc plugin]] shows how to do more complex stuff.
  
 ==== In-place-editing of tables ==== ==== In-place-editing of tables ====
Line 71: Line 71:
  
 ==== Coloured table cells ==== ==== Coloured table cells ====
-You can paint the cells of a table by preceding the entry with ''@FOOBAR:''. Replace "FOOBAR" with your favourite colour. You choose from every colour known to HTML. This includes numerical [[http://html-color-codes.info/|RGB-codes]]. +You can paint the cells of a table by preceding the entry with ''@FOOBAR:''. Replace "FOOBAR" with your favourite colour. You can choose from every colour known to HTML. This includes numerical [[http://html-color-codes.info/|RGB-codes]]. 
 ^ one   ^ two              ^ ^ one   ^ two              ^
 | three  | four and a half  | | three  | four and a half  |
Line 77: Line 77:
 | @lightgreen:seven | 25 | | @lightgreen:seven | 25 |
 |  sum:| ~~=sum(range(1,2,col(),row()-1))~~ €| |  sum:| ~~=sum(range(1,2,col(),row()-1))~~ €|
 +
 +==== Colored code ====
 +The [[doku>plugin:syntaxhighlighter4|syntaxhighlighter4]] plugin can render your code in a colorful way. It understands many common languages like python, c++, java and perl. LaTeX is supported, too. Basic usage is:
 +<code><sxh LANG> CODE </sxh></code>
 +LANG is the language of your code. Hello world example:
 +<sxh cpp>
 +#include <stdio.h>
 +int main()
 +{
 +   printf("Hello, World!");
 +   return 0;
 +}
 +</sxh>
 +For advanced options see [[https://github.com/crazy-max/dokuwiki-plugin-syntaxhighlighter4#syntax-and-usage|the github docs of the plugin]].
 +
 +Over the years, the regular code environment acquired highlighting ambitions, too:
 +<code cpp [enable_line_numbers="true",highlight_lines_extra="2"]>
 +#include <stdio.h>
 +int main()
 +{
 +   printf("Hello, World!");
 +   return 0;
 +}
 +</code>
  
 ===== List of files in a folder ===== ===== List of files in a folder =====
-You can use the [[doku>plugins:filelist|filelist]] plugin to list files in a folder of the media section of IQwiki. Use the wildcards ''*'' and ''?'' to specify which names to show. Specifically, [[http://unixhelp.ed.ac.uk/CGI/man-cgi?glob+7|unix style globbing]] is used for the selection. +You can use the [[doku>plugins:filelist|filelist]] plugin to list files in a folder of the media section of APwiki. Use the wildcards ''*'' and ''?'' to specify which names to show. Specifically, [[http://unixhelp.ed.ac.uk/CGI/man-cgi?glob+7|unix style globbing]] is used for the selection. 
  
 There is a host of options to modify the search and tweak the output. See the [[http://www.foosel.org/snippets/dokuwiki/filelist#usage|manual of the plugin]] for details. The plugin has been configured to give the size by default. The comand to list all PNG files that start with "d" in the example_images folder would be: There is a host of options to modify the search and tweak the output. See the [[http://www.foosel.org/snippets/dokuwiki/filelist#usage|manual of the plugin]] for details. The plugin has been configured to give the size by default. The comand to list all PNG files that start with "d" in the example_images folder would be:
Line 85: Line 109:
 {{filelist>.:example_images:d*.png}} {{filelist>.:example_images:d*.png}}
  
-===== Images an movies =====+===== Images and movies ===== 
 +==== Acceptable image formats ==== 
 +  ? [[wp>JPG|JPG]]  
 +  : is the most abundant compressed image format on the www. Its ability to achieve arbitrary compression comes at a price: at some point image quality deteriorates significantly. JPG is great for photos. Not so great for graphics with sharp edges. 
 +  ? [[wp>PNG|PNG]] 
 +  : is an image format with lossless compression. It is particularily efficient for computer generated graphics with large areas of plain color. PNG is generally good for computer generated graphics and logos -- less so for photos 
 +  ? [[wp>SVG|SVG]] 
 +  :  is a vector image format developed for web pages, which is sanctioned by the [[wp>WWWC|WWWC]]. Vector images scale losslessly. A circle will keep its nice smooth boundry no matter the zoom scale. Because of this, SVG is particularily useful for detailed graphs and schematics. This format puts more demands on the local browser. Because of this, it took some time to be universally adopted. Since 2011, all major WWW browsers can deal with static SVG. The last to join the club was Microsoft with IE9. 
 + 
 ==== Show all images in a folder ==== ==== Show all images in a folder ====
 The [[http://www.dokuwiki.org/plugin:gallery|gallery plugin]] shows a gallery of all images in a folder. The plugin understands quite a bunch of options. A useful choice is "lightbox" combined with "showname" The [[http://www.dokuwiki.org/plugin:gallery|gallery plugin]] shows a gallery of all images in a folder. The plugin understands quite a bunch of options. A useful choice is "lightbox" combined with "showname"
Line 115: Line 148:
 <code>{{ VideoURL | DokuwikiPathToVideo? WIDTHxHEIGHT & PathToPreviewImage | AlternateText}}</code> <code>{{ VideoURL | DokuwikiPathToVideo? WIDTHxHEIGHT & PathToPreviewImage | AlternateText}}</code>
  
-Example: +Example with default width and height: 
-<code>{{ http://bibo.iqo.uni-hannover.de/qtiplotvideo.mp4 ? & :wiki:playground:qtiplot_screenshot.jpg |}}</code> +<code>{{ :qti_faq:scatterplotundbeschriftung_kl.mp4? & :wiki:playground:qtiplot_screenshot.jpg |}}</code> 
-{{ http://bibo.iqo.uni-hannover.de/qtiplotvideo.mp4? & :wiki:playground:qtiplot_screenshot.jpg |}}+{{ :qti_faq:scatterplotundbeschriftung_kl.mp4? & :wiki:playground:qtiplot_screenshot.jpg |}}
  
  
Line 142: Line 175:
  
 ==== Colors, containers, columns and Co. ==== ==== Colors, containers, columns and Co. ====
-The [[http://www.dokuwiki.org/plugin:wrap|wrap plugin]] can do similars trick as the note plugin. But it also provides a ton of additional formatting options -- indent, outdent, highlight, highlight even more, multi columns, floating boxes. In general, formatting should be done by CSS sheets. But for a one-off a ''<wrap>'' may the appropriate tool.+The [[http://www.dokuwiki.org/plugin:wrap|wrap plugin]] can do similars tricks as the note plugin. But it also provides a ton of additional formatting options -- indent, outdent, highlight, highlight even more, multi columns, floating boxes. As a general rule, formatting should be done by CSS sheets. But for a one-off a ''<wrap>'' may the appropriate tool.
  
 The wrap can make portions of the page print but not show up on screen or the other way round. The wrap can make portions of the page print but not show up on screen or the other way round.
Line 171: Line 204:
   * ''<nowiki>:OK:</nowiki>'' transforms into :OK:   * ''<nowiki>:OK:</nowiki>'' transforms into :OK:
   * ''<nowiki>:no:</nowiki>'' transforms into :no:   * ''<nowiki>:no:</nowiki>'' transforms into :no:
 +
 +Admin advice: To add more local icons, you'd have to edit ''conf/smileys.local.conf'' and add an image in the folder ''lib/images/smileys/local/''.
 +==== A key to keys ====
 +The [[doku>plugin:keyboard|keyboard plugin]] provides a nifty way to communicate key presses. Most characters render as an icon of the corresponding key. But there is some magic going on. The plus ("+") and minus ("-") characters are interpreted as dividers for complex key sequences. In addition a capital A or C are rendered as the Alt- or Ctrl-key. Enclose characters in <nowiki>'</nowiki> to suppress the magic.
 +  * ''<nowiki><kbd>F1</kbd></nowiki>'' is rendered as <kbd>F1</kbd>
 +  * ''<nowiki><kbd>A</kbd></nowiki>'' is rendered as <kbd>A</kbd>
 +  * ''<nowiki><kbd>A+'A'</kbd></nowiki>'' is rendered as <kbd>A+'A'</kbd>
 +  * ''<nowiki><kbd>A+C+e</kbd></nowiki>'' is rendered as <kbd>A+C+e</kbd>
  
  
Line 213: Line 254:
  
 ===== Discussions ===== ===== Discussions =====
-The [[doku>discussion]] plugin provides a way to talk about the contents of a page.+The [[doku>plugin:discussion|discussion plugin]] provides a way to talk about the contents of a page.
 Put the string ''~~DISCUSSION~~'' on a page to add a discussion section. Put the string ''~~DISCUSSION~~'' on a page to add a discussion section.
  
Line 225: Line 266:
 ==== menu entry != top header ==== ==== menu entry != top header ====
 Usually, the top heading of a page provides a decent entry for the index menu. But sometimes this is not quite ideal. E.g., the top header may be longer than desirable in the index. Unfortunately, there is no option to override index menu options for a specific page. However, there is a way to cheat: Use raw HTML for the top heading: ''<html><H1>Foobar</h1></html>''.  This will render in the header style given by the current CSS. But it won't get recognized by the dokuwiki engine. Consequently, the index menu ignores it and shows the next heading instead. Usually, the top heading of a page provides a decent entry for the index menu. But sometimes this is not quite ideal. E.g., the top header may be longer than desirable in the index. Unfortunately, there is no option to override index menu options for a specific page. However, there is a way to cheat: Use raw HTML for the top heading: ''<html><H1>Foobar</h1></html>''.  This will render in the header style given by the current CSS. But it won't get recognized by the dokuwiki engine. Consequently, the index menu ignores it and shows the next heading instead.
- 
-==== Local index menu ==== 
-If you would rather not have the complete index of the IQwiki displayed to the right of your pages, your name space can be configured to use something slightly, or even entirely different. Consult one of the [[wiki:ap-admins|apwiki-admins]] to discuss the details and make it happen.  
  
 ==== Update the index ==== ==== Update the index ====
Line 245: Line 283:
 Dokuwiki provides several fairly sophisticated ways to presents events, incidents and time frames. You can use them for plannning and/or logging. Dokuwiki provides several fairly sophisticated ways to presents events, incidents and time frames. You can use them for plannning and/or logging.
  
-==== Lab notebook / diary ==== +==== Diary ==== 
-The plugin [[doku>plugin:yearbox]] creates a calendar, with a new page link for each day. This can be used to establish a (collaborative) lab notebook organized by date. To make this an official lab notebook, its pages may need to be locked when the corresponding day has passed. The yearbox does not provide this by default. But you can ask one of our [[it:iqo-admins|computer admins]] for a fix. +The plugin [[doku>plugin:yearbox]] creates a calendar, with a new page link for each day. This can be used to establish a (collaborative) notebook organized by date.
 ==== Events on a timeline ==== ==== Events on a timeline ====
 The [[doku>plugin:eventline|eventline]] plugin  provides a nice way to visualize overlapping stages and mile stones of a project. Technically, it takes the open sourced timeline widget developed at MIT as part of the Simile project and wraps it in a dokuwiki layer. For an example of a full fledged demonstration, see the [[http://simile-widgets.org/timeline/|Kennedy assasination timeline at MIT]]. Note the comment bubbles which can be accessed by mouse clicks on an event. The [[doku>plugin:eventline|eventline]] plugin  provides a nice way to visualize overlapping stages and mile stones of a project. Technically, it takes the open sourced timeline widget developed at MIT as part of the Simile project and wraps it in a dokuwiki layer. For an example of a full fledged demonstration, see the [[http://simile-widgets.org/timeline/|Kennedy assasination timeline at MIT]]. Note the comment bubbles which can be accessed by mouse clicks on an event.
Line 270: Line 307:
  
 ===== Zombies, orphans and dead links ===== ===== Zombies, orphans and dead links =====
-The page [[wikiadmin:orphans_and_dead_links]] lists all dangling dead links in IQwiki. It also gives an overview on pages that are not linked to anywhere ("orphans"). Use these lists for maintainance. You can create your own maintainance page. The syntax of the [[doku>plugin:orphanswanted|orphanswanted]] plugin and the [[doku>plugin:orphanmedia|orphanmedia]] plugin allows you to restrict the lists to certain subspaces of the IQwiki.+The page [[wiki:wartungsseiten:orphans_and_dead_links]] lists all dangling dead links in APwiki. It also gives an overview on pages that are not linked to anywhere ("orphans"). Use these lists for maintainance. You can create your own maintainance page. The syntax of the [[doku>plugin:orphanswanted|orphanswanted]] plugin and the [[doku>plugin:orphanmedia|orphanmedia]] plugin allows you to restrict the lists to certain subspaces of the APwiki.
  
-If you feel like garbage is collecting in the upload area, you can ask an admin to scan for files that are not used anywhere in the IQwiki ("zombies"). +If you feel like garbage is collecting in the upload area, you can ask an [[apwiki-admins|apwiki-admin]] to scan for files that are not used anywhere in the APwiki ("zombies"). 
  
-{{tag>help IQwiki}} +{{tag>help APwiki}} 
-{{indexmenu_n>3}}+{{indexmenu_n>4}}  /* sort this page after basic features */