Xavier Guimard
15 years ago
parent
afa66cd047
commit
cdf4ea033a
@ -0,0 +1,84 @@ |
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" |
||||
lang="en" dir="ltr"> |
||||
|
||||
<head> |
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title></title> |
||||
<!-- metadata --> |
||||
<meta name="generator" content="Offline" /> |
||||
<meta name="version" content="Offline 0.1" /> |
||||
<!-- style sheet links --> |
||||
<link rel="stylesheet" media="all" type="text/css" href="../../../css/all.css" /> |
||||
<link rel="stylesheet" media="screen" type="text/css" href="../../../css/screen.css" /> |
||||
<link rel="stylesheet" media="print" type="text/css" href="../../../css/print.css" /> |
||||
|
||||
</head> |
||||
<body> |
||||
<div class="dokuwiki export"> |
||||
|
||||
|
||||
|
||||
|
||||
<h1><a name="ldap_configuration_backend" id="ldap_configuration_backend">LDAP configuration backend</a></h1> |
||||
<div class="level1"> |
||||
|
||||
</div> |
||||
<!-- SECTION "LDAP configuration backend" [1-43] --> |
||||
<h2><a name="presentation" id="presentation">Presentation</a></h2> |
||||
<div class="level2"> |
||||
|
||||
<p> |
||||
|
||||
You can choose to store LemonLDAP::NG configuration in an <acronym title="Lightweight Directory Access Protocol">LDAP</acronym> directory. |
||||
</p> |
||||
|
||||
<p> |
||||
Advantages: |
||||
</p> |
||||
<ul> |
||||
<li class="level1"><div class="li"> Easy to share between servers with remote <acronym title="Lightweight Directory Access Protocol">LDAP</acronym> access</div> |
||||
</li> |
||||
<li class="level1"><div class="li"> Easy to duplicate with <acronym title="Lightweight Directory Access Protocol">LDAP</acronym> synchronization services (like SyncRepl in OpenLDAP)</div> |
||||
</li> |
||||
<li class="level1"><div class="li"> Security with <acronym title="Secure Sockets Layer">SSL</acronym>/TLS</div> |
||||
</li> |
||||
<li class="level1"><div class="li"> Access control possible by creating one user for Manager (write) and another for portal and handlers (read)</div> |
||||
</li> |
||||
<li class="level1"><div class="li"> Easy import/export through LDIF files</div> |
||||
</li> |
||||
</ul> |
||||
|
||||
<p> |
||||
|
||||
The configuration will be store under a specific branch, for example <code>ou=conf,ou=applications,dc=example,dc=com</code>. |
||||
</p> |
||||
|
||||
<p> |
||||
Each configuration will be represented as an entry, which structural objectClass is <code>applicationProcess</code>. This objectClass is included in every core schemas. |
||||
</p> |
||||
|
||||
<p> |
||||
The configuration name is the same that files, so lmConf-1, lmConf-2, etc. This name is used in entry <acronym title="Distinguished Name">DN</acronym>, for example <code>cn=lmConf-1,ou=conf,ou=applications,dc=example,dc=com</code>. |
||||
</p> |
||||
|
||||
<p> |
||||
Then each parameter is one value of the attribute <code>description</code>, prefixed by its key. For example <code>{ldapPort}389</code>. |
||||
</p> |
||||
|
||||
<p> |
||||
The LDIF view of such entry can be: |
||||
</p> |
||||
<pre class="code file ldif">dn: cn=lmConf-1,ou=conf,ou=applications,dc=example,dc=com |
||||
objectClass: top |
||||
objectClass: applicationProcess |
||||
cn: lmConf-1 |
||||
description: {globalStorage}'Apache::Session::File' |
||||
description: {cookieName}'lemonldap' |
||||
description: {whatToTrace}'$uid' |
||||
...</pre> |
||||
|
||||
</div> |
||||
<!-- SECTION "Presentation" [44-] --></div><!-- closes <div class="dokuwiki export">--> |
||||
@ -0,0 +1,60 @@ |
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" |
||||
lang="en" dir="ltr"> |
||||
|
||||
<head> |
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title></title> |
||||
<!-- metadata --> |
||||
<meta name="generator" content="Offline" /> |
||||
<meta name="version" content="Offline 0.1" /> |
||||
<!-- style sheet links --> |
||||
<link rel="stylesheet" media="all" type="text/css" href="../../../css/all.css" /> |
||||
<link rel="stylesheet" media="screen" type="text/css" href="../../../css/screen.css" /> |
||||
<link rel="stylesheet" media="print" type="text/css" href="../../../css/print.css" /> |
||||
|
||||
</head> |
||||
<body> |
||||
<div class="dokuwiki export"> |
||||
|
||||
|
||||
<p> |
||||
<a href="../../documentation/1.0/status.html" class="wikilink1" title="documentation:1.0:status">Lemonldap::NG status page</a> can be read by MRTG using the script <strong>lmng-mrtg</strong> that can be found in manager example directory. |
||||
</p> |
||||
|
||||
<p> |
||||
MRTG configuration example : |
||||
|
||||
</p> |
||||
<pre class="code shell">###################################################################### |
||||
# Multi Router Traffic Grapher -- Sample Configuration File |
||||
###################################################################### |
||||
# This file is for use with mrtg-2.5.4c |
||||
|
||||
# Global configuration |
||||
WorkDir: /var/www/mrtg |
||||
WriteExpires: Yes |
||||
|
||||
Title[^]: Traffic Analysis for |
||||
|
||||
# 128K leased line |
||||
# ---------------- |
||||
#Title[leased]: a 128K leased line |
||||
#PageTop[leased]: <H1>Our 128K link to the outside world</H1> |
||||
#Target[leased]: 1:public@router.localnet |
||||
#MaxBytes[leased]: 16000 |
||||
Target[test.example.com]: `/etc/mrtg/lmng-mrtg 172.16.1.2 https://test.example.com/status OK OK` |
||||
Options[test.example.com]: nopercent, growright, nobanner, perminute |
||||
PageTop[test.example.com]: <h1>Requests OK from test.example.com</h1> |
||||
MaxBytes[test.example.com]: 1000000 |
||||
YLegend[test.example.com]: hits/minute |
||||
ShortLegend[test.example.com]: &nbsp; hits/mn |
||||
LegendO[test.example.com]: Hits: |
||||
LegendI[test.example.com]: Hits: |
||||
Legend2[test.example.com]: Hits per minute |
||||
Legend4[test.example.com]: Hits max per minute |
||||
Title[test.example.com]: Hits per minute |
||||
WithPeak[test.example.com]: wmy</pre> |
||||
</div><!-- closes <div class="dokuwiki export">--> |
||||
@ -0,0 +1,184 @@ |
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" |
||||
lang="en" dir="ltr"> |
||||
|
||||
<head> |
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title></title> |
||||
<!-- metadata --> |
||||
<meta name="generator" content="Offline" /> |
||||
<meta name="version" content="Offline 0.1" /> |
||||
<!-- style sheet links --> |
||||
<link rel="stylesheet" media="all" type="text/css" href="../../../css/all.css" /> |
||||
<link rel="stylesheet" media="screen" type="text/css" href="../../../css/screen.css" /> |
||||
<link rel="stylesheet" media="print" type="text/css" href="../../../css/print.css" /> |
||||
|
||||
</head> |
||||
<body> |
||||
<div class="dokuwiki export"> |
||||
|
||||
|
||||
|
||||
|
||||
<h1><a name="notifications_system" id="notifications_system">Notifications system</a></h1> |
||||
<div class="level1"> |
||||
|
||||
<p> |
||||
|
||||
Since version 0.9.4, Lemonldap::NG can be used to notify some messages to users: if a user has a message, the message will be displayed when he will access to the portal. If the message contains checkboxes, the user has to check all of them else he can not access to the portal and get his session cookie. |
||||
</p> |
||||
|
||||
</div> |
||||
<!-- SECTION "Notifications system" [1-343] --> |
||||
<h2><a name="installation" id="installation">Installation</a></h2> |
||||
<div class="level2"> |
||||
|
||||
</div> |
||||
<!-- SECTION "Installation" [344-369] --> |
||||
<h3><a name="activation" id="activation">Activation</a></h3> |
||||
<div class="level3"> |
||||
|
||||
<p> |
||||
|
||||
You just have to set “notification” to “activate” in the manager (or notification=1 in lemonldap-ng.ini, section “PORTAL”). |
||||
</p> |
||||
|
||||
</div> |
||||
|
||||
<h4><a name="storage" id="storage">Storage</a></h4> |
||||
<div class="level4"> |
||||
|
||||
<p> |
||||
|
||||
By default, notifications will be stored in the same database as configuration: |
||||
* if you use “File” system and your “dirName” is set to /usr/local/lemonldap-ng/conf/, the notifications will be stored in /usr/local/lemonldap-ng/notifications/ |
||||
* if you use “<acronym title="Database Interface">DBI</acronym>” system, the notifications will be stored in the same database as configuration and in a table called “notifications”. You have to create the table by yourself&nbsp; |
||||
|
||||
</p> |
||||
<pre class="code sql"><span class="kw1">CREATE</span> <span class="kw1">TABLE</span> <span class="st0">'notifications'</span> <span class="br0">(</span> |
||||
<span class="st0">'date'</span> datetime <span class="kw1">NOT</span> <span class="kw1">NULL</span><span class="sy0">,</span> |
||||
<span class="st0">'uid'</span> varchar<span class="br0">(</span>255<span class="br0">)</span> <span class="kw1">NOT</span> <span class="kw1">NULL</span><span class="sy0">,</span> |
||||
<span class="st0">'ref'</span> varchar<span class="br0">(</span>255<span class="br0">)</span> <span class="kw1">NOT</span> <span class="kw1">NULL</span><span class="sy0">,</span> |
||||
<span class="st0">'xml'</span> longblob <span class="kw1">NOT</span> <span class="kw1">NULL</span><span class="sy0">,</span> |
||||
<span class="st0">'done'</span> datetime <span class="kw1">DEFAULT</span> <span class="kw1">NULL</span><span class="sy0">,</span> |
||||
<span class="kw1">PRIMARY</span> <span class="kw1">KEY</span> <span class="br0">(</span><span class="st0">'date'</span><span class="sy0">,</span><span class="st0">'uid'</span><span class="sy0">,</span><span class="st0">'ref'</span><span class="br0">)</span> |
||||
<span class="br0">)</span></pre> |
||||
|
||||
<p> |
||||
You can change default parameters using the “notificationStorage” parameter with the same syntax as configStorage. |
||||
</p> |
||||
|
||||
</div> |
||||
<!-- SECTION "Activation" [370-1313] --> |
||||
<h2><a name="using_notification_system" id="using_notification_system">Using notification system</a></h2> |
||||
<div class="level2"> |
||||
|
||||
</div> |
||||
<!-- SECTION "Using notification system" [1314-1352] --> |
||||
<h3><a name="insert_new_notifications" id="insert_new_notifications">Insert new notifications</a></h3> |
||||
<div class="level3"> |
||||
|
||||
<p> |
||||
|
||||
New notifications can be insert using <acronym title="Simple Object Access Protocol">SOAP</acronym> request (described in the WSDL file generated by buildPortalWSDL tool). |
||||
</p> |
||||
|
||||
</div> |
||||
|
||||
<h4><a name="notification_format" id="notification_format">Notification format</a></h4> |
||||
<div class="level4"> |
||||
|
||||
<p> |
||||
|
||||
Notifications are <acronym title="Extensible Markup Language">XML</acronym> files containing: |
||||
</p> |
||||
<ul> |
||||
<li class="level1"><div class="li"> ”<notification>” element(s) :</div> |
||||
<ul> |
||||
<li class="level2"><div class="li"> required attributes :</div> |
||||
<ul> |
||||
<li class="level3"><div class="li"> “date” in format YYYY-MM-DD</div> |
||||
</li> |
||||
<li class="level3"><div class="li"> “ref” : a reference that can be used later to know what has been notified and when</div> |
||||
</li> |
||||
<li class="level3"><div class="li"> “uid” : the user (it must correspond to the attibute set in whatToTrace parameter : uid by default)</div> |
||||
</li> |
||||
</ul> |
||||
</li> |
||||
<li class="level2"><div class="li"> sub-elements :</div> |
||||
<ul> |
||||
<li class="level3"><div class="li"> <text> : paragraph to display : will be inserted in <acronym title="HyperText Markup Language">HTML</acronym> page enclosed in <p class=“notifText”>…</p></div> |
||||
</li> |
||||
<li class="level3"><div class="li"> <check> : paragraph to display with a checkbox : will be inserted in <acronym title="HyperText Markup Language">HTML</acronym> page enclosed in <p class=“notifCheck”><input type=“checkbox/>…</p></div> |
||||
</li> |
||||
</ul> |
||||
</li> |
||||
</ul> |
||||
</li> |
||||
</ul> |
||||
|
||||
<p> |
||||
|
||||
All other elements will be removed including <acronym title="HyperText Markup Language">HTML</acronym> elements like <b>; |
||||
</p> |
||||
|
||||
<p> |
||||
Example : |
||||
|
||||
</p> |
||||
<pre class="code xml"><span class="sc3"><span class="re1"><?xml</span> <span class="re0">version</span>=<span class="st0">"1.0"</span> <span class="re0">encoding</span>=<span class="st0">"UTF-8"</span> <span class="re0">standalone</span>=<span class="st0">"no"</span><span class="re2">?></span></span> |
||||
<span class="sc3"><span class="re1"><root<span class="re2">></span></span></span> |
||||
<span class="sc3"><span class="re1"><notification</span> <span class="re0">uid</span>=<span class="st0">"foo.bar"</span> <span class="re0">date</span>=<span class="st0">"2009-01-27"</span> <span class="re0">reference</span>=<span class="st0">"ABC"</span><span class="re2">></span></span> |
||||
<span class="sc3"><span class="re1"><text<span class="re2">></span></span></span> You have been granted to access to appli-1 <span class="sc3"><span class="re1"></text<span class="re2">></span></span></span> |
||||
<span class="sc3"><span class="re1"><text<span class="re2">></span></span></span> You have been granted to access to appli-2 <span class="sc3"><span class="re1"></text<span class="re2">></span></span></span> |
||||
<span class="sc3"><span class="re1"><check<span class="re2">></span></span></span> I know that I can acces to appli-1 <span class="sc3"><span class="re1"></check<span class="re2">></span></span></span> |
||||
<span class="sc3"><span class="re1"><check<span class="re2">></span></span></span> I know that I can acces to appli-2 <span class="sc3"><span class="re1"></check<span class="re2">></span></span></span> |
||||
<span class="sc3"><span class="re1"></notification<span class="re2">></span></span></span> |
||||
<span class="sc3"><span class="re1"></root<span class="re2">></span></span></span></pre> |
||||
|
||||
</div> |
||||
|
||||
<h4><a name="insertion_example_in_perl" id="insertion_example_in_perl">Insertion example in Perl</a></h4> |
||||
<div class="level4"> |
||||
<pre class="code perl"><span class="co1">#!/usr/bin/perl</span> |
||||
|
||||
<span class="kw2">use</span> SOAP<span class="sy0">::</span><span class="me2">Lite</span><span class="sy0">;</span> |
||||
<span class="kw2">use</span> utf8<span class="sy0">;</span> |
||||
|
||||
<span class="kw1">my</span> <span class="re0">$lite</span> <span class="sy0">=</span> SOAP<span class="sy0">::</span><span class="me2">Lite</span> |
||||
<span class="sy0">-></span><span class="me1">uri</span><span class="br0">(</span><span class="st_h">'urn:Lemonldap::NG::Common::CGI::SOAPService'</span><span class="br0">)</span> |
||||
<span class="sy0">-></span><span class="me1">proxy</span><span class="br0">(</span><span class="st_h">'http://auth.example.com/index.pl/notification'</span><span class="br0">)</span><span class="sy0">;</span> |
||||
|
||||
|
||||
<span class="re0">$r</span> <span class="sy0">=</span> <span class="re0">$lite</span><span class="sy0">-></span><span class="me1">newNotification</span><span class="br0">(</span><span class="st_h">'<?xml version="1.0" encoding="UTF-8" standalone="no"?> |
||||
<root> |
||||
<notification uid="foo.bar" date="2009-01-27" reference="ABC"> |
||||
<text> You have been granted to access to appli-1 </text> |
||||
<text> You have been granted to access to appli-2 </text> |
||||
<check> I know that I can acces to appli-1 </check> |
||||
<check> I know that I can acces to appli-2 </check> |
||||
</notification> |
||||
</root>'</span><span class="br0">)</span><span class="sy0">;</span> |
||||
|
||||
<span class="kw1">if</span> <span class="br0">(</span> <span class="re0">$r</span><span class="sy0">-></span><span class="me1">fault</span> <span class="br0">)</span> <span class="br0">{</span> |
||||
<a href="http://perldoc.perl.org/functions/print.html"><span class="kw3">print</span></a> <span class="kw2">STDERR</span> <span class="st0">"SOAP Error: "</span> <span class="sy0">.</span> <span class="re0">$r</span><span class="sy0">-></span><span class="me1">fault</span><span class="sy0">-></span><span class="br0">{</span>faultstring<span class="br0">}</span><span class="sy0">;</span> |
||||
<span class="br0">}</span> |
||||
<span class="kw1">else</span> <span class="br0">{</span> |
||||
<span class="kw1">my</span> <span class="re0">$res</span> <span class="sy0">=</span> <span class="re0">$r</span><span class="sy0">-></span><span class="me1">result</span><span class="br0">(</span><span class="br0">)</span><span class="sy0">;</span> |
||||
<a href="http://perldoc.perl.org/functions/print.html"><span class="kw3">print</span></a> <span class="st0">"$res notification(s) have been inserted<span class="es0">\"</span>; |
||||
}</span></pre> |
||||
|
||||
</div> |
||||
<!-- SECTION "Insert new notifications" [1353-3449] --> |
||||
<h3><a name="test_notification" id="test_notification">Test notification</a></h3> |
||||
<div class="level3"> |
||||
|
||||
<p> |
||||
|
||||
You've simply to insert a notification and connect to the portal using the same UID. You will be prompted. |
||||
</p> |
||||
|
||||
</div> |
||||
<!-- SECTION "Test notification" [3450-] --></div><!-- closes <div class="dokuwiki export">--> |
||||
@ -0,0 +1,117 @@ |
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" |
||||
lang="en" dir="ltr"> |
||||
|
||||
<head> |
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title></title> |
||||
<!-- metadata --> |
||||
<meta name="generator" content="Offline" /> |
||||
<meta name="version" content="Offline 0.1" /> |
||||
<!-- style sheet links --> |
||||
<link rel="stylesheet" media="all" type="text/css" href="../../../css/all.css" /> |
||||
<link rel="stylesheet" media="screen" type="text/css" href="../../../css/screen.css" /> |
||||
<link rel="stylesheet" media="print" type="text/css" href="../../../css/print.css" /> |
||||
|
||||
</head> |
||||
<body> |
||||
<div class="dokuwiki export"> |
||||
|
||||
|
||||
|
||||
|
||||
<h1><a name="the_portal" id="the_portal">The portal</a></h1> |
||||
<div class="level1"> |
||||
|
||||
<p> |
||||
|
||||
The portal is the main component of Lemonldap::NG. It provides many features: |
||||
</p> |
||||
<ul> |
||||
<li class="level1"><div class="li"> <strong>Authentication service</strong> of course</div> |
||||
<ul> |
||||
<li class="level2"><div class="li"> Web based for normal users:</div> |
||||
<ul> |
||||
<li class="level3"><div class="li"> using own database (<acronym title="Lightweight Directory Access Protocol">LDAP</acronym>, <acronym title="Structured Query Language">SQL</acronym>,…)</div> |
||||
</li> |
||||
<li class="level3"><div class="li"> using Apache authentication system (used for <acronym title="Secure Sockets Layer">SSL</acronym>, Kerberos, <acronym title="Hyper Text Transfer Protocol">HTTP</acronym> basic authentication,…)</div> |
||||
</li> |
||||
<li class="level3"><div class="li"> using external identity provider (<acronym title="Security Assertion Markup Language">SAML</acronym>, OpenID, <acronym title="Central Authentication Service">CAS</acronym>, Twitter, other Lemonldap::NG system,…)</div> |
||||
</li> |
||||
<li class="level3"><div class="li"> all together (based on user choice, rules,…)</div> |
||||
</li> |
||||
</ul> |
||||
</li> |
||||
<li class="level2"><div class="li"> <acronym title="Simple Object Access Protocol">SOAP</acronym> based for client-server software, specific development,…</div> |
||||
</li> |
||||
</ul> |
||||
</li> |
||||
<li class="level1"><div class="li"> <strong>Identity provider</strong>: Lemonldap::NG is able to provide identity service using:</div> |
||||
<ul> |
||||
<li class="level2"><div class="li"> <acronym title="Security Assertion Markup Language">SAML</acronym></div> |
||||
</li> |
||||
<li class="level2"><div class="li"> OpenID</div> |
||||
</li> |
||||
<li class="level2"><div class="li"> <acronym title="Central Authentication Service">CAS</acronym></div> |
||||
</li> |
||||
</ul> |
||||
</li> |
||||
<li class="level1"><div class="li"> <strong>Identity provider proxy</strong> : Lemonldap::NG can be used as proxy translator between systems talking <acronym title="Security Assertion Markup Language">SAML</acronym>, OpenID, <acronym title="Central Authentication Service">CAS</acronym>,…</div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <strong>Internal <acronym title="Simple Object Access Protocol">SOAP</acronym> server</strong> when <a href="../../documentation/1.0/soapconfbackend.html" class="wikilink1" title="documentation:1.0:soapconfbackend">SOAP configuration backend</a> is used (useable for specific development, see <a href="../../documentation/1.0/soapservices.html" class="wikilink1" title="documentation:1.0:soapservices">SOAP services</a> for more)</div> |
||||
</li> |
||||
<li class="level1"><div class="li"> Interactive <strong>management of user Passwords</strong></div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <strong>Application displaying</strong> (<a href="../../documentation/1.0/portalmenu.html" class="wikilink1" title="documentation:1.0:portalmenu">menu</a>)</div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <strong><a href="../../documentation/1.0/notifications.html" class="wikilink1" title="documentation:1.0:notifications">Notifications</a></strong>: prompt users with a message if found in the database)</div> |
||||
</li> |
||||
</ul> |
||||
|
||||
</div> |
||||
<!-- SECTION "The portal" [1-1145] --> |
||||
<h2><a name="functioning" id="functioning">Functioning</a></h2> |
||||
<div class="level2"> |
||||
|
||||
<p> |
||||
|
||||
Lemonldap::NG portal is a modular component. It needs 4 modules to work: |
||||
</p> |
||||
<ul> |
||||
<li class="level1"><div class="li"> <a href="../../documentation/1.0/start.html#authentication_and_users_database" class="wikilink1" title="documentation:1.0:start">Authentication module</a></div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <a href="../../documentation/1.0/start.html#authentication_and_users_database" class="wikilink1" title="documentation:1.0:start">User database module</a> (can be set to “Null”)</div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <a href="../../documentation/1.0/start.html#identity_provider" class="wikilink1" title="documentation:1.0:start">Identity provider module</a> (can be set to “Null”)</div> |
||||
</li> |
||||
<li class="level1"><div class="li"> Password database module (can be set to “Null”)</div> |
||||
</li> |
||||
</ul> |
||||
|
||||
</div> |
||||
<!-- SECTION "Functioning" [1146-1538] --> |
||||
<h2><a name="kinematics" id="kinematics">Kinematics</a></h2> |
||||
<div class="level2"> |
||||
<ol> |
||||
<li class="level1"><div class="li"> Check if <acronym title="Uniform Resource Locator">URL</acronym> asked is valid</div> |
||||
</li> |
||||
<li class="level1"><div class="li"> Check if user is already authenticated</div> |
||||
<ul> |
||||
<li class="level2"><div class="li"> Else try to find it (userDB module) and to authenticate it (auth module), create session, calculates macros and store it</div> |
||||
</li> |
||||
</ul> |
||||
</li> |
||||
<li class="level1"><div class="li"> Modify password if asked</div> |
||||
</li> |
||||
<li class="level1"><div class="li"> Provides identity if asked</div> |
||||
</li> |
||||
<li class="level1"><div class="li"> Build <a href="../../documentation/1.0/ssocookie.html" class="wikilink1" title="documentation:1.0:ssocookie">cookie(s)</a></div> |
||||
</li> |
||||
<li class="level1"><div class="li"> Redirect user to the asked <acronym title="Uniform Resource Locator">URL</acronym> or display menu</div> |
||||
</li> |
||||
</ol> |
||||
|
||||
</div> |
||||
<!-- SECTION "Kinematics" [1539-] --></div><!-- closes <div class="dokuwiki export">--> |
||||
@ -0,0 +1,119 @@ |
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" |
||||
lang="en" dir="ltr"> |
||||
|
||||
<head> |
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title></title> |
||||
<!-- metadata --> |
||||
<meta name="generator" content="Offline" /> |
||||
<meta name="version" content="Offline 0.1" /> |
||||
<!-- style sheet links --> |
||||
<link rel="stylesheet" media="all" type="text/css" href="../../../css/all.css" /> |
||||
<link rel="stylesheet" media="screen" type="text/css" href="../../../css/screen.css" /> |
||||
<link rel="stylesheet" media="print" type="text/css" href="../../../css/print.css" /> |
||||
|
||||
</head> |
||||
<body> |
||||
<div class="dokuwiki export"> |
||||
|
||||
|
||||
|
||||
|
||||
<h1><a name="soap_services" id="soap_services">SOAP services</a></h1> |
||||
<div class="level1"> |
||||
|
||||
<p> |
||||
|
||||
Lemonldap::NG provides 2 <acronym title="Simple Object Access Protocol">SOAP</acronym> servers : |
||||
</p> |
||||
<ul> |
||||
<li class="level1"><div class="li"> the <a href="../../documentation/1.0/portal.html" class="wikilink1" title="documentation:1.0:portal">portal</a></div> |
||||
</li> |
||||
<li class="level1"><div class="li"> the manager (for internal use only)</div> |
||||
</li> |
||||
</ul> |
||||
|
||||
</div> |
||||
<!-- SECTION "SOAP services" [1-129] --> |
||||
<h2><a name="portal_soap_services" id="portal_soap_services">Portal SOAP services</a></h2> |
||||
<div class="level2"> |
||||
|
||||
<p> |
||||
|
||||
<acronym title="Simple Object Access Protocol">SOAP</acronym> functions are not accessible by network by default: <acronym title="Simple Object Access Protocol">SOAP</acronym> functions are protected by Apache, you can change this in portal-apache2.conf file. |
||||
</p> |
||||
<pre class="code apache"> <span class="co1"># SOAP functions for sessions management (disabled by default)</span> |
||||
<<span class="kw3">Directory</span> /var/lib/lemonldap-ng/portal/index.pl/adminSessions> |
||||
<span class="kw1">Order</span> <span class="kw1">deny</span>,<span class="kw1">allow</span> |
||||
<span class="kw1">Deny</span> from <span class="kw2">all</span> |
||||
</<span class="kw3">Directory</span>> |
||||
|
||||
<span class="co1"># SOAP functions for sessions access (disabled by default)</span> |
||||
<<span class="kw3">Directory</span> /var/lib/lemonldap-ng/portal/index.pl/sessions> |
||||
<span class="kw1">Order</span> <span class="kw1">deny</span>,<span class="kw1">allow</span> |
||||
<span class="kw1">Deny</span> from <span class="kw2">all</span> |
||||
</<span class="kw3">Directory</span>> |
||||
|
||||
<span class="co1"># SOAP functions for configuration access (disabled by default)</span> |
||||
<<span class="kw3">Directory</span> /var/lib/lemonldap-ng/portal/index.pl/config> |
||||
<span class="kw1">Order</span> <span class="kw1">deny</span>,<span class="kw1">allow</span> |
||||
<span class="kw1">Deny</span> from <span class="kw2">all</span> |
||||
</<span class="kw3">Directory</span>> |
||||
|
||||
<span class="co1"># SOAP functions for notification insertion (disabled by default)</span> |
||||
<<span class="kw3">Directory</span> /var/lib/lemonldap-ng/portal/index.pl/notification> |
||||
<span class="kw1">Order</span> <span class="kw1">deny</span>,<span class="kw1">allow</span> |
||||
<span class="kw1">Deny</span> from <span class="kw2">all</span> |
||||
</<span class="kw3">Directory</span>></pre> |
||||
|
||||
<p> |
||||
<p><div class="notetip">You can create a <acronym title="Simple Object Access Protocol">SOAP</acronym> only portal by setting “soapOnly = 1” in lemonldap-ng.ini (section PORTAL) |
||||
</div></p> |
||||
|
||||
</p> |
||||
<ul> |
||||
<li class="level1"><div class="li"> Read-only functions (index.pl/sessions or index.pl/adminSessions paths):</div> |
||||
<ul> |
||||
<li class="level2"><div class="li"> <strong>getCookies(user,password)</strong>: authentication system. Returns cookie(s) name and values</div> |
||||
</li> |
||||
<li class="level2"><div class="li"> <strong>getAttributes(cookieValue)</strong>: get elements stored in session</div> |
||||
</li> |
||||
<li class="level2"><div class="li"> <strong>isAuthorizedURI(cookieValue,url)</strong>: check if user is granted to access to the function</div> |
||||
</li> |
||||
<li class="level2"><div class="li"> <strong>getMenuApplications(cookieValue)</strong>: return a list of authorizated applications (based on menu calculation)</div> |
||||
</li> |
||||
</ul> |
||||
</li> |
||||
<li class="level1"><div class="li"> Read/Write functions (index.pl/adminSessions paths):</div> |
||||
<ul> |
||||
<li class="level2"><div class="li"> <strong>setAttributes(cookieValue,hashtable)</strong>: update a session</div> |
||||
</li> |
||||
<li class="level2"><div class="li"> <strong>newSession</strong>: create a session (return attributes)</div> |
||||
</li> |
||||
<li class="level2"><div class="li"> <strong>deleteSession</strong>: delete a session</div> |
||||
</li> |
||||
<li class="level2"><div class="li"> <strong>get_key_from_all_sessions</strong>: list all sessions and return asked keys</div> |
||||
</li> |
||||
</ul> |
||||
</li> |
||||
<li class="level1"><div class="li"> Notification send function (index.pl/notification):</div> |
||||
<ul> |
||||
<li class="level2"><div class="li"> <strong>newNotification(xmlString)</strong>: insert a notification for a user (see <a href="../../documentation/1.0/notifications.html" class="wikilink1" title="documentation:1.0:notifications">Notifications system</a> for more)</div> |
||||
</li> |
||||
</ul> |
||||
</li> |
||||
</ul> |
||||
|
||||
<p> |
||||
|
||||
<p><div class="noteimportant">When you use <a href="../../documentation/1.0/soapconfbackend.html" class="wikilink1" title="documentation:1.0:soapconfbackend">SOAP configuration backend</a>, it is recommended to use read-only <acronym title="Uniform Resource Locator">URL</acronym> (<a href="http://portal/index.pl/sessions" class="urlextern" title="http://portal/index.pl/sessions" rel="nofollow">http://portal/index.pl/sessions</a>). Write session path is needed only if you use a remote session explorer or a remote portal |
||||
|
||||
</div></p> |
||||
|
||||
</p> |
||||
|
||||
</div> |
||||
<!-- SECTION "Portal SOAP services" [130-] --></div><!-- closes <div class="dokuwiki export">--> |
||||
@ -1,171 +0,0 @@ |
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" |
||||
lang="en" dir="ltr"> |
||||
|
||||
<head> |
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title></title> |
||||
<!-- metadata --> |
||||
<meta name="generator" content="Offline" /> |
||||
<meta name="version" content="Offline 0.1" /> |
||||
<!-- style sheet links --> |
||||
<link rel="stylesheet" media="all" type="text/css" href="../../css/all.css" /> |
||||
<link rel="stylesheet" media="screen" type="text/css" href="../../css/screen.css" /> |
||||
<link rel="stylesheet" media="print" type="text/css" href="../../css/print.css" /> |
||||
|
||||
</head> |
||||
<body> |
||||
<div class="dokuwiki export"> |
||||
|
||||
|
||||
|
||||
|
||||
<h1><a name="dokuwiki" id="dokuwiki">DokuWiki</a></h1> |
||||
<div class="level1"> |
||||
|
||||
<p> |
||||
|
||||
<a href="http://www.dokuwiki.org/wiki%3Adokuwiki" class="media" title="http://www.dokuwiki.org/wiki%3Adokuwiki"><img src="../../media/wiki/dokuwiki-128.png" class="medialeft" align="left" alt="" /></a> DokuWiki is a standards compliant, simple to use <a href="http://en.wikipedia.org/wiki/Wiki" class="interwiki iw_wp" title="http://en.wikipedia.org/wiki/Wiki">Wiki</a>, mainly aimed at creating documentation of any kind. It is targeted at developer teams, workgroups and small companies. It has a simple but powerful <a href="../wiki/syntax.html" class="wikilink1" title="wiki:syntax">syntax</a> which makes sure the datafiles remain readable outside the Wiki and eases the creation of structured texts. All data is stored in plain text files – no database is required. |
||||
</p> |
||||
|
||||
<p> |
||||
Read the <a href="http://www.dokuwiki.org/manual" class="interwiki iw_doku" title="http://www.dokuwiki.org/manual">DokuWiki Manual</a> to unleash the full power of DokuWiki. |
||||
</p> |
||||
|
||||
</div> |
||||
<!-- SECTION "DokuWiki" [1-557] --> |
||||
<h2><a name="download" id="download">Download</a></h2> |
||||
<div class="level2"> |
||||
|
||||
<p> |
||||
|
||||
DokuWiki is available at <a href="http://www.splitbrain.org/go/dokuwiki" class="urlextern" title="http://www.splitbrain.org/go/dokuwiki" rel="nofollow">http://www.splitbrain.org/go/dokuwiki</a> |
||||
</p> |
||||
|
||||
</div> |
||||
<!-- SECTION "Download" [558-644] --> |
||||
<h2><a name="read_more" id="read_more">Read More</a></h2> |
||||
<div class="level2"> |
||||
|
||||
<p> |
||||
|
||||
All documentation and additional information besides the <a href="../wiki/syntax.html" class="wikilink1" title="wiki:syntax">syntax description</a> is maintained in the DokuWiki at <a href="http://www.dokuwiki.org/" class="interwiki iw_doku" title="http://www.dokuwiki.org/">www.dokuwiki.org</a>. |
||||
</p> |
||||
|
||||
<p> |
||||
<strong>About DokuWiki</strong> |
||||
|
||||
</p> |
||||
<ul> |
||||
<li class="level1"><div class="li"> <a href="http://www.dokuwiki.org/features" class="interwiki iw_doku" title="http://www.dokuwiki.org/features">A feature list</a> <img src="/lib/images/smileys/icon_exclaim.gif" class="middle" alt=":!:" /></div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <a href="http://www.dokuwiki.org/users" class="interwiki iw_doku" title="http://www.dokuwiki.org/users">Happy Users</a></div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <a href="http://www.dokuwiki.org/press" class="interwiki iw_doku" title="http://www.dokuwiki.org/press">Who wrote about it</a></div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <a href="http://www.dokuwiki.org/blogroll" class="interwiki iw_doku" title="http://www.dokuwiki.org/blogroll">What Bloggers think</a></div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <a href="http://www.wikimatrix.org/show/DokuWiki" class="urlextern" title="http://www.wikimatrix.org/show/DokuWiki" rel="nofollow">Compare it with other wiki software</a></div> |
||||
</li> |
||||
</ul> |
||||
|
||||
<p> |
||||
|
||||
<strong>Installing DokuWiki</strong> |
||||
|
||||
</p> |
||||
<ul> |
||||
<li class="level1"><div class="li"> <a href="http://www.dokuwiki.org/requirements" class="interwiki iw_doku" title="http://www.dokuwiki.org/requirements">System Requirements</a></div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <a href="http://www.splitbrain.org/go/dokuwiki" class="urlextern" title="http://www.splitbrain.org/go/dokuwiki" rel="nofollow">Download DokuWiki</a> <img src="/lib/images/smileys/icon_exclaim.gif" class="middle" alt=":!:" /></div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <a href="http://www.dokuwiki.org/changes" class="interwiki iw_doku" title="http://www.dokuwiki.org/changes">Change Log</a></div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <a href="http://www.dokuwiki.org/Install" class="interwiki iw_doku" title="http://www.dokuwiki.org/Install">How to install or upgrade</a> <img src="/lib/images/smileys/icon_exclaim.gif" class="middle" alt=":!:" /></div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <a href="http://www.dokuwiki.org/config" class="interwiki iw_doku" title="http://www.dokuwiki.org/config">Configuration</a></div> |
||||
</li> |
||||
</ul> |
||||
|
||||
<p> |
||||
|
||||
<strong>Using DokuWiki</strong> |
||||
|
||||
</p> |
||||
<ul> |
||||
<li class="level1"><div class="li"> <a href="http://www.dokuwiki.org/syntax" class="interwiki iw_doku" title="http://www.dokuwiki.org/syntax">Wiki Syntax</a></div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <a href="http://www.dokuwiki.org/manual" class="interwiki iw_doku" title="http://www.dokuwiki.org/manual">The manual</a> <img src="/lib/images/smileys/icon_exclaim.gif" class="middle" alt=":!:" /></div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <a href="http://www.dokuwiki.org/FAQ" class="interwiki iw_doku" title="http://www.dokuwiki.org/FAQ">Frequently Asked Questions (FAQ)</a></div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <a href="http://www.dokuwiki.org/glossary" class="interwiki iw_doku" title="http://www.dokuwiki.org/glossary">Glossary</a></div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <a href="http://search.dokuwiki.org" class="urlextern" title="http://search.dokuwiki.org" rel="nofollow">Search for DokuWiki help and documentation</a></div> |
||||
</li> |
||||
</ul> |
||||
|
||||
<p> |
||||
|
||||
<strong>Customizing DokuWiki</strong> |
||||
|
||||
</p> |
||||
<ul> |
||||
<li class="level1"><div class="li"> <a href="http://www.dokuwiki.org/tips" class="interwiki iw_doku" title="http://www.dokuwiki.org/tips">Tips and Tricks</a></div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <a href="http://www.dokuwiki.org/Template" class="interwiki iw_doku" title="http://www.dokuwiki.org/Template">How to create and use templates</a></div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <a href="http://www.dokuwiki.org/plugins" class="interwiki iw_doku" title="http://www.dokuwiki.org/plugins">Installing plugins</a></div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <a href="http://www.dokuwiki.org/development" class="interwiki iw_doku" title="http://www.dokuwiki.org/development">Development Resources</a></div> |
||||
</li> |
||||
</ul> |
||||
|
||||
<p> |
||||
|
||||
<strong>DokuWiki Feedback and Community</strong> |
||||
|
||||
</p> |
||||
<ul> |
||||
<li class="level1"><div class="li"> <a href="http://www.dokuwiki.org/newsletter" class="interwiki iw_doku" title="http://www.dokuwiki.org/newsletter">Subscribe to the newsletter</a> <img src="/lib/images/smileys/icon_exclaim.gif" class="middle" alt=":!:" /></div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <a href="http://www.dokuwiki.org/mailinglist" class="interwiki iw_doku" title="http://www.dokuwiki.org/mailinglist">Join the mailing list</a></div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <a href="http://forum.dokuwiki.org" class="urlextern" title="http://forum.dokuwiki.org" rel="nofollow">Check out the user forum</a></div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <a href="http://www.dokuwiki.org/irc" class="interwiki iw_doku" title="http://www.dokuwiki.org/irc">Talk to other users in the IRC channel</a></div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <a href="http://bugs.splitbrain.org/index.php?project=1" class="urlextern" title="http://bugs.splitbrain.org/index.php?project=1" rel="nofollow">Submit bugs and feature wishes</a></div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <a href="http://www.wikimatrix.org/forum/viewforum.php?id=10" class="urlextern" title="http://www.wikimatrix.org/forum/viewforum.php?id=10" rel="nofollow">Share your experiences in the WikiMatrix forum</a></div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <a href="http://www.dokuwiki.org/thanks" class="interwiki iw_doku" title="http://www.dokuwiki.org/thanks">Some humble thanks</a></div> |
||||
</li> |
||||
</ul> |
||||
|
||||
</div> |
||||
<!-- SECTION "Read More" [645-2268] --> |
||||
<h2><a name="copyright" id="copyright">Copyright</a></h2> |
||||
<div class="level2"> |
||||
|
||||
<p> |
||||
|
||||
2004-2009 © Andreas Gohr <a href="mailto:andi@splitbrain.org" class="mail JSnocheck" title="andi@splitbrain.org">andi@splitbrain.org</a><sup><a href="#fn__1" name="fnt__1" id="fnt__1" class="fn_top">1)</a></sup> |
||||
</p> |
||||
|
||||
<p> |
||||
The DokuWiki engine is licensed under <a href="http://www.gnu.org/licenses/gpl.html" class="urlextern" title="http://www.gnu.org/licenses/gpl.html" rel="nofollow">GNU General Public License</a> Version 2. If you use DokuWiki in your company, consider <a href="http://www.dokuwiki.org/donate" class="interwiki iw_doku" title="http://www.dokuwiki.org/donate">donating</a> a few bucks <img src="/lib/images/smileys/icon_wink.gif" class="middle" alt=";-)" />. |
||||
</p> |
||||
|
||||
<p> |
||||
Not sure what this means? See the <a href="http://www.dokuwiki.org/faq%3Alicense" class="interwiki iw_doku" title="http://www.dokuwiki.org/faq%3Alicense">FAQ on the Licenses</a>. |
||||
</p> |
||||
|
||||
</div> |
||||
<!-- SECTION "Copyright" [2269-] --><div class="footnotes"> |
||||
<div class="fn"><sup><a href="#fnt__1" id="fn__1" name="fn__1" class="fn_bot">1)</a></sup> |
||||
Please do not contact me for help and support – use the <a href="http://www.dokuwiki.org/mailinglist" class="interwiki iw_doku" title="http://www.dokuwiki.org/mailinglist">mailinglist</a> or <a href="http://forum.dokuwiki.org" class="urlextern" title="http://forum.dokuwiki.org" rel="nofollow">forum</a> instead</div> |
||||
</div> |
||||
</div><!-- closes <div class="dokuwiki export">--> |
||||
@ -1,902 +0,0 @@ |
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" |
||||
lang="en" dir="ltr"> |
||||
|
||||
<head> |
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title></title> |
||||
<!-- metadata --> |
||||
<meta name="generator" content="Offline" /> |
||||
<meta name="version" content="Offline 0.1" /> |
||||
<!-- style sheet links --> |
||||
<link rel="stylesheet" media="all" type="text/css" href="../../css/all.css" /> |
||||
<link rel="stylesheet" media="screen" type="text/css" href="../../css/screen.css" /> |
||||
<link rel="stylesheet" media="print" type="text/css" href="../../css/print.css" /> |
||||
|
||||
</head> |
||||
<body> |
||||
<div class="dokuwiki export"> |
||||
|
||||
|
||||
|
||||
|
||||
<h1><a name="formatting_syntax" id="formatting_syntax">Formatting Syntax</a></h1> |
||||
<div class="level1"> |
||||
|
||||
<p> |
||||
|
||||
<a href="http://www.dokuwiki.org/DokuWiki" class="interwiki iw_doku" title="http://www.dokuwiki.org/DokuWiki">DokuWiki</a> 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 the <em>Edit this page</em> button at the top or bottom of the page. If you want to try something, just use the <a href="../playground/playground.html" class="wikilink1" title="playground:playground">playground</a> page. The simpler markup is easily accessible via <a href="http://www.dokuwiki.org/toolbar" class="interwiki iw_doku" title="http://www.dokuwiki.org/toolbar">quickbuttons</a>, too. |
||||
</p> |
||||
|
||||
</div> |
||||
<!-- SECTION "Formatting Syntax" [1-518] --> |
||||
<h2><a name="basic_text_formatting" id="basic_text_formatting">Basic Text Formatting</a></h2> |
||||
<div class="level2"> |
||||
|
||||
<p> |
||||
|
||||
DokuWiki supports <strong>bold</strong>, <em>italic</em>, <em class="u">underlined</em> and <code>monospaced</code> texts. Of course you can <strong><em class="u"><em><code>combine</code></em></em></strong> all these. |
||||
|
||||
</p> |
||||
<pre class="code">DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts. |
||||
Of course you can **__//''combine''//__** all these.</pre> |
||||
|
||||
<p> |
||||
|
||||
You can use <sub>subscript</sub> and <sup>superscript</sup>, too. |
||||
|
||||
</p> |
||||
<pre class="code">You can use <sub>subscript</sub> and <sup>superscript</sup>, too.</pre> |
||||
|
||||
<p> |
||||
|
||||
You can mark something as <del>deleted</del> as well. |
||||
|
||||
</p> |
||||
<pre class="code">You can mark something as <del>deleted</del> as well.</pre> |
||||
|
||||
<p> |
||||
|
||||
<strong>Paragraphs</strong> are created from blank lines. If you want to <strong>force a newline</strong> without a paragraph, you can use two backslashes followed by a whitespace or the end of line. |
||||
</p> |
||||
|
||||
<p> |
||||
This is some text with some linebreaks<br/> |
||||
Note that the |
||||
two backslashes are only recognized at the end of a line<br/> |
||||
|
||||
or followed by<br/> |
||||
a whitespace \\this happens without it. |
||||
|
||||
</p> |
||||
<pre class="code">This is some text with some linebreaks\\ Note that the |
||||
two backslashes are only recognized at the end of a line\\ |
||||
or followed by\\ a whitespace \\this happens without it.</pre> |
||||
|
||||
<p> |
||||
|
||||
You should use forced newlines only if really needed. |
||||
</p> |
||||
|
||||
</div> |
||||
<!-- SECTION "Basic Text Formatting" [519-1655] --> |
||||
<h2><a name="links" id="links">Links</a></h2> |
||||
<div class="level2"> |
||||
|
||||
<p> |
||||
|
||||
DokuWiki supports multiple ways of creating links. |
||||
</p> |
||||
|
||||
</div> |
||||
<!-- SECTION "Links" [1656-1726] --> |
||||
<h3><a name="external" id="external">External</a></h3> |
||||
<div class="level3"> |
||||
|
||||
<p> |
||||
|
||||
External links are recognized automagically: <a href="http://www.google.com" class="urlextern" title="http://www.google.com" rel="nofollow">http://www.google.com</a> or simply <a href="http://www.google.com" class="urlextern" title="http://www.google.com" rel="nofollow">www.google.com</a> - You can set the link text as well: <a href="http://www.google.com" class="urlextern" title="http://www.google.com" rel="nofollow">This Link points to google</a>. Email addresses like this one: <a href="mailto:andi@splitbrain.org" class="mail JSnocheck" title="andi@splitbrain.org">andi@splitbrain.org</a> are recognized, too. |
||||
|
||||
</p> |
||||
<pre class="code">DokuWiki supports multiple ways of creating links. External links are recognized |
||||
automagically: http://www.google.com or simply www.google.com - You can set |
||||
link text as well: [[http://www.google.com|This Link points to google]]. Email |
||||
addresses like this one: <andi@splitbrain.org> are recognized, too.</pre> |
||||
|
||||
</div> |
||||
<!-- SECTION "External" [1727-2317] --> |
||||
<h3><a name="internal" id="internal">Internal</a></h3> |
||||
<div class="level3"> |
||||
|
||||
<p> |
||||
|
||||
Internal links are created by using square brackets. You can either just give a <a href="../wiki/pagename.html" class="wikilink2" title="wiki:pagename" rel="nofollow">pagename</a> or use an additional <a href="../wiki/pagename.html" class="wikilink2" title="wiki:pagename" rel="nofollow">link text</a>. |
||||
|
||||
</p> |
||||
<pre class="code">Internal links are created by using square brackets. You can either just give |
||||
a [[pagename]] or use an additional [[pagename|link text]].</pre> |
||||
|
||||
<p> |
||||
|
||||
<a href="http://www.dokuwiki.org/pagename" class="interwiki iw_doku" title="http://www.dokuwiki.org/pagename">Wiki pagenames</a> are converted to lowercase automatically, special characters are not allowed. |
||||
</p> |
||||
|
||||
<p> |
||||
You can use <a href="../some/namespaces.html" class="wikilink2" title="some:namespaces" rel="nofollow">namespaces</a> by using a colon in the pagename. |
||||
|
||||
</p> |
||||
<pre class="code">You can use [[some:namespaces]] by using a colon in the pagename.</pre> |
||||
|
||||
<p> |
||||
|
||||
For details about namespaces see <a href="http://www.dokuwiki.org/namespaces" class="interwiki iw_doku" title="http://www.dokuwiki.org/namespaces">namespaces</a>. |
||||
</p> |
||||
|
||||
<p> |
||||
Linking to a specific section is possible, too. Just add the section name behind a hash character as known from <acronym title="HyperText Markup Language">HTML</acronym>. This links to <span class="curid"><a href="../wiki/syntax.html#internal" class="wikilink1" title="wiki:syntax">this Section</a></span>. |
||||
|
||||
</p> |
||||
<pre class="code">This links to [[syntax#internal|this Section]].</pre> |
||||
|
||||
<p> |
||||
|
||||
Notes: |
||||
|
||||
</p> |
||||
<ul> |
||||
<li class="level1"><div class="li"> Links to <span class="curid"><a href="../wiki/syntax.html" class="wikilink1" title="wiki:syntax">existing pages</a></span> are shown in a different style from <a href="../wiki/nonexisting.html" class="wikilink2" title="wiki:nonexisting" rel="nofollow">nonexisting</a> ones.</div> |
||||
</li> |
||||
<li class="level1"><div class="li"> DokuWiki does not use <a href="http://en.wikipedia.org/wiki/CamelCase" class="interwiki iw_wp" title="http://en.wikipedia.org/wiki/CamelCase">CamelCase</a> to automatically create links by default, but this behavior can be enabled in the <a href="http://www.dokuwiki.org/config" class="interwiki iw_doku" title="http://www.dokuwiki.org/config">config</a> file. Hint: If DokuWiki is a link, then it's enabled.</div> |
||||
</li> |
||||
<li class="level1"><div class="li"> When a section's heading is changed, its bookmark changes, too. So don't rely on section linking too much.</div> |
||||
</li> |
||||
</ul> |
||||
|
||||
</div> |
||||
<!-- SECTION "Internal" [2318-3552] --> |
||||
<h3><a name="interwiki" id="interwiki">Interwiki</a></h3> |
||||
<div class="level3"> |
||||
|
||||
<p> |
||||
|
||||
DokuWiki supports <a href="http://www.dokuwiki.org/Interwiki" class="interwiki iw_doku" title="http://www.dokuwiki.org/Interwiki">Interwiki</a> links. These are quick links to other Wikis. For example this is a link to Wikipedia's page about Wikis: <a href="http://en.wikipedia.org/wiki/Wiki" class="interwiki iw_wp" title="http://en.wikipedia.org/wiki/Wiki">Wiki</a>. |
||||
|
||||
</p> |
||||
<pre class="code">DokuWiki supports [[doku>Interwiki]] links. These are quick links to other Wikis. |
||||
For example this is a link to Wikipedia's page about Wikis: [[wp>Wiki]].</pre> |
||||
|
||||
</div> |
||||
<!-- SECTION "Interwiki" [3553-3890] --> |
||||
<h3><a name="windows_shares" id="windows_shares">Windows Shares</a></h3> |
||||
<div class="level3"> |
||||
|
||||
<p> |
||||
|
||||
Windows shares like <a href="file://///server/share" class="windows" title="\\server\share">this</a> are recognized, too. Please note that these only make sense in a homogeneous user group like a corporate <a href="http://en.wikipedia.org/wiki/Intranet" class="interwiki iw_wp" title="http://en.wikipedia.org/wiki/Intranet">Intranet</a>. |
||||
|
||||
</p> |
||||
<pre class="code">Windows Shares like [[\\server\share|this]] are recognized, too.</pre> |
||||
|
||||
<p> |
||||
|
||||
Notes: |
||||
|
||||
</p> |
||||
<ul> |
||||
<li class="level1"><div class="li"> For security reasons direct browsing of windows shares only works in Microsoft Internet Explorer per default (and only in the “local zone”).</div> |
||||
</li> |
||||
<li class="level1"><div class="li"> For Mozilla and Firefox it can be enabled through different workaround mentioned in the <a href="http://kb.mozillazine.org/Links_to_local_pages_don't_work" class="urlextern" title="http://kb.mozillazine.org/Links_to_local_pages_don't_work" rel="nofollow">Mozilla Knowledge Base</a>.</div> |
||||
</li> |
||||
</ul> |
||||
|
||||
</div> |
||||
<!-- SECTION "Windows Shares" [3891-4484] --> |
||||
<h3><a name="image_links" id="image_links">Image Links</a></h3> |
||||
<div class="level3"> |
||||
|
||||
<p> |
||||
|
||||
You can also use an image to link to another internal or external page by combining the syntax for links and <a href="#images_and_other_files" title="wiki:syntax ↵" class="wikilink1">images</a> (see below) like this: |
||||
|
||||
</p> |
||||
<pre class="code">[[http://www.php.net|{{wiki:dokuwiki-128.png}}]]</pre> |
||||
|
||||
<p> |
||||
|
||||
<a href="http://www.php.net" class="media" title="http://www.php.net" rel="nofollow"><img src="../../media/wiki/dokuwiki-128.png" class="media" alt="" /></a> |
||||
</p> |
||||
|
||||
<p> |
||||
Please note: The image formatting is the only formatting syntax accepted in link names. |
||||
</p> |
||||
|
||||
<p> |
||||
The whole <a href="#images_and_other_files" title="wiki:syntax ↵" class="wikilink1">image</a> and <a href="#links" title="wiki:syntax ↵" class="wikilink1">link</a> syntax is supported (including image resizing, internal and external images and URLs and interwiki links). |
||||
</p> |
||||
|
||||
</div> |
||||
<!-- SECTION "Image Links" [4485-5038] --> |
||||
<h2><a name="footnotes" id="footnotes">Footnotes</a></h2> |
||||
<div class="level2"> |
||||
|
||||
<p> |
||||
|
||||
You can add footnotes <sup><a href="#fn__1" name="fnt__1" id="fnt__1" class="fn_top">1)</a></sup> by using double parentheses. |
||||
|
||||
</p> |
||||
<pre class="code">You can add footnotes ((This is a footnote)) by using double parentheses.</pre> |
||||
|
||||
</div> |
||||
<!-- SECTION "Footnotes" [5039-5213] --> |
||||
<h2><a name="sectioning" id="sectioning">Sectioning</a></h2> |
||||
<div class="level2"> |
||||
|
||||
<p> |
||||
|
||||
You can use up to five different levels of headlines to structure your content. If you have more than three headlines, a table of contents is generated automatically – this can be disabled by including the string <code>~~NOTOC~~</code> in the document. |
||||
</p> |
||||
|
||||
</div> |
||||
<!-- SECTION "Sectioning" [5214-5500] --> |
||||
<h3><a name="headline_level_3" id="headline_level_3">Headline Level 3</a></h3> |
||||
<div class="level3"> |
||||
|
||||
</div> |
||||
|
||||
<h4><a name="headline_level_4" id="headline_level_4">Headline Level 4</a></h4> |
||||
<div class="level4"> |
||||
|
||||
</div> |
||||
|
||||
<h5><a name="headline_level_5" id="headline_level_5">Headline Level 5</a></h5> |
||||
<div class="level5"> |
||||
<pre class="code">==== Headline Level 3 ==== |
||||
=== Headline Level 4 === |
||||
== Headline Level 5 ==</pre> |
||||
|
||||
<p> |
||||
|
||||
By using four or more dashes, you can make a horizontal line: |
||||
|
||||
</p> |
||||
<hr /> |
||||
|
||||
</div> |
||||
<!-- SECTION "Headline Level 3" [5501-5727] --> |
||||
<h2><a name="images_and_other_files" id="images_and_other_files">Images and Other Files</a></h2> |
||||
<div class="level2"> |
||||
|
||||
<p> |
||||
|
||||
You can include external and internal <a href="http://www.dokuwiki.org/images" class="interwiki iw_doku" title="http://www.dokuwiki.org/images">images</a> with curly brackets. Optionally you can specify the size of them. |
||||
</p> |
||||
|
||||
<p> |
||||
Real size: <a href="/_detail/wiki/dokuwiki-128.png?id=wiki%3Asyntax" class="media" title="wiki:dokuwiki-128.png"><img src="../../media/wiki/dokuwiki-128.png" class="media" alt="" /></a> |
||||
</p> |
||||
|
||||
<p> |
||||
Resize to given width: <a href="/_detail/wiki/dokuwiki-128.png?id=wiki%3Asyntax" class="media" title="wiki:dokuwiki-128.png"><img src="../../media/wiki/dokuwiki-128.png" class="media" alt="" width="50" /></a> |
||||
</p> |
||||
|
||||
<p> |
||||
Resize to given width and height<sup><a href="#fn__2" name="fnt__2" id="fnt__2" class="fn_top">2)</a></sup>: <a href="/_detail/wiki/dokuwiki-128.png?id=wiki%3Asyntax" class="media" title="wiki:dokuwiki-128.png"><img src="../../media/wiki/dokuwiki-128.png" class="media" alt="" width="200" height="50" /></a> |
||||
</p> |
||||
|
||||
<p> |
||||
Resized external image: <a href="/lib/exe/fetch.php?hash=533a0c&media=http%3A%2F%2Fde3.php.net%2Fimages%2Fphp.gif" class="media" title="http://de3.php.net/images/php.gif"><img src="../../media/http///de3.php.net/images/php.gif" class="media" alt="" width="200" height="50" /></a> |
||||
|
||||
</p> |
||||
<pre class="code">Real size: {{wiki:dokuwiki-128.png}} |
||||
Resize to given width: {{wiki:dokuwiki-128.png?50}} |
||||
Resize to given width and height: {{wiki:dokuwiki-128.png?200x50}} |
||||
Resized external image: {{http://de3.php.net/images/php.gif?200x50}}</pre> |
||||
|
||||
<p> |
||||
By using left or right whitespaces you can choose the alignment. |
||||
</p> |
||||
|
||||
<p> |
||||
<a href="/_detail/wiki/dokuwiki-128.png?id=wiki%3Asyntax" class="media" title="wiki:dokuwiki-128.png"><img src="../../media/wiki/dokuwiki-128.png" class="mediaright" align="right" alt="" /></a> |
||||
</p> |
||||
|
||||
<p> |
||||
<a href="/_detail/wiki/dokuwiki-128.png?id=wiki%3Asyntax" class="media" title="wiki:dokuwiki-128.png"><img src="../../media/wiki/dokuwiki-128.png" class="medialeft" align="left" alt="" /></a> |
||||
</p> |
||||
|
||||
<p> |
||||
<a href="/_detail/wiki/dokuwiki-128.png?id=wiki%3Asyntax" class="media" title="wiki:dokuwiki-128.png"><img src="../../media/wiki/dokuwiki-128.png" class="mediacenter" alt="" /></a> |
||||
|
||||
</p> |
||||
<pre class="code">{{ wiki:dokuwiki-128.png}} |
||||
{{wiki:dokuwiki-128.png }} |
||||
{{ wiki:dokuwiki-128.png }}</pre> |
||||
|
||||
<p> |
||||
|
||||
Of course, you can add a title (displayed as a tooltip by most browsers), too. |
||||
</p> |
||||
|
||||
<p> |
||||
<a href="/_detail/wiki/dokuwiki-128.png?id=wiki%3Asyntax" class="media" title="wiki:dokuwiki-128.png"><img src="../../media/wiki/dokuwiki-128.png" class="mediacenter" title="This is the caption" alt="This is the caption" /></a> |
||||
|
||||
</p> |
||||
<pre class="code">{{ wiki:dokuwiki-128.png |This is the caption}}</pre> |
||||
|
||||
<p> |
||||
|
||||
If you specify a filename (external or internal) that is not an image (<code>gif, jpeg, png</code>), then it will be displayed as a link instead. |
||||
</p> |
||||
|
||||
<p> |
||||
For linking an image to another page see <a href="#image_links" title="wiki:syntax ↵" class="wikilink1">Image Links</a> above. |
||||
</p> |
||||
|
||||
</div> |
||||
<!-- SECTION "Images and Other Files" [5728-7200] --> |
||||
<h2><a name="lists" id="lists">Lists</a></h2> |
||||
<div class="level2"> |
||||
|
||||
<p> |
||||
|
||||
Dokuwiki supports ordered and unordered lists. To create a list item, indent your text by two spaces and use a <code>*</code> for unordered lists or a <code>-</code> for ordered ones. |
||||
|
||||
</p> |
||||
<ul> |
||||
<li class="level1"><div class="li"> This is a list</div> |
||||
</li> |
||||
<li class="level1"><div class="li"> The second item</div> |
||||
<ul> |
||||
<li class="level2"><div class="li"> You may have different levels</div> |
||||
</li> |
||||
</ul> |
||||
</li> |
||||
<li class="level1"><div class="li"> Another item</div> |
||||
</li> |
||||
</ul> |
||||
<ol> |
||||
<li class="level1"><div class="li"> The same list but ordered</div> |
||||
</li> |
||||
<li class="level1"><div class="li"> Another item</div> |
||||
<ol> |
||||
<li class="level2"><div class="li"> Just use indention for deeper levels</div> |
||||
</li> |
||||
</ol> |
||||
</li> |
||||
<li class="level1"><div class="li"> That's it</div> |
||||
</li> |
||||
</ol> |
||||
<pre class="code"> |
||||
* This is a list |
||||
* The second item |
||||
* You may have different levels |
||||
* Another item |
||||
|
||||
- The same list but ordered |
||||
- Another item |
||||
- Just use indention for deeper levels |
||||
- That's it |
||||
</pre> |
||||
|
||||
<p> |
||||
Also take a look at the <a href="http://www.dokuwiki.org/faq%3Alists" class="interwiki iw_doku" title="http://www.dokuwiki.org/faq%3Alists">FAQ on list items</a>. |
||||
</p> |
||||
|
||||
</div> |
||||
<!-- SECTION "Lists" [7201-7860] --> |
||||
<h2><a name="text_conversions" id="text_conversions">Text Conversions</a></h2> |
||||
<div class="level2"> |
||||
|
||||
<p> |
||||
|
||||
DokuWiki can convert certain pre-defined characters or strings into images or other text or <acronym title="HyperText Markup Language">HTML</acronym>. |
||||
</p> |
||||
|
||||
<p> |
||||
The text to image conversion is mainly done for smileys. And the text to <acronym title="HyperText Markup Language">HTML</acronym> conversion is used for typography replacements, but can be configured to use other <acronym title="HyperText Markup Language">HTML</acronym> as well. |
||||
</p> |
||||
|
||||
</div> |
||||
<!-- SECTION "Text Conversions" [7861-8165] --> |
||||
<h3><a name="text_to_image_conversions" id="text_to_image_conversions">Text to Image Conversions</a></h3> |
||||
<div class="level3"> |
||||
|
||||
<p> |
||||
|
||||
DokuWiki converts commonly used <a href="http://en.wikipedia.org/wiki/emoticon" class="interwiki iw_wp" title="http://en.wikipedia.org/wiki/emoticon">emoticon</a>s to their graphical equivalents. Those <a href="http://www.dokuwiki.org/Smileys" class="interwiki iw_doku" title="http://www.dokuwiki.org/Smileys">Smileys</a> and other images can be configured and extended. Here is an overview of Smileys included in DokuWiki: |
||||
|
||||
</p> |
||||
<ul> |
||||
<li class="level1"><div class="li"> <img src="/lib/images/smileys/icon_cool.gif" class="middle" alt="8-)" /> 8-) </div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <img src="/lib/images/smileys/icon_eek.gif" class="middle" alt="8-O" /> 8-O </div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <img src="/lib/images/smileys/icon_sad.gif" class="middle" alt=":-(" /> :-( </div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <img src="/lib/images/smileys/icon_smile.gif" class="middle" alt=":-)" /> :-) </div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <img src="/lib/images/smileys/icon_smile2.gif" class="middle" alt="=)" /> =) </div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <img src="/lib/images/smileys/icon_doubt.gif" class="middle" alt=":-/" /> :-/ </div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <img src="/lib/images/smileys/icon_doubt2.gif" class="middle" alt=":-\" /> :-\ </div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <img src="/lib/images/smileys/icon_confused.gif" class="middle" alt=":-?" /> :-? </div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <img src="/lib/images/smileys/icon_biggrin.gif" class="middle" alt=":-D" /> :-D </div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <img src="/lib/images/smileys/icon_razz.gif" class="middle" alt=":-P" /> :-P </div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <img src="/lib/images/smileys/icon_surprised.gif" class="middle" alt=":-O" /> :-O </div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <img src="/lib/images/smileys/icon_silenced.gif" class="middle" alt=":-X" /> :-X </div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <img src="/lib/images/smileys/icon_neutral.gif" class="middle" alt=":-|" /> :-| </div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <img src="/lib/images/smileys/icon_wink.gif" class="middle" alt=";-)" /> ;-) </div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <img src="/lib/images/smileys/icon_fun.gif" class="middle" alt="^_^" /> ^_^ </div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <img src="/lib/images/smileys/icon_question.gif" class="middle" alt=":?:" /> :?: </div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <img src="/lib/images/smileys/icon_exclaim.gif" class="middle" alt=":!:" /> :!: </div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <img src="/lib/images/smileys/icon_lol.gif" class="middle" alt="LOL" /> LOL </div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <img src="/lib/images/smileys/fixme.gif" class="middle" alt="FIXME" /> FIXME </div> |
||||
</li> |
||||
<li class="level1"><div class="li"> <img src="/lib/images/smileys/delete.gif" class="middle" alt="DELETEME" /> DELETEME </div> |
||||
</li> |
||||
</ul> |
||||
|
||||
</div> |
||||
<!-- SECTION "Text to Image Conversions" [8166-8821] --> |
||||
<h3><a name="text_to_html_conversions" id="text_to_html_conversions">Text to HTML Conversions</a></h3> |
||||
<div class="level3"> |
||||
|
||||
<p> |
||||
|
||||
Typography: <a href="../wiki/dokuwiki.html" class="wikilink1" title="wiki:dokuwiki">DokuWiki</a> can convert simple text characters to their typographically correct entities. Here is an example of recognized characters. |
||||
</p> |
||||
|
||||
<p> |
||||
→ ← ↔ ⇒ ⇐ ⇔ » « – — 640×480 © ™ ® |
||||
“He thought 'It's a man's world'…” |
||||
</p> |
||||
<pre class="code"> |
||||
-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) |
||||
"He thought 'It's a man's world'..." |
||||
</pre> |
||||
|
||||
<p> |
||||
The same can be done to produce any kind of <acronym title="HyperText Markup Language">HTML</acronym>, it just needs to be added to the <a href="http://www.dokuwiki.org/entities" class="interwiki iw_doku" title="http://www.dokuwiki.org/entities">pattern file</a>. |
||||
</p> |
||||
|
||||
<p> |
||||
There are three exceptions which do not come from that pattern file: multiplication entity (640×480), 'single' and “double quotes”. They can be turned off through a <a href="http://www.dokuwiki.org/config%3Atypography" class="interwiki iw_doku" title="http://www.dokuwiki.org/config%3Atypography">config option</a>. |
||||
</p> |
||||
|
||||
</div> |
||||
<!-- SECTION "Text to HTML Conversions" [8822-9529] --> |
||||
<h2><a name="quoting" id="quoting">Quoting</a></h2> |
||||
<div class="level2"> |
||||
|
||||
<p> |
||||
|
||||
Some times you want to mark some text to show it's a reply or comment. You can use the following syntax: |
||||
|
||||
</p> |
||||
<pre class="code">I think we should do it |
||||
|
||||
> No we shouldn't |
||||
|
||||
>> Well, I say we should |
||||
|
||||
> Really? |
||||
|
||||
>> Yes! |
||||
|
||||
>>> Then lets do it!</pre> |
||||
|
||||
<p> |
||||
|
||||
I think we should do it |
||||
|
||||
</p> |
||||
<blockquote><div class="no"> |
||||
No we shouldn't</div></blockquote> |
||||
<blockquote><div class="no"> |
||||
<blockquote><div class="no"> |
||||
Well, I say we should</div></blockquote> |
||||
</div></blockquote> |
||||
<blockquote><div class="no"> |
||||
Really?</div></blockquote> |
||||
<blockquote><div class="no"> |
||||
<blockquote><div class="no"> |
||||
Yes!</div></blockquote> |
||||
</div></blockquote> |
||||
<blockquote><div class="no"> |
||||
<blockquote><div class="no"> |
||||
<blockquote><div class="no"> |
||||
Then lets do it!</div></blockquote> |
||||
</div></blockquote> |
||||
</div></blockquote> |
||||
|
||||
</div> |
||||
<!-- SECTION "Quoting" [9530-9902] --> |
||||
<h2><a name="tables" id="tables">Tables</a></h2> |
||||
<div class="level2"> |
||||
|
||||
<p> |
||||
|
||||
DokuWiki supports a simple syntax to create tables. |
||||
|
||||
</p> |
||||
<table class="inline"> |
||||
<tr class="row0 roweven"> |
||||
<th class="col0 leftalign"> Heading 1 </th><th class="col1 leftalign"> Heading 2 </th><th class="col2 leftalign"> Heading 3 </th> |
||||
</tr> |
||||
<tr class="row1 rowodd"> |
||||
<td class="col0 leftalign"> Row 1 Col 1 </td><td class="col1 leftalign"> Row 1 Col 2 </td><td class="col2 leftalign"> Row 1 Col 3 </td> |
||||
</tr> |
||||
<tr class="row2 roweven"> |
||||
<td class="col0 leftalign"> Row 2 Col 1 </td><td class="col1" colspan="2"> some colspan (note the double pipe) </td> |
||||
</tr> |
||||
<tr class="row3 rowodd"> |
||||
<td class="col0 leftalign"> Row 3 Col 1 </td><td class="col1 leftalign"> Row 3 Col 2 </td><td class="col2 leftalign"> Row 3 Col 3 </td> |
||||
</tr> |
||||
</table> |
||||
|
||||
<p> |
||||
|
||||
Table rows have to start and end with a <code>|</code> for normal rows or a <code>^</code> for headers. |
||||
|
||||
</p> |
||||
<pre class="code">^ Heading 1 ^ Heading 2 ^ Heading 3 ^ |
||||
| Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 | |
||||
| Row 2 Col 1 | some colspan (note the double pipe) || |
||||
| Row 3 Col 1 | Row 3 Col 2 | Row 3 Col 3 |</pre> |
||||
|
||||
<p> |
||||
|
||||
To connect cells horizontally, just make the next cell completely empty as shown above. Be sure to have always the same amount of cell separators! |
||||
</p> |
||||
|
||||
<p> |
||||
Vertical tableheaders are possible, too. |
||||
|
||||
</p> |
||||
<table class="inline"> |
||||
<tr class="row0 roweven"> |
||||
<td class="col0 leftalign"> </td><th class="col1 leftalign"> Heading 1 </th><th class="col2 leftalign"> Heading 2 </th> |
||||
</tr> |
||||
<tr class="row1 rowodd"> |
||||
<th class="col0 leftalign"> Heading 3 </th><td class="col1 leftalign"> Row 1 Col 2 </td><td class="col2 leftalign"> Row 1 Col 3 </td> |
||||
</tr> |
||||
<tr class="row2 roweven"> |
||||
<th class="col0 leftalign"> Heading 4 </th><td class="col1"> no colspan this time </td><td class="col2 leftalign"> </td> |
||||
</tr> |
||||
<tr class="row3 rowodd"> |
||||
<th class="col0 leftalign"> Heading 5 </th><td class="col1 leftalign"> Row 2 Col 2 </td><td class="col2 leftalign"> Row 2 Col 3 </td> |
||||
</tr> |
||||
</table> |
||||
|
||||
<p> |
||||
|
||||
As you can see, it's the cell separator before a cell which decides about the formatting: |
||||
|
||||
</p> |
||||
<pre class="code">| ^ Heading 1 ^ Heading 2 ^ |
||||
^ Heading 3 | Row 1 Col 2 | Row 1 Col 3 | |
||||
^ Heading 4 | no colspan this time | | |
||||
^ Heading 5 | Row 2 Col 2 | Row 2 Col 3 |</pre> |
||||
|
||||
<p> |
||||
|
||||
You can have rowspans (vertically connected cells) by adding <code>:::</code> into the cells below the one to which they should connect. |
||||
|
||||
</p> |
||||
<table class="inline"> |
||||
<tr class="row0 roweven"> |
||||
<th class="col0 leftalign"> Heading 1 </th><th class="col1 leftalign"> Heading 2 </th><th class="col2 leftalign"> Heading 3 </th> |
||||
</tr> |
||||
<tr class="row1 rowodd"> |
||||
<td class="col0 leftalign"> Row 1 Col 1 </td><td class="col1" rowspan="3"> this cell spans vertically </td><td class="col2 leftalign"> Row 1 Col 3 </td> |
||||
</tr> |
||||
<tr class="row2 roweven"> |
||||
<td class="col0 leftalign"> Row 2 Col 1 </td><td class="col1 leftalign"> Row 2 Col 3 </td> |
||||
</tr> |
||||
<tr class="row3 rowodd"> |
||||
<td class="col0 leftalign"> Row 3 Col 1 </td><td class="col1 leftalign"> Row 2 Col 3 </td> |
||||
</tr> |
||||
</table> |
||||
|
||||
<p> |
||||
|
||||
Apart from the rowspan syntax those cells should not contain anything else. |
||||
|
||||
</p> |
||||
<pre class="code">^ Heading 1 ^ Heading 2 ^ Heading 3 ^ |
||||
| Row 1 Col 1 | this cell spans vertically | Row 1 Col 3 | |
||||
| Row 2 Col 1 | ::: | Row 2 Col 3 | |
||||
| Row 3 Col 1 | ::: | Row 2 Col 3 |</pre> |
||||
|
||||
<p> |
||||
|
||||
You can align the table contents, too. Just add at least two whitespaces at the opposite end of your text: Add two spaces on the left to align right, two spaces on the right to align left and two spaces at least at both ends for centered text. |
||||
|
||||
</p> |
||||
<table class="inline"> |
||||
<tr class="row0 roweven"> |
||||
<th class="col0 centeralign" colspan="3"> Table with alignment </th> |
||||
</tr> |
||||
<tr class="row1 rowodd"> |
||||
<td class="col0 rightalign"> right</td><td class="col1 centeralign"> center </td><td class="col2 leftalign">left </td> |
||||
</tr> |
||||
<tr class="row2 roweven"> |
||||
<td class="col0 leftalign">left </td><td class="col1 rightalign"> right</td><td class="col2 centeralign"> center </td> |
||||
</tr> |
||||
<tr class="row3 rowodd"> |
||||
<td class="col0"> xxxxxxxxxxxx </td><td class="col1"> xxxxxxxxxxxx </td><td class="col2"> xxxxxxxxxxxx </td> |
||||
</tr> |
||||
</table> |
||||
|
||||
<p> |
||||
|
||||
This is how it looks in the source: |
||||
|
||||
</p> |
||||
<pre class="code">^ Table with alignment ^^^ |
||||
| right| center |left | |
||||
|left | right| center | |
||||
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |</pre> |
||||
|
||||
<p> |
||||
|
||||
Note: Vertical alignment is not supported. |
||||
</p> |
||||
|
||||
</div> |
||||
<!-- SECTION "Tables" [9903-12795] --> |
||||
<h2><a name="no_formatting" id="no_formatting">No Formatting</a></h2> |
||||
<div class="level2"> |
||||
|
||||
<p> |
||||
|
||||
If you need to display text exactly like it is typed (without any formatting), enclose the area either with <code><nowiki></code> tags or even simpler, with double percent signs <code>%%</code>. |
||||
</p> |
||||
|
||||
<p> |
||||
|
||||
This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it. |
||||
|
||||
The same is true for //__this__ text// with a smiley ;-). |
||||
|
||||
</p> |
||||
<pre class="code"><nowiki> |
||||
This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it. |
||||
</nowiki> |
||||
The same is true for %%//__this__ text// with a smiley ;-)%%.</pre> |
||||
|
||||
</div> |
||||
<!-- SECTION "No Formatting" [12796-13451] --> |
||||
<h2><a name="code_blocks" id="code_blocks">Code Blocks</a></h2> |
||||
<div class="level2"> |
||||
|
||||
<p> |
||||
|
||||
You can include code blocks into your documents by either indenting them by at least two spaces (like used for the previous examples) or by using the tags <code><code></code> or <code><file></code>. |
||||
|
||||
</p> |
||||
<pre class="code">This is text is indented by two spaces.</pre> |
||||
<pre class="code"> |
||||
This is preformatted code all spaces are preserved: like <-this |
||||
</pre> |
||||
<pre class="file"> |
||||
This is pretty much the same, but you could use it to show that you quoted a file. |
||||
</pre> |
||||
|
||||
<p> |
||||
Those blocks were created by this source: |
||||
|
||||
</p> |
||||
<pre class="code"> This is text is indented by two spaces.</pre> |
||||
<pre class="code"><code> |
||||
This is preformatted code all spaces are preserved: like <-this |
||||
</code></pre> |
||||
<pre class="code"><file> |
||||
This is pretty much the same, but you could use it to show that you quoted a file. |
||||
</file></pre> |
||||
|
||||
</div> |
||||
<!-- SECTION "Code Blocks" [13452-14193] --> |
||||
<h3><a name="syntax_highlighting" id="syntax_highlighting">Syntax Highlighting</a></h3> |
||||
<div class="level3"> |
||||
|
||||
<p> |
||||
|
||||
<a href="../wiki/dokuwiki.html" class="wikilink1" title="wiki:dokuwiki">DokuWiki</a> can highlight sourcecode, which makes it easier to read. It uses the <a href="http://qbnz.com/highlighter/" class="urlextern" title="http://qbnz.com/highlighter/" rel="nofollow">GeSHi</a> Generic Syntax Highlighter – so any language supported by GeSHi is supported. The syntax is the same like in the code and file blocks in the previous section, but this time the name of the used language is inserted inside the tag. Eg. <code><code java></code> or <code><file java></code>. |
||||
</p> |
||||
<pre class="code java"><span class="co3">/** |
||||
* The HelloWorldApp class implements an application that |
||||
* simply displays "Hello World!" to the standard output. |
||||
*/</span> |
||||
<span class="kw1">class</span> HelloWorldApp <span class="br0">{</span> |
||||
<span class="kw1">public</span> <span class="kw1">static</span> <span class="kw4">void</span> main<span class="br0">(</span><a href="http://www.google.com/search?hl=en&q=allinurl%3Astring+java.sun.com&btnI=I%27m%20Feeling%20Lucky"><span class="kw3">String</span></a><span class="br0">[</span><span class="br0">]</span> args<span class="br0">)</span> <span class="br0">{</span> |
||||
<a href="http://www.google.com/search?hl=en&q=allinurl%3Asystem+java.sun.com&btnI=I%27m%20Feeling%20Lucky"><span class="kw3">System</span></a>.<span class="me1">out</span>.<span class="me1">println</span><span class="br0">(</span><span class="st0">"Hello World!"</span><span class="br0">)</span><span class="sy0">;</span> <span class="co1">//Display the string.</span> |
||||
<span class="br0">}</span> |
||||
<span class="br0">}</span></pre> |
||||
|
||||
<p> |
||||
The following language strings are currently recognized: <em>abap, actionscript-french, actionscript, actionscript3, ada, apache, applescript, asm, asp, autoit, avisynth, bash, basic4gl, bf, bibtex, blitzbasic, bnf, boo, c, c_mac, caddcl, cadlisp, cfdg, cfm, cil, cmake, cobol, cpp, cpp-qt, csharp, css, d, dcs, delphi, diff, div, dos, dot, eiffel, email, erlang, fo, fortran, freebasic, genero, glsl, gml, gnuplot, groovy, gettext, haskell, hq9plus, html, idl, ini, inno, intercal, io, java5, java, javascript, kixtart, klonec, klonecpp, latex, lisp, locobasic, lolcode, lotusformulas, lotusscript, lscript, lsl2, lua, m68k, make, matlab, mirc, modula3, mpasm, mxml, mysql, nsis, oberon2, objc, ocaml-brief, ocaml, oobas, oracle8, oracle11, pascal, perl, per, php-brief, php, pic16, pixelbender, plsql, povray, powershell, progress, prolog, properties, providex, python, qbasic, rails, rebol, reg, robots, ruby, sas, scala, scheme, scilab, sdlbasic, smalltalk, smarty, sql, tcl, teraterm, text, thinbasic, tsql, typoscript, vbnet, vb, verilog, vhdl, vim, visualfoxpro, visualprolog, whitespace, winbatch, whois, xml, xorg_conf, xpp, z80</em> |
||||
</p> |
||||
|
||||
</div> |
||||
<!-- SECTION "Syntax Highlighting" [14194-16082] --> |
||||
<h3><a name="downloadable_code_blocks" id="downloadable_code_blocks">Downloadable Code Blocks</a></h3> |
||||
<div class="level3"> |
||||
|
||||
<p> |
||||
|
||||
When you use the <code><code></code> or <code><file></code> syntax as above, you might want to make the shown code available for download as well. You can to this by specifying a file name after language code like this: |
||||
</p> |
||||
<pre class="code"> |
||||
<file php myexample.php> |
||||
<?php echo "hello world!"; ?> |
||||
</file> |
||||
</pre> |
||||
<dl class="file"> |
||||
<dt><a href="/_export/code/wiki/syntax?codeblock=6" title="Download Snippet" class="mediafile mf_php">myexample.php</a></dt> |
||||
<dd><pre class="code file php"><span class="kw2"><?php</span> <span class="kw1">echo</span> <span class="st0">"hello world!"</span><span class="sy0">;</span> <span class="sy1">?></span></pre> |
||||
</dd></dl> |
||||
|
||||
<p> |
||||
If you don't want any highlighting but want a downloadable file, specify a dash (<code>-</code>) as the language code: <code><code - myfile.foo></code>. |
||||
</p> |
||||
|
||||
</div> |
||||
<!-- SECTION "Downloadable Code Blocks" [16083-16613] --> |
||||
<h2><a name="embedding_html_and_php" id="embedding_html_and_php">Embedding HTML and PHP</a></h2> |
||||
<div class="level2"> |
||||
|
||||
<p> |
||||
|
||||
You can embed raw <acronym title="HyperText Markup Language">HTML</acronym> or <acronym title="Hypertext Preprocessor">PHP</acronym> code into your documents by using the <code><html></code> or <code><php></code> tags. (Use uppercase tags if you need to enclose block level elements.) |
||||
</p> |
||||
|
||||
<p> |
||||
<acronym title="HyperText Markup Language">HTML</acronym> example: |
||||
</p> |
||||
<pre class="code"> |
||||
<html> |
||||
This is some <span style="color:red;font-size:150%;">inline HTML</span> |
||||
</html> |
||||
<HTML> |
||||
<p style="border:2px dashed red;">And this is some block HTML</p> |
||||
</HTML> |
||||
</pre> |
||||
|
||||
<p> |
||||
|
||||
This is some <span style="color:red;font-size:150%;">inline HTML</span> |
||||
|
||||
|
||||
</p> |
||||
|
||||
<p style="border:2px dashed red;">And this is some block HTML</p> |
||||
|
||||
<p> |
||||
<acronym title="Hypertext Preprocessor">PHP</acronym> example: |
||||
</p> |
||||
<pre class="code"> |
||||
<php> |
||||
echo 'A logo generated by PHP:'; |
||||
echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />'; |
||||
echo '(generated inline HTML)'; |
||||
</php> |
||||
<PHP> |
||||
echo '<table class="inline"><tr><td>The same, but inside a block level element:</td>'; |
||||
echo '<td><img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" /></td>'; |
||||
echo '</tr></table>'; |
||||
</PHP> |
||||
</pre> |
||||
|
||||
<p> |
||||
<code class="code php"><span class="kw1">echo</span> <span class="st_h">'A logo generated by PHP:'</span><span class="sy0">;</span> |
||||
<span class="kw1">echo</span> <span class="st_h">'<img src="'</span> <span class="sy0">.</span> <span class="re0">$_SERVER</span><span class="br0">[</span><span class="st_h">'PHP_SELF'</span><span class="br0">]</span> <span class="sy0">.</span> <span class="st_h">'?='</span> <span class="sy0">.</span> <a href="http://www.php.net/php_logo_guid"><span class="kw3">php_logo_guid</span></a><span class="br0">(</span><span class="br0">)</span> <span class="sy0">.</span> <span class="st_h">'" alt="PHP Logo !" />'</span><span class="sy0">;</span> |
||||
<span class="kw1">echo</span> <span class="st_h">'(inline HTML)'</span><span class="sy0">;</span></code> |
||||
|
||||
</p> |
||||
<pre class="code php"><span class="kw1">echo</span> <span class="st_h">'<table class="inline"><tr><td>The same, but inside a block level element:</td>'</span><span class="sy0">;</span> |
||||
<span class="kw1">echo</span> <span class="st_h">'<td><img src="'</span> <span class="sy0">.</span> <span class="re0">$_SERVER</span><span class="br0">[</span><span class="st_h">'PHP_SELF'</span><span class="br0">]</span> <span class="sy0">.</span> <span class="st_h">'?='</span> <span class="sy0">.</span> <a href="http://www.php.net/php_logo_guid"><span class="kw3">php_logo_guid</span></a><span class="br0">(</span><span class="br0">)</span> <span class="sy0">.</span> <span class="st_h">'" alt="PHP Logo !" /></td>'</span><span class="sy0">;</span> |
||||
<span class="kw1">echo</span> <span class="st_h">'</tr></table>'</span><span class="sy0">;</span></pre> |
||||
<p> |
||||
<strong>Please Note</strong>: <acronym title="HyperText Markup Language">HTML</acronym> and <acronym title="Hypertext Preprocessor">PHP</acronym> embedding is disabled by default in the configuration. If disabled, the code is displayed instead of executed. |
||||
</p> |
||||
|
||||
</div> |
||||
<!-- SECTION "Embedding HTML and PHP" [16614-18143] --> |
||||
<h2><a name="rssatom_feed_aggregation" id="rssatom_feed_aggregation">RSS/ATOM Feed Aggregation</a></h2> |
||||
<div class="level2"> |
||||
|
||||
<p> |
||||
<a href="../wiki/dokuwiki.html" class="wikilink1" title="wiki:dokuwiki">DokuWiki</a> can integrate data from external <acronym title="Extensible Markup Language">XML</acronym> feeds. For parsing the <acronym title="Extensible Markup Language">XML</acronym> feeds, <a href="http://simplepie.org/" class="urlextern" title="http://simplepie.org/" rel="nofollow">SimplePie</a> 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: |
||||
|
||||
</p> |
||||
<table class="inline"> |
||||
<tr class="row0 roweven"> |
||||
<th class="col0 leftalign"> Parameter </th><th class="col1"> Description </th> |
||||
</tr> |
||||
<tr class="row1 rowodd"> |
||||
<td class="col0"> any number </td><td class="col1"> will be used as maximum number items to show, defaults to 8 </td> |
||||
</tr> |
||||
<tr class="row2 roweven"> |
||||
<td class="col0 leftalign"> reverse </td><td class="col1"> display the last items in the feed first </td> |
||||
</tr> |
||||
<tr class="row3 rowodd"> |
||||
<td class="col0 leftalign"> author </td><td class="col1"> show item authors names </td> |
||||
</tr> |
||||
<tr class="row4 roweven"> |
||||
<td class="col0 leftalign"> date </td><td class="col1"> show item dates </td> |
||||
</tr> |
||||
<tr class="row5 rowodd"> |
||||
<td class="col0"> description</td><td class="col1"> show the item description. If <a href="http://www.dokuwiki.org/config%3Ahtmlok" class="interwiki iw_doku" title="http://www.dokuwiki.org/config%3Ahtmlok">HTML</a> is disabled all tags will be stripped </td> |
||||
</tr> |
||||
<tr class="row6 roweven"> |
||||
<td class="col0"> <em>n</em>[dhm] </td><td class="col1"> refresh period, where d=days, h=hours, m=minutes. (e.g. 12h = 12 hours). </td> |
||||
</tr> |
||||
</table> |
||||
|
||||
<p> |
||||
|
||||
The refresh period defaults to 4 hours. Any value below 10 minutes will be treated as 10 minutes. <a href="../wiki/dokuwiki.html" class="wikilink1" title="wiki:dokuwiki">DokuWiki</a> 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 <a href="../wiki/dokuwiki.html" class="wikilink1" title="wiki:dokuwiki">DokuWiki</a> to re-render the page if it is more than <em>refresh period</em> since the page was last rendered. |
||||
</p> |
||||
|
||||
<p> |
||||
<strong>Example:</strong> |
||||
|
||||
</p> |
||||
<pre class="code">{{rss>http://slashdot.org/index.rss 5 author date 1h }}</pre> |
||||
<ul class="rss"><li><div class="li"><a href="http://rss.slashdot.org/~r/Slashdot/slashdot/~3/pSB08blM77o/story01.htm" class="urlextern" title="http://rss.slashdot.org/~r/Slashdot/slashdot/~3/pSB08blM77o/story01.htm" rel="nofollow">BSG Prequel Series Caprica Canceled</a> by CmdrTaco (2010/10/28 16:12)</div></li><li><div class="li"><a href="http://rss.slashdot.org/~r/Slashdot/slashdot/~3/fEirfapdDeE/story01.htm" class="urlextern" title="http://rss.slashdot.org/~r/Slashdot/slashdot/~3/fEirfapdDeE/story01.htm" rel="nofollow">FarmVille Now Worth More Than EA</a> by CmdrTaco (2010/10/28 15:36)</div></li><li><div class="li"><a href="http://rss.slashdot.org/~r/Slashdot/slashdot/~3/fGpsppAeaIQ/story01.htm" class="urlextern" title="http://rss.slashdot.org/~r/Slashdot/slashdot/~3/fGpsppAeaIQ/story01.htm" rel="nofollow">China Makes World's Fastest Supercomputer</a> by CmdrTaco (2010/10/28 14:40)</div></li><li><div class="li"><a href="http://rss.slashdot.org/~r/Slashdot/slashdot/~3/5GLUY0y2u_g/story01.htm" class="urlextern" title="http://rss.slashdot.org/~r/Slashdot/slashdot/~3/5GLUY0y2u_g/story01.htm" rel="nofollow">British Airways Chief Slams US Security Requests</a> by samzenpus (2010/10/28 14:23)</div></li><li><div class="li"><a href="http://rss.slashdot.org/~r/Slashdot/slashdot/~3/JZWrJEgVkfA/story01.htm" class="urlextern" title="http://rss.slashdot.org/~r/Slashdot/slashdot/~3/JZWrJEgVkfA/story01.htm" rel="nofollow">Aussie Kids Foil Finger Scanner With Gummi Bears</a> by samzenpus (2010/10/28 14:13)</div></li></ul> |
||||
</div> |
||||
<!-- SECTION "RSS/ATOM Feed Aggregation" [18144-19423] --> |
||||
<h2><a name="control_macros" id="control_macros">Control Macros</a></h2> |
||||
<div class="level2"> |
||||
|
||||
<p> |
||||
|
||||
Some syntax influences how DokuWiki renders a page without creating any output it self. The following control macros are availble: |
||||
|
||||
</p> |
||||
<table class="inline"> |
||||
<tr class="row0 roweven"> |
||||
<th class="col0 leftalign"> Macro </th><th class="col1"> Description </th> |
||||
</tr> |
||||
<tr class="row1 rowodd"> |
||||
<td class="col0 leftalign"> ~~NOTOC~~ </td><td class="col1"> If this macro is found on the page, no table of contents will be created </td> |
||||
</tr> |
||||
<tr class="row2 roweven"> |
||||
<td class="col0"> ~~NOCACHE~~ </td><td class="col1"> DokuWiki caches all output by default. Sometimes this might not be wanted (eg. when the <php> syntax above is used), adding this macro will force DokuWiki to rerender a page on every call </td> |
||||
</tr> |
||||
</table> |
||||
|
||||
</div> |
||||
<!-- SECTION "Control Macros" [19424-19927] --> |
||||
<h2><a name="syntax_plugins" id="syntax_plugins">Syntax Plugins</a></h2> |
||||
<div class="level2"> |
||||
|
||||
<p> |
||||
|
||||
DokuWiki's syntax can be extended by <a href="http://www.dokuwiki.org/plugins" class="interwiki iw_doku" title="http://www.dokuwiki.org/plugins">Plugins</a>. How the installed plugins are used is described on their appropriate description pages. The following syntax plugins are available in this particular DokuWiki installation: |
||||
</p> |
||||
<ul><li><div class="li"><a href="http://dokuwiki.org/plugin:info" class="urlextern" title="http://dokuwiki.org/plugin:info" rel="nofollow">Info Plugin</a> <em>2008-09-12</em> by <a href="mailto:andi@splitbrain.org" class="mail JSnocheck" title="andi@splitbrain.org">Andreas Gohr</a><br />Displays information about various DokuWiki internals</div></li><li><div class="li"><a href="http://www.dokuwiki.org/plugin:gallery" class="urlextern" title="http://www.dokuwiki.org/plugin:gallery" rel="nofollow">Gallery Plugin</a> <em>2010-04-30</em> by <a href="mailto:andi@splitbrain.org" class="mail JSnocheck" title="andi@splitbrain.org">Andreas Gohr</a><br />Creates a gallery of images from a namespace or RSS/ATOM feed</div></li><li><div class="li"><a href="http://www.dokuwiki.org/plugin:note" class="urlextern" title="http://www.dokuwiki.org/plugin:note" rel="nofollow">Note Plugin</a> <em>2009-06-15</em> by <a href="mailto:olive@deep-ocean.net" class="mail JSnocheck" title="olive@deep-ocean.net">Olivier Cortès / Eric Hameleers / Christopher Smith / Aurélien Bompard</a><br />Add Note/Important/Tip/Warning Capability (DIV+CSS box)</div></li><li><div class="li"><a href="http://www.graw.eu/dokuwiki/" class="urlextern" title="http://www.graw.eu/dokuwiki/" rel="nofollow">Offline Version Plugin</a> <em>2009-02-09</em> by <a href="mailto:dokuwiki@graw.eu" class="mail JSnocheck" title="dokuwiki@graw.eu">Carsten Graw</a><br />Create a static version that is offline browseable</div></li><li><div class="li"><a href="http://www.dokuwiki.org/plugin:sortablejs" class="urlextern" title="http://www.dokuwiki.org/plugin:sortablejs" rel="nofollow">Sortable javascript</a> <em>2009-08-24</em> by <a href="mailto:plugins@valjakko.net" class="mail JSnocheck" title="plugins@valjakko.net">Otto Vainio</a><br />Add <sortable> and </sortable> around your table.</div></li></ul> |
||||
</div> |
||||
<!-- SECTION "Syntax Plugins" [19928-] --><div class="footnotes"> |
||||
<div class="fn"><sup><a href="#fnt__1" id="fn__1" name="fn__1" class="fn_bot">1)</a></sup> |
||||
This is a footnote</div> |
||||
<div class="fn"><sup><a href="#fnt__2" id="fn__2" name="fn__2" class="fn_bot">2)</a></sup> |
||||
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</div> |
||||
</div> |
||||
</div><!-- closes <div class="dokuwiki export">--> |
||||
Loading…
Reference in new issue