DokuWiki

It's better when it's simple

User Tools

Site Tools

Trace:
plugin:tip

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
plugin:tip [2010-10-03 16:02] – [Tip Syntax PlugIn] HåkanSplugin:tip [2018-08-02 08:23] (current) – Aleksandr
Line 2: Line 2:
  
 ---- plugin ---- ---- plugin ----
-description: Use small notes/hints.+description: Use small notes/hints
 author     : Matthias Watermann author     : Matthias Watermann
 email      : support@mwat.de email      : support@mwat.de
Line 10: Line 10:
 depends    : depends    :
 conflicts  : conflicts  :
-similar    : note+similar    : note, wrap
 tags       : boxes tags       : boxes
  
Line 31: Line 31:
  
 The easiest use of a "''tip''" box is just The easiest use of a "''tip''" box is just
- <tip> some text </tip>+ 
 +  <tip> some text </tip>
  
 This will place (by means of [[#presentation|CSS rules]]) "''some text''" on the page's right side. This will place (by means of [[#presentation|CSS rules]]) "''some text''" on the page's right side.
Line 37: Line 38:
 So what about the "ten different arguments" mentioned above? Here they come: So what about the "ten different arguments" mentioned above? Here they come:
  
- * //Orientation//: "''centered''", "''left''", "''right''" (the default); +  * //Orientation//: "''centered''", "''left''", "''right''" (the default); 
- * //Position//: "''up''", "''down''" and "''even''" (the default); +  * //Position//: "''up''", "''down''" and "''even''" (the default); 
- * //Type//: "''hint''", "''info''", "''note''", "''warning''", (default: none).+  * //Type//: "''hint''", "''info''", "''note''", "''warning''", (default: none).
  
 In other words: Each "''tag''" element has -- beside its contents -- three "pro­per­ties": a //position//, a //type// and an //orientation//. In other words: Each "''tag''" element has -- beside its contents -- three "pro­per­ties": a //position//, a //type// and an //orientation//.
Line 47: Line 48:
 Just for the records, here's a list of all possible com­bi­na­tions (using one-letter shortcuts): Just for the records, here's a list of all possible com­bi­na­tions (using one-letter shortcuts):
  
- * //centered:// "''c''", "''c d''", "''c d h''", "''c d i''", "''c d n''", "''c d w''", "''c e''", "''c e h''", "''c e i''", "''c e n''", "''c e w''", "''c u''", "''c u h''", "''c u i''", "''c u n''", "''c u w''", +  * //centered:// "''c''", "''c d''", "''c d h''", "''c d i''", "''c d n''", "''c d w''", "''c e''", "''c e h''", "''c e i''", "''c e n''", "''c e w''", "''c u''", "''c u h''", "''c u i''", "''c u n''", "''c u w''", 
- * //left aligned:// "''l''", "''l d''", "''l d h''", "''l d i''", "''l d n''", "''l d w''", "''l e''", "''l e h''", "''l e i''", "''l e n''", "''l e w''", "''l u''", "''l u h''", "''l u i''", "''l u n''", "''l u w''", +  * //left aligned:// "''l''", "''l d''", "''l d h''", "''l d i''", "''l d n''", "''l d w''", "''l e''", "''l e h''", "''l e i''", "''l e n''", "''l e w''", "''l u''", "''l u h''", "''l u i''", "''l u n''", "''l u w''", 
- * //right aligned:// "''r''", "''r d''", "''r d h''", "''r d i''", "''r d n''", "''r d w''", "''r e''", "''r e h''", "''r e i''", "''r e n''", "''r e w''", "''r u''", "''r u h''", "''r u i''", "''r u n''", "''r u w''"+  * //right aligned:// "''r''", "''r d''", "''r d h''", "''r d i''", "''r d n''", "''r d w''", "''r e''", "''r e h''", "''r e i''", "''r e n''", "''r e w''", "''r u''", "''r u h''", "''r u i''", "''r u n''", "''r u w''"
  
 Please note, however, that the order of the respective arguments doesn't mat­ter. Please note, however, that the order of the respective arguments doesn't mat­ter.
Line 165: Line 166:
  
 ===== Installation ===== ===== Installation =====
-It's quite easy to integrate this plugin with your DokuWiki: +Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
- +
- - Download the [[http://dev.mwat.de/dw/syntax_plugin_tip.zip|source archive]] (~8KB) and un­pack it in your Doku­Wiki plug­in di­rec­to­ry ''{dokuwiki}/lib/plugins'' (make sure, in­clu­ded sub­di­rec­to­ries are un­packed cor­rect­ly); this will create the di­rec­to­ries\\ ''{dokuwiki}/lib/plugins/tip'' and\\ ''{dokuwiki}/lib/plugins/tip/images''. +
- - Make sure both the new direc­tory and the files therein are read­able by the web-server e.g.<code> +
- chown apache:apache dokuwiki/lib/plugins/* -Rc +
-</code>+
  
-You might as well use the [[http://www.dokuwiki.org/plugin:plugin|plugin manager]] for installing or updating this plugin.+  * http://dev.mwat.de/dw/syntax_plugin_tip.zip (~8KB) 
  
 ===== Plugin Source ===== ===== Plugin Source =====
Line 566: Line 562:
  
 There's another plugin available which claims to perform a similar task. There's another plugin available which claims to perform a similar task.
-Please refer to the docs of the [[http://www.dokuwiki.org/plugin:note|Note]] plugin to check whether it will meet your needs.+Please refer to the docs of the [[plugin:note|Note]] plugin to check whether it will meet your needs.
  
 ==== Plugins by the same author ==== ==== Plugins by the same author ====
Line 607: Line 603:
 ---- ----
  
-Hello, this plugin has proven itself to be one I cannot do without!\\ I am wondering what would need to be done to show up in print and/or [[doku>plugin:odt]]?\\ Thanks for an extremely useful plugin!\\ //- Jeff 2008/06/19//+Hello, this plugin has proven itself to be one I cannot do without!\\ I am wondering what would need to be done to show up in print and/or [[plugin:odt]]?\\ Thanks for an extremely useful plugin!\\ //- Jeff 2008/06/19//
  
 > Thanks for your kind words, Jeff. About your questions:\\ As far as //printing// is concerned a tip's contents should show up the same way as on screen (as you can see [[#Presentation|above]] the presentation rules are intentionally not restricted to screen). However, DokuWiki by default handles (the delivery of) CSS in a, uhm, let's say "strange" way by adding an additional application layer to the CSS files which makes it quite difficult to provide presentation rules for different media, or, as you obviously experienced, a set of rules to be used for both viewing and printing. Anyway, to make a long story short, the only way I know to work around artificially introduced problems is to bypass DokuWiki's default style handling((This involves patching DokuWiki's soruce files and providing an own style sheet with appropriate rules for the ''screen'', ''print'' and ''projection'' output media. The bottom line is you'd have to use your own "template" (in DokuWiki speech), something that's clearly outside the scope of a syntax plugin.)). Hence, I'm afraid, there's nothing the plugin can do about this issue.\\ As for //ODT// export I can just say, that's on my private ToDo list. But since I've to work for a living I can make no promise about a possible time frame. After implementing ODT support for my [[code2|Code]] syntax plugin I know that's a quite time consuming task((for both the experimental ''odt'' plugin's, er, peculiarities and the ODF's specs and reallifebehaviour)). So, please, don't hold your breath.\\  --- //[[support@mwat.de|Matthias Watermann]] 2008/06/20 14:59// > Thanks for your kind words, Jeff. About your questions:\\ As far as //printing// is concerned a tip's contents should show up the same way as on screen (as you can see [[#Presentation|above]] the presentation rules are intentionally not restricted to screen). However, DokuWiki by default handles (the delivery of) CSS in a, uhm, let's say "strange" way by adding an additional application layer to the CSS files which makes it quite difficult to provide presentation rules for different media, or, as you obviously experienced, a set of rules to be used for both viewing and printing. Anyway, to make a long story short, the only way I know to work around artificially introduced problems is to bypass DokuWiki's default style handling((This involves patching DokuWiki's soruce files and providing an own style sheet with appropriate rules for the ''screen'', ''print'' and ''projection'' output media. The bottom line is you'd have to use your own "template" (in DokuWiki speech), something that's clearly outside the scope of a syntax plugin.)). Hence, I'm afraid, there's nothing the plugin can do about this issue.\\ As for //ODT// export I can just say, that's on my private ToDo list. But since I've to work for a living I can make no promise about a possible time frame. After implementing ODT support for my [[code2|Code]] syntax plugin I know that's a quite time consuming task((for both the experimental ''odt'' plugin's, er, peculiarities and the ODF's specs and reallifebehaviour)). So, please, don't hold your breath.\\  --- //[[support@mwat.de|Matthias Watermann]] 2008/06/20 14:59//
plugin/tip.1286114565.txt.gz · Last modified: 2010-10-03 16:02 by HåkanS
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki

Global DokuWiki Links