====== Blockquote Plugin ======



===== Description =====

The blockquote plugin provides an environment for (semantically correct by using the ''blockquote'' XHTML tag) quotes. In contrast to the default wiki markup for quoting, the content of the quote can contain any wiki markup which then gets interpreted as it would outside of the quote environment. Thus, also nested quotes are possible.

In case you come across any bugs in this plugin, don't hesitate to [[http://flyspray.foosel.net/index.php?tasks=all&project=8|report them]].

The Darcs repository of the plugin can be found [[http://devel.foosel.org/darcsweb/darcsweb.cgi?r=dokuwiki/blockquote;a=summary|here]].


===== Updates =====

**Last updated:** 2008/05/04
 
  * 2008/05/04:
    * [[bug>25]] fixed, toolbar button works again. You will have to purge your cached javascript after upgrading by opening  ''http://your.domain.com/path/to/dokuwiki/lib/exe/js.php?edit=1&write=1&purge=1'' in your browser of choice.
  * 2008/04/06:
    * Now produces valid XHTML again (blockquote output was placed inside paragraphs, those are now closed and reopened properly)
  * 2008/02/13:
    * :!: Security fix, please update ASAP :!:
    * Fixed XSS vulnerabilities in both ''cite'' and ''blockquote'' commands, big thanks to the Oracle Corporation's Ethical Hacking Team for discovering this and giving me a heads up
  * 2008/01/26:
    * :!: When updating, please first delete the old installation of the plugin, otherwise not all components might be registered properly.
    * Added a toolbar icon as proposed by Tobias Deutsch.
    * Added syntax for adding a citation source (extension of the blockquote command as well as addition of a new cite command).
  * 2007/10/27:
    * Initial release

===== Syntax =====

The plugin provides two additional pairs of markup tags, the ''blockquote'' and the ''cite'' markup. The ''blockquote'' allows an additional citation source to be given after the ''blockquote'' keyword in the opening tag. The ''cite'' markup was mainly created to allow the addition of more complex citation sources (including links, text formatting etc) inside the ''blockquote'' environment, although it can also be used standalone. See the examples below.

<note>If blockquotes you insert only look like the usual quotes as available from DokuWiki core, this will most probably be due to a caching issue. Please try Shift-Reloading in your browser, and if this doesn't help take a look at [[doku>devel:caching#purging_the_cache|"Purging the Cache"]] in the DokuWiki documentation before asking for help here. Thanks!</note>

==== Examples ====

=== Loads of markup ===

The following code

<code>
<blockquote>
Test with loads of markup...

Another paragraph with a little [[http://nowhere|link]] to nowhere. Oh, and while we are at it, what about some **bold**, some //italic// and some __underlined__ text? And finally, an itemization:

  * item 1
    * item 1.1
    * item 1.2
  * item 2
    - ordered item 2.1
    - ordered item 2.2
      - ordered item 2.2.1
  * item 3

Works :-)
</blockquote>
</code>

results in

<blockquote>
Test with loads of markup...

Another paragraph with a little [[http://nowhere|link]] to nowhere. Oh, and while we are at it, what about some **bold**, some //italic// and some __underlined__ text? And finally, an itemization:

  * item 1
    * item 1.1
    * item 1.2
  * item 2
    - ordered item 2.1
    - ordered item 2.2
      - ordered item 2.2.1
  * item 3

Works :-)
</blockquote>

=== The cite attribute ===

The following code

<code>
<blockquote J. Random Hacker>Test with a cite attribute...</blockquote>
</code>

results in

<blockquote J. Random Hacker>Test with a cite attribute...</blockquote>
=== The cite command ===

The following code

<code>
<blockquote>Test with a cite command...<cite>J. Random Hacker, [[http://localhost/~jrhacker]]</cite></blockquote>
</code>

results in

<blockquote>Test with a cite command...<cite>J. Random Hacker, [[http://localhost/~jrhacker]]</cite></blockquote>

===== Installation =====

<note important>When updating from 2007/10/27, please first delete the old installation of the plugin, otherwise not all components might be registered properly.</note>

==== With plugin manager ====

Let the manager do the dirty work, just give him this link to eat: {{plugin-blockquote.tar.gz}}

==== Without plugin manager ====

  - Download the plugin: {{plugin-blockquote.tar.gz}}
  - Extract it into your dokuwiki plugin folder (eg ''lib/plugins'')

~~DISCUSSION~~