add contents
30
lib/plugins/note/CHANGES.md
Normal file
@@ -0,0 +1,30 @@
|
||||
* 2018-08-21 (fixes by Marcin Orlowski)
|
||||
* Fixed notes' CSS for DokuWiki dark themes
|
||||
* Code cleanup
|
||||
* Updated documentation
|
||||
* 2016-09-14
|
||||
* plugin cleanup
|
||||
* adjustment to ODT plugin re-design
|
||||
* fixed PHP7.0 signature errors
|
||||
* 2009-06-16 (re-packaged by Mischa The Evil)
|
||||
* Removed obsolete files from the package
|
||||
* Added README with CHANGELOG
|
||||
* Added GNU GPL v2 license
|
||||
* Fixed file-permissions
|
||||
* 2009-06-15 (fixes by Aurélien Bompard)
|
||||
* Fix in the ODT renderer
|
||||
* Add toolbar buttons for the notes.
|
||||
* 2008-02-17 (patches by Aurélien Bompard)
|
||||
* added support for ODT-export
|
||||
* 2006-03-29 (patches by Eric Hameleers and Christopher Smith)
|
||||
* allow note nesting
|
||||
* fix the trimmed space problem
|
||||
* fix the issue with protected modes (e.g. ```<tt><code></tt>``` & ```<tt><file></tt>```) not being allowed within notes
|
||||
* plug the security vulnerability which could allow malicious HTML or JavaScript to infiltrate your wiki
|
||||
* make note types case independent (e.g. ```<tt>important</tt>```, ```<tt>IMPORTANT</tt>``` & ```<tt>Important</tt>``` will all given an "important" note)
|
||||
* and better:
|
||||
* code efficiency
|
||||
* code reading
|
||||
* conformance to DokuWiki's changes in plugin classes
|
||||
* 2005-10-13
|
||||
* Initial release by Olivier Cortéz (?)
|
340
lib/plugins/note/COPYING
Normal file
@@ -0,0 +1,340 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 2, June 1991
|
||||
|
||||
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
|
||||
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The licenses for most software are designed to take away your
|
||||
freedom to share and change it. By contrast, the GNU General Public
|
||||
License is intended to guarantee your freedom to share and change free
|
||||
software--to make sure the software is free for all its users. This
|
||||
General Public License applies to most of the Free Software
|
||||
Foundation's software and to any other program whose authors commit to
|
||||
using it. (Some other Free Software Foundation software is covered by
|
||||
the GNU Library General Public License instead.) You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
this service if you wish), that you receive source code or can get it
|
||||
if you want it, that you can change the software or use pieces of it
|
||||
in new free programs; and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to make restrictions that forbid
|
||||
anyone to deny you these rights or to ask you to surrender the rights.
|
||||
These restrictions translate to certain responsibilities for you if you
|
||||
distribute copies of the software, or if you modify it.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must give the recipients all the rights that
|
||||
you have. You must make sure that they, too, receive or can get the
|
||||
source code. And you must show them these terms so they know their
|
||||
rights.
|
||||
|
||||
We protect your rights with two steps: (1) copyright the software, and
|
||||
(2) offer you this license which gives you legal permission to copy,
|
||||
distribute and/or modify the software.
|
||||
|
||||
Also, for each author's protection and ours, we want to make certain
|
||||
that everyone understands that there is no warranty for this free
|
||||
software. If the software is modified by someone else and passed on, we
|
||||
want its recipients to know that what they have is not the original, so
|
||||
that any problems introduced by others will not reflect on the original
|
||||
authors' reputations.
|
||||
|
||||
Finally, any free program is threatened constantly by software
|
||||
patents. We wish to avoid the danger that redistributors of a free
|
||||
program will individually obtain patent licenses, in effect making the
|
||||
program proprietary. To prevent this, we have made it clear that any
|
||||
patent must be licensed for everyone's free use or not licensed at all.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
||||
|
||||
0. This License applies to any program or other work which contains
|
||||
a notice placed by the copyright holder saying it may be distributed
|
||||
under the terms of this General Public License. The "Program", below,
|
||||
refers to any such program or work, and a "work based on the Program"
|
||||
means either the Program or any derivative work under copyright law:
|
||||
that is to say, a work containing the Program or a portion of it,
|
||||
either verbatim or with modifications and/or translated into another
|
||||
language. (Hereinafter, translation is included without limitation in
|
||||
the term "modification".) Each licensee is addressed as "you".
|
||||
|
||||
Activities other than copying, distribution and modification are not
|
||||
covered by this License; they are outside its scope. The act of
|
||||
running the Program is not restricted, and the output from the Program
|
||||
is covered only if its contents constitute a work based on the
|
||||
Program (independent of having been made by running the Program).
|
||||
Whether that is true depends on what the Program does.
|
||||
|
||||
1. You may copy and distribute verbatim copies of the Program's
|
||||
source code as you receive it, in any medium, provided that you
|
||||
conspicuously and appropriately publish on each copy an appropriate
|
||||
copyright notice and disclaimer of warranty; keep intact all the
|
||||
notices that refer to this License and to the absence of any warranty;
|
||||
and give any other recipients of the Program a copy of this License
|
||||
along with the Program.
|
||||
|
||||
You may charge a fee for the physical act of transferring a copy, and
|
||||
you may at your option offer warranty protection in exchange for a fee.
|
||||
|
||||
2. You may modify your copy or copies of the Program or any portion
|
||||
of it, thus forming a work based on the Program, and copy and
|
||||
distribute such modifications or work under the terms of Section 1
|
||||
above, provided that you also meet all of these conditions:
|
||||
|
||||
a) You must cause the modified files to carry prominent notices
|
||||
stating that you changed the files and the date of any change.
|
||||
|
||||
b) You must cause any work that you distribute or publish, that in
|
||||
whole or in part contains or is derived from the Program or any
|
||||
part thereof, to be licensed as a whole at no charge to all third
|
||||
parties under the terms of this License.
|
||||
|
||||
c) If the modified program normally reads commands interactively
|
||||
when run, you must cause it, when started running for such
|
||||
interactive use in the most ordinary way, to print or display an
|
||||
announcement including an appropriate copyright notice and a
|
||||
notice that there is no warranty (or else, saying that you provide
|
||||
a warranty) and that users may redistribute the program under
|
||||
these conditions, and telling the user how to view a copy of this
|
||||
License. (Exception: if the Program itself is interactive but
|
||||
does not normally print such an announcement, your work based on
|
||||
the Program is not required to print an announcement.)
|
||||
|
||||
These requirements apply to the modified work as a whole. If
|
||||
identifiable sections of that work are not derived from the Program,
|
||||
and can be reasonably considered independent and separate works in
|
||||
themselves, then this License, and its terms, do not apply to those
|
||||
sections when you distribute them as separate works. But when you
|
||||
distribute the same sections as part of a whole which is a work based
|
||||
on the Program, the distribution of the whole must be on the terms of
|
||||
this License, whose permissions for other licensees extend to the
|
||||
entire whole, and thus to each and every part regardless of who wrote it.
|
||||
|
||||
Thus, it is not the intent of this section to claim rights or contest
|
||||
your rights to work written entirely by you; rather, the intent is to
|
||||
exercise the right to control the distribution of derivative or
|
||||
collective works based on the Program.
|
||||
|
||||
In addition, mere aggregation of another work not based on the Program
|
||||
with the Program (or with a work based on the Program) on a volume of
|
||||
a storage or distribution medium does not bring the other work under
|
||||
the scope of this License.
|
||||
|
||||
3. You may copy and distribute the Program (or a work based on it,
|
||||
under Section 2) in object code or executable form under the terms of
|
||||
Sections 1 and 2 above provided that you also do one of the following:
|
||||
|
||||
a) Accompany it with the complete corresponding machine-readable
|
||||
source code, which must be distributed under the terms of Sections
|
||||
1 and 2 above on a medium customarily used for software interchange; or,
|
||||
|
||||
b) Accompany it with a written offer, valid for at least three
|
||||
years, to give any third party, for a charge no more than your
|
||||
cost of physically performing source distribution, a complete
|
||||
machine-readable copy of the corresponding source code, to be
|
||||
distributed under the terms of Sections 1 and 2 above on a medium
|
||||
customarily used for software interchange; or,
|
||||
|
||||
c) Accompany it with the information you received as to the offer
|
||||
to distribute corresponding source code. (This alternative is
|
||||
allowed only for noncommercial distribution and only if you
|
||||
received the program in object code or executable form with such
|
||||
an offer, in accord with Subsection b above.)
|
||||
|
||||
The source code for a work means the preferred form of the work for
|
||||
making modifications to it. For an executable work, complete source
|
||||
code means all the source code for all modules it contains, plus any
|
||||
associated interface definition files, plus the scripts used to
|
||||
control compilation and installation of the executable. However, as a
|
||||
special exception, the source code distributed need not include
|
||||
anything that is normally distributed (in either source or binary
|
||||
form) with the major components (compiler, kernel, and so on) of the
|
||||
operating system on which the executable runs, unless that component
|
||||
itself accompanies the executable.
|
||||
|
||||
If distribution of executable or object code is made by offering
|
||||
access to copy from a designated place, then offering equivalent
|
||||
access to copy the source code from the same place counts as
|
||||
distribution of the source code, even though third parties are not
|
||||
compelled to copy the source along with the object code.
|
||||
|
||||
4. You may not copy, modify, sublicense, or distribute the Program
|
||||
except as expressly provided under this License. Any attempt
|
||||
otherwise to copy, modify, sublicense or distribute the Program is
|
||||
void, and will automatically terminate your rights under this License.
|
||||
However, parties who have received copies, or rights, from you under
|
||||
this License will not have their licenses terminated so long as such
|
||||
parties remain in full compliance.
|
||||
|
||||
5. You are not required to accept this License, since you have not
|
||||
signed it. However, nothing else grants you permission to modify or
|
||||
distribute the Program or its derivative works. These actions are
|
||||
prohibited by law if you do not accept this License. Therefore, by
|
||||
modifying or distributing the Program (or any work based on the
|
||||
Program), you indicate your acceptance of this License to do so, and
|
||||
all its terms and conditions for copying, distributing or modifying
|
||||
the Program or works based on it.
|
||||
|
||||
6. Each time you redistribute the Program (or any work based on the
|
||||
Program), the recipient automatically receives a license from the
|
||||
original licensor to copy, distribute or modify the Program subject to
|
||||
these terms and conditions. You may not impose any further
|
||||
restrictions on the recipients' exercise of the rights granted herein.
|
||||
You are not responsible for enforcing compliance by third parties to
|
||||
this License.
|
||||
|
||||
7. If, as a consequence of a court judgment or allegation of patent
|
||||
infringement or for any other reason (not limited to patent issues),
|
||||
conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot
|
||||
distribute so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you
|
||||
may not distribute the Program at all. For example, if a patent
|
||||
license would not permit royalty-free redistribution of the Program by
|
||||
all those who receive copies directly or indirectly through you, then
|
||||
the only way you could satisfy both it and this License would be to
|
||||
refrain entirely from distribution of the Program.
|
||||
|
||||
If any portion of this section is held invalid or unenforceable under
|
||||
any particular circumstance, the balance of the section is intended to
|
||||
apply and the section as a whole is intended to apply in other
|
||||
circumstances.
|
||||
|
||||
It is not the purpose of this section to induce you to infringe any
|
||||
patents or other property right claims or to contest validity of any
|
||||
such claims; this section has the sole purpose of protecting the
|
||||
integrity of the free software distribution system, which is
|
||||
implemented by public license practices. Many people have made
|
||||
generous contributions to the wide range of software distributed
|
||||
through that system in reliance on consistent application of that
|
||||
system; it is up to the author/donor to decide if he or she is willing
|
||||
to distribute software through any other system and a licensee cannot
|
||||
impose that choice.
|
||||
|
||||
This section is intended to make thoroughly clear what is believed to
|
||||
be a consequence of the rest of this License.
|
||||
|
||||
8. If the distribution and/or use of the Program is restricted in
|
||||
certain countries either by patents or by copyrighted interfaces, the
|
||||
original copyright holder who places the Program under this License
|
||||
may add an explicit geographical distribution limitation excluding
|
||||
those countries, so that distribution is permitted only in or among
|
||||
countries not thus excluded. In such case, this License incorporates
|
||||
the limitation as if written in the body of this License.
|
||||
|
||||
9. The Free Software Foundation may publish revised and/or new versions
|
||||
of the General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the Program
|
||||
specifies a version number of this License which applies to it and "any
|
||||
later version", you have the option of following the terms and conditions
|
||||
either of that version or of any later version published by the Free
|
||||
Software Foundation. If the Program does not specify a version number of
|
||||
this License, you may choose any version ever published by the Free Software
|
||||
Foundation.
|
||||
|
||||
10. If you wish to incorporate parts of the Program into other free
|
||||
programs whose distribution conditions are different, write to the author
|
||||
to ask for permission. For software which is copyrighted by the Free
|
||||
Software Foundation, write to the Free Software Foundation; we sometimes
|
||||
make exceptions for this. Our decision will be guided by the two goals
|
||||
of preserving the free status of all derivatives of our free software and
|
||||
of promoting the sharing and reuse of software generally.
|
||||
|
||||
NO WARRANTY
|
||||
|
||||
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
|
||||
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
|
||||
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
|
||||
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
|
||||
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
||||
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
|
||||
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
|
||||
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
|
||||
REPAIR OR CORRECTION.
|
||||
|
||||
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
|
||||
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
|
||||
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
|
||||
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
|
||||
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
|
||||
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
|
||||
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
|
||||
POSSIBILITY OF SUCH DAMAGES.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
convey the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software; you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation; either version 2 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program; if not, write to the Free Software
|
||||
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program is interactive, make it output a short notice like this
|
||||
when it starts in an interactive mode:
|
||||
|
||||
Gnomovision version 69, Copyright (C) year name of author
|
||||
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, the commands you use may
|
||||
be called something other than `show w' and `show c'; they could even be
|
||||
mouse-clicks or menu items--whatever suits your program.
|
||||
|
||||
You should also get your employer (if you work as a programmer) or your
|
||||
school, if any, to sign a "copyright disclaimer" for the program, if
|
||||
necessary. Here is a sample; alter the names:
|
||||
|
||||
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
|
||||
`Gnomovision' (which makes passes at compilers) written by James Hacker.
|
||||
|
||||
<signature of Ty Coon>, 1 April 1989
|
||||
Ty Coon, President of Vice
|
||||
|
||||
This General Public License does not permit incorporating your program into
|
||||
proprietary programs. If your program is a subroutine library, you may
|
||||
consider it more useful to permit linking proprietary applications with the
|
||||
library. If this is what you want to do, use the GNU Library General
|
||||
Public License instead of this License.
|
76
lib/plugins/note/README.md
Normal file
@@ -0,0 +1,76 @@
|
||||
# DokuWiki Note plugin
|
||||
|
||||
A plugin for [DokuWiki](https://www.dokuwiki.org/) which allows users to easily insert four kinds of notes into the wiki pages.
|
||||
|
||||
## Usage
|
||||
|
||||
When you have it installed, use the following syntax `<note>message</note>`:
|
||||
|
||||
<note>note</note>
|
||||

|
||||
|
||||
You can use the note keywords `important`, `warning` and `tip` to change the look of note as well
|
||||
|
||||
<note important>important</note>
|
||||

|
||||
|
||||
<note tip>tip</note>
|
||||

|
||||
|
||||
<note warning>warning</note>
|
||||

|
||||
|
||||
## Notes
|
||||
|
||||
It is regularly reported that the cache needs to be cleaned after installing the plugin before the notes do showup. At least a full page-reload (CTRL-F5) is required.
|
||||
|
||||
## Limitations
|
||||
|
||||
Currently this plugin has some limitations:
|
||||
|
||||
* Plugin won't work inside numbered lists
|
||||
* Plugin won't work inside tables
|
||||
|
||||
## Download / Installation
|
||||
|
||||
See [DokuWiki's plugin page](https://www.dokuwiki.org/plugin:note)
|
||||
|
||||
Alternatively
|
||||
1. Download plugin/repo archive
|
||||
2. Installing the plugin:
|
||||
* You can either extract the archive into the <tt>lib/plugins</tt> directory or
|
||||
* Load the admin page and go to Manage Plugins and enter the URL of the plugin under Download and install the new plugin.-
|
||||
3. Update the `Configuration Settings` under the DokuWiki's admin page.
|
||||
|
||||
## Authors
|
||||
|
||||
The plugin has been written from scratch by Olivier Cortéz. After the initial release it has been maintained
|
||||
by Olivier while he integrated several patches provided by the DokuWiki-community. Somewhere around the end
|
||||
of 2008 / start of 2009 Olivier started to became too busy with other (real-life) activities and occupations
|
||||
that active development and support halted. On 2009/06/15 Aurélien Bompard decided, after contacting
|
||||
Olivier Cortéz about it, to (temporarily) take-over maintenance and support for the plugin. On the
|
||||
same date Mischa The Evil opened a [GitHub-repository for the plugin](https://github.com/MischaTheEvil/dokuwiki_note)
|
||||
to make it a "real" community plugin. On the 16th a re-packaged release is available
|
||||
which "completed" the plugin (doc, license etc.).
|
||||
|
||||
## Credits
|
||||
|
||||
Many thanks to the following DokuWiki developers (in random order):
|
||||
|
||||
* Stephane Chamberland
|
||||
* Carl-Christian Salvesen
|
||||
* Eric Hameleers
|
||||
* Christopher Smith
|
||||
* Chris Lale
|
||||
* Pixote
|
||||
* Yves Bergeron
|
||||
* Taylor Jones
|
||||
* Luke
|
||||
* Frédéric
|
||||
* Kmosak
|
||||
* foosel
|
||||
* zerohalo
|
||||
|
||||
## License
|
||||
|
||||
This plugin is open-source and licensed under the GNU GPL v.2.
|
60
lib/plugins/note/action.php
Normal file
@@ -0,0 +1,60 @@
|
||||
<?php
|
||||
/**
|
||||
* @license GPL 2 (http://www.gnu.org/licenses/gpl.html)
|
||||
*/
|
||||
|
||||
// must be run within Dokuwiki
|
||||
if(!defined('DOKU_INC')) die();
|
||||
|
||||
if(!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN',DOKU_INC.'lib/plugins/');
|
||||
require_once(DOKU_PLUGIN.'action.php');
|
||||
|
||||
class action_plugin_note extends DokuWiki_Action_Plugin {
|
||||
|
||||
/**
|
||||
* register the eventhandlers
|
||||
*
|
||||
* @author Andreas Gohr <andi@splitbrain.org>
|
||||
*/
|
||||
function register(Doku_Event_Handler $controller){
|
||||
$controller->register_hook('TOOLBAR_DEFINE', 'AFTER', $this, 'handle_toolbar', array ());
|
||||
}
|
||||
|
||||
function handle_toolbar(&$event, $param) {
|
||||
$event->data[] = array (
|
||||
'type' => 'picker',
|
||||
'title' => $this->getLang('note_picker'),
|
||||
'icon' => '../../plugins/note/images/note_picker.png',
|
||||
'list' => array(
|
||||
array(
|
||||
'type' => 'format',
|
||||
'title' => $this->getLang('tb_note'),
|
||||
'icon' => '../../plugins/note/images/tb_note.png',
|
||||
'open' => '<note>',
|
||||
'close' => '</note>',
|
||||
),
|
||||
array(
|
||||
'type' => 'format',
|
||||
'title' => $this->getLang('tb_tip'),
|
||||
'icon' => '../../plugins/note/images/tb_tip.png',
|
||||
'open' => '<note tip>',
|
||||
'close' => '</note>',
|
||||
),
|
||||
array(
|
||||
'type' => 'format',
|
||||
'title' => $this->getLang('tb_important'),
|
||||
'icon' => '../../plugins/note/images/tb_important.png',
|
||||
'open' => '<note important>',
|
||||
'close' => '</note>',
|
||||
),
|
||||
array(
|
||||
'type' => 'format',
|
||||
'title' => $this->getLang('tb_warning'),
|
||||
'icon' => '../../plugins/note/images/tb_warning.png',
|
||||
'open' => '<note warning>',
|
||||
'close' => '</note>',
|
||||
),
|
||||
)
|
||||
);
|
||||
}
|
||||
}
|
BIN
lib/plugins/note/images/bw/important.png
Normal file
After Width: | Height: | Size: 2.1 KiB |
BIN
lib/plugins/note/images/bw/note.png
Normal file
After Width: | Height: | Size: 2.1 KiB |
BIN
lib/plugins/note/images/bw/tip.png
Normal file
After Width: | Height: | Size: 2.5 KiB |
BIN
lib/plugins/note/images/bw/warning.png
Normal file
After Width: | Height: | Size: 3.0 KiB |
BIN
lib/plugins/note/images/doc/note.png
Normal file
After Width: | Height: | Size: 786 B |
BIN
lib/plugins/note/images/doc/note_important.png
Normal file
After Width: | Height: | Size: 1012 B |
BIN
lib/plugins/note/images/doc/note_tip.png
Normal file
After Width: | Height: | Size: 831 B |
BIN
lib/plugins/note/images/doc/note_warning.png
Normal file
After Width: | Height: | Size: 907 B |
BIN
lib/plugins/note/images/important.png
Normal file
After Width: | Height: | Size: 2.2 KiB |
BIN
lib/plugins/note/images/note.png
Normal file
After Width: | Height: | Size: 2.5 KiB |
BIN
lib/plugins/note/images/note_picker.png
Normal file
After Width: | Height: | Size: 1.3 KiB |
BIN
lib/plugins/note/images/tb_important.png
Normal file
After Width: | Height: | Size: 1.3 KiB |
BIN
lib/plugins/note/images/tb_note.png
Normal file
After Width: | Height: | Size: 1.4 KiB |
BIN
lib/plugins/note/images/tb_tip.png
Normal file
After Width: | Height: | Size: 1.4 KiB |
BIN
lib/plugins/note/images/tb_warning.png
Normal file
After Width: | Height: | Size: 1.8 KiB |
BIN
lib/plugins/note/images/tip.png
Normal file
After Width: | Height: | Size: 2.8 KiB |
BIN
lib/plugins/note/images/warning.png
Normal file
After Width: | Height: | Size: 3.2 KiB |
11
lib/plugins/note/lang/en/lang.php
Normal file
@@ -0,0 +1,11 @@
|
||||
<?php
|
||||
/**
|
||||
* English language file
|
||||
*/
|
||||
|
||||
$lang['note_picker'] = 'Notes';
|
||||
|
||||
$lang['tb_note'] = 'Note';
|
||||
$lang['tb_tip'] = 'Tip';
|
||||
$lang['tb_important'] = 'Important';
|
||||
$lang['tb_warning'] = 'Warning';
|
11
lib/plugins/note/lang/fr/lang.php
Normal file
@@ -0,0 +1,11 @@
|
||||
<?php
|
||||
/**
|
||||
* French language file
|
||||
*/
|
||||
|
||||
$lang['note_picker'] = 'Note';
|
||||
|
||||
$lang['tb_note'] = 'Note';
|
||||
$lang['tb_tip'] = 'Conseil';
|
||||
$lang['tb_important'] = 'Important';
|
||||
$lang['tb_warning'] = 'Alerte';
|
11
lib/plugins/note/lang/ru/lang.php
Normal file
@@ -0,0 +1,11 @@
|
||||
<?php
|
||||
/**
|
||||
* Russian language file
|
||||
*/
|
||||
|
||||
$lang['note_picker'] = 'Заметки';
|
||||
|
||||
$lang['tb_note'] = 'Заметка';
|
||||
$lang['tb_tip'] = 'Совет';
|
||||
$lang['tb_important'] = 'Важно';
|
||||
$lang['tb_warning'] = 'Внимание';
|
37
lib/plugins/note/odt.css
Normal file
@@ -0,0 +1,37 @@
|
||||
.plugin_note {
|
||||
margin: 2em;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
width: 70% !important;
|
||||
min-height: 40px;
|
||||
clear: both;
|
||||
text-align: justify;
|
||||
vertical-align: middle;
|
||||
border-collapse: collapse;
|
||||
padding: 15px 20px 15px 80px;
|
||||
background-position: 20px 50%;
|
||||
background-repeat: no-repeat;
|
||||
-moz-border-radius: 20px;
|
||||
-khtml-border-radius: 20px;
|
||||
border-radius: 20px;
|
||||
}
|
||||
|
||||
.noteclassic {
|
||||
/*border: 1px solid #99D;*/
|
||||
background-image: url(images/bw/note.png);
|
||||
}
|
||||
|
||||
.noteimportant {
|
||||
/*border: 1px solid #ff0;*/
|
||||
background-image: url(images/bw/important.png);
|
||||
}
|
||||
|
||||
.notewarning {
|
||||
/*border: 1px solid #d99;*/
|
||||
background-image: url(images/bw/warning.png);
|
||||
}
|
||||
|
||||
.notetip {
|
||||
/*border: 1px solid #9d9;*/
|
||||
background-image: url(images/bw/tip.png);
|
||||
}
|
7
lib/plugins/note/plugin.info.txt
Normal file
@@ -0,0 +1,7 @@
|
||||
base note
|
||||
author Olivier Cortès, Eric Hameleers, Christopher Smith, Aurélien Bompard, LarsDW223
|
||||
email olive@deep-ocean.net
|
||||
date 2020-06-28
|
||||
name Note Plugin
|
||||
desc Add Note/Important/Tip/Warning Capability (DIV+CSS box)
|
||||
url https://www.dokuwiki.org/plugin:note
|
44
lib/plugins/note/print.css
Normal file
@@ -0,0 +1,44 @@
|
||||
.plugin_note {
|
||||
margin: 2em 0;
|
||||
max-width: 100%;
|
||||
min-height: 40px;
|
||||
text-align: justify;
|
||||
vertical-align: middle;
|
||||
border-collapse: collapse;
|
||||
padding: 5px 20px 5px 80px;
|
||||
background-position: 20px 50%;
|
||||
background-repeat: no-repeat;
|
||||
-moz-border-radius: 20px;
|
||||
-khtml-border-radius: 20px;
|
||||
border-radius: 20px;
|
||||
color: black;
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
.plugin_note .li {
|
||||
color: black !important;
|
||||
}
|
||||
|
||||
.noteclassic {
|
||||
border: 1px solid #99D;
|
||||
background-color: #eeeeff;
|
||||
background-image: url(images/note.png);
|
||||
}
|
||||
|
||||
.noteimportant {
|
||||
border: 1px solid #ff0;
|
||||
background-color: #ffffcc;
|
||||
background-image: url(images/important.png);
|
||||
}
|
||||
|
||||
.notewarning {
|
||||
border: 1px solid #d99;
|
||||
background-color: #ffdddd;
|
||||
background-image: url(images/warning.png);
|
||||
}
|
||||
|
||||
.notetip {
|
||||
border: 1px solid #9d9;
|
||||
background-color: #ddffdd;
|
||||
background-image: url(images/tip.png);
|
||||
}
|
44
lib/plugins/note/style.css
Normal file
@@ -0,0 +1,44 @@
|
||||
.plugin_note {
|
||||
margin: 2em auto;
|
||||
max-width: 70%;
|
||||
min-height: 40px;
|
||||
text-align: justify;
|
||||
vertical-align: middle;
|
||||
border-collapse: collapse;
|
||||
padding: 15px 20px 15px 80px;
|
||||
background-position: 20px 50%;
|
||||
background-repeat: no-repeat;
|
||||
-moz-border-radius: 20px;
|
||||
-khtml-border-radius: 20px;
|
||||
border-radius: 20px;
|
||||
color: black;
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
.plugin_note .li {
|
||||
color: black !important;
|
||||
}
|
||||
|
||||
.noteclassic {
|
||||
/*border: 1px solid #99D;*/
|
||||
background-color: #eeeeff;
|
||||
background-image: url(images/note.png);
|
||||
}
|
||||
|
||||
.noteimportant {
|
||||
/*border: 1px solid #ff0;*/
|
||||
background-color: #ffffcc;
|
||||
background-image: url(images/important.png);
|
||||
}
|
||||
|
||||
.notewarning {
|
||||
/*border: 1px solid #d99;*/
|
||||
background-color: #ffdddd;
|
||||
background-image: url(images/warning.png);
|
||||
}
|
||||
|
||||
.notetip {
|
||||
/*border: 1px solid #9d9;*/
|
||||
background-color: #ddffdd;
|
||||
background-image: url(images/tip.png);
|
||||
}
|
280
lib/plugins/note/syntax.php
Normal file
@@ -0,0 +1,280 @@
|
||||
<?php
|
||||
/**
|
||||
* Add Note capability to dokuwiki
|
||||
*
|
||||
* <note>This is note</note>
|
||||
* <note classic>This is note</note>
|
||||
* <note important>This is an important note</note>
|
||||
* <note warning>This is a big warning</note>
|
||||
* <note tip>This is a tip</note>
|
||||
*
|
||||
* by Olivier Cortès <olive@deep-ocean.net>
|
||||
* under the terms of the GNU GPL v2.
|
||||
*
|
||||
* Originaly derived from the work of :
|
||||
* Stephane Chamberland <stephane.chamberland@ec.gc.ca> (Side Notes PlugIn)
|
||||
* Carl-Christian Salvesen <calle@ioslo.net> (Graphviz plugin)
|
||||
*
|
||||
* Contributions by Eric Hameleers <alien [at] slackware [dot] com> :
|
||||
* use <div> instead of <table>,
|
||||
* contain the images and stylesheet inside the plugin,
|
||||
* permit nesting of notes,
|
||||
*
|
||||
* Contributed by Christopher Smith <chris [at] jalakai [dot] co [dot] uk>
|
||||
* fix some parsing problems and a security hole.
|
||||
* make note types case independent
|
||||
* simplify code reading
|
||||
* modernise the plugin for changes/fixes/improvements to the underlying Dokuwiki plugin class,
|
||||
* improve efficiency.
|
||||
*
|
||||
* Contributed by Aurélien Bompard <aurelien [at] bompard [dot] org>
|
||||
* support for the ODT output format.
|
||||
*
|
||||
* @license GNU_GPL_v2
|
||||
* @author Olivier Cortes <olive@deep-ocean.net>
|
||||
*/
|
||||
|
||||
if (!defined('DOKU_INC')) {
|
||||
define('DOKU_INC',realpath(dirname(__FILE__).'/../../').'/');
|
||||
}
|
||||
if (!defined('DOKU_PLUGIN')) {
|
||||
define('DOKU_PLUGIN',DOKU_INC.'lib/plugins/');
|
||||
}
|
||||
require_once DOKU_PLUGIN.'syntax.php';
|
||||
|
||||
|
||||
class syntax_plugin_note extends DokuWiki_Syntax_Plugin {
|
||||
|
||||
var $notes = array(
|
||||
'noteimportant' => array('important', 'importante'),
|
||||
'notewarning' => array('warning','bloquante','critique'),
|
||||
'notetip' => array('tip','tuyau','idée'),
|
||||
'noteclassic' => array('','classic','classique')
|
||||
);
|
||||
|
||||
var $default = 'plugin_note noteclassic';
|
||||
|
||||
function getType(){ return 'container'; }
|
||||
function getPType(){ return 'block'; }
|
||||
function getAllowedTypes() {
|
||||
return array('container','substition','protected','disabled','formatting','paragraphs');
|
||||
}
|
||||
|
||||
function getSort(){ return 195; }
|
||||
|
||||
// override default accepts() method to allow nesting
|
||||
// - ie, to get the plugin accepts its own entry syntax
|
||||
function accepts($mode) {
|
||||
if ($mode == substr(get_class($this), 7)) {
|
||||
return true;
|
||||
}
|
||||
return parent::accepts($mode);
|
||||
}
|
||||
|
||||
function connectTo($mode) {
|
||||
$this->Lexer->addEntryPattern('<note.*?>(?=.*?</note>)',$mode,'plugin_note');
|
||||
}
|
||||
|
||||
function postConnect() {
|
||||
$this->Lexer->addExitPattern('</note>','plugin_note');
|
||||
}
|
||||
|
||||
function handle($match, $state, $pos, Doku_Handler $handler) {
|
||||
switch ($state) {
|
||||
case DOKU_LEXER_ENTER:
|
||||
$note = strtolower(trim(substr($match,5,-1)));
|
||||
|
||||
foreach( $this->notes as $class => $names ) {
|
||||
if (in_array($note, $names))
|
||||
return array($state, $class);
|
||||
}
|
||||
return array($state, $this->default);
|
||||
|
||||
case DOKU_LEXER_UNMATCHED:
|
||||
return array($state, $match);
|
||||
|
||||
default:
|
||||
return array($state);
|
||||
}
|
||||
}
|
||||
|
||||
function render($mode, Doku_Renderer $renderer, $indata) {
|
||||
if($mode == 'xhtml'){
|
||||
list($state, $data) = $indata;
|
||||
|
||||
switch ($state) {
|
||||
case DOKU_LEXER_ENTER :
|
||||
$renderer->doc .= '<div class="plugin_note '.$data.'">';
|
||||
break;
|
||||
|
||||
case DOKU_LEXER_UNMATCHED :
|
||||
$renderer->doc .= $renderer->_xmlEntities($data);
|
||||
break;
|
||||
|
||||
case DOKU_LEXER_EXIT :
|
||||
$renderer->doc .= "\n</div>";
|
||||
break;
|
||||
}
|
||||
return true;
|
||||
} elseif ($mode == 'odt'){
|
||||
list($state, $data) = $indata;
|
||||
|
||||
$this->render_odt ($renderer, $state, $data);
|
||||
return true;
|
||||
}
|
||||
|
||||
// unsupported $mode
|
||||
return false;
|
||||
}
|
||||
|
||||
protected function render_odt ($renderer, $state, $data) {
|
||||
static $first = true;
|
||||
static $new;
|
||||
|
||||
if ($first == true) {
|
||||
$new = method_exists ($renderer, 'getODTPropertiesFromElement');
|
||||
$first = false;
|
||||
}
|
||||
|
||||
if (!$new) {
|
||||
// Render with older ODT plugin version.
|
||||
$this->render_odt_old ($renderer, $state, $data);
|
||||
} else {
|
||||
// Render with newer ODT plugin version.
|
||||
$this->render_odt_new ($renderer, $state, $data);
|
||||
}
|
||||
}
|
||||
|
||||
protected function render_odt_old ($renderer, $state, $data) {
|
||||
switch ($state) {
|
||||
case DOKU_LEXER_ENTER:
|
||||
$type = substr($data, 4);
|
||||
if ($type == 'classic') {
|
||||
// The icon for classic notes is named note.png
|
||||
$type = 'note';
|
||||
}
|
||||
$colors = array('note' => '#eeeeff', 'warning' => '#ffdddd', 'important' => '#ffffcc', 'tip' => '#ddffdd');
|
||||
|
||||
// Content
|
||||
$properties = array();
|
||||
$properties ['width'] = '100%';
|
||||
$properties ['align'] = 'center';
|
||||
$properties ['shadow'] = '#808080 0.18cm 0.18cm';
|
||||
$renderer->_odtTableOpenUseProperties($properties);
|
||||
|
||||
$properties = array();
|
||||
$properties ['width'] = '1.5cm';
|
||||
$renderer->_odtTableAddColumnUseProperties($properties);
|
||||
|
||||
$properties = array();
|
||||
$properties ['width'] = '13.5cm';
|
||||
$renderer->_odtTableAddColumnUseProperties($properties);
|
||||
|
||||
$renderer->tablerow_open();
|
||||
|
||||
$properties = array();
|
||||
$properties ['vertical-align'] = 'middle';
|
||||
$properties ['text-align'] = 'center';
|
||||
$properties ['padding'] = '0.1cm';
|
||||
$properties ['border'] = '0.002cm solid #000000';
|
||||
$properties ['background-color'] = $colors[$type];
|
||||
$renderer->_odtTableCellOpenUseProperties($properties);
|
||||
|
||||
$src = DOKU_PLUGIN.'note/images/'.$type.'.png';
|
||||
$renderer->_odtAddImage($src);
|
||||
|
||||
$renderer->tablecell_close();
|
||||
|
||||
$properties = array();
|
||||
$properties ['vertical-align'] = 'middle';
|
||||
$properties ['padding'] = '0.3cm';
|
||||
$properties ['border'] = '0.002cm solid #000000';
|
||||
$properties ['background-color'] = $colors[$type];
|
||||
$renderer->_odtTableCellOpenUseProperties($properties);
|
||||
break;
|
||||
|
||||
case DOKU_LEXER_UNMATCHED :
|
||||
$renderer->cdata($data);
|
||||
break;
|
||||
|
||||
case DOKU_LEXER_EXIT :
|
||||
$renderer->tablecell_close();
|
||||
$renderer->tablerow_close();
|
||||
$renderer->_odtTableClose();
|
||||
$renderer->p_open();
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* ODT rendering for new versions of the ODT plugin.
|
||||
*
|
||||
* @param $renderer the renderer to use
|
||||
* @param $state the current state
|
||||
* @param $data data from handle()
|
||||
* @author LarsDW223
|
||||
*/
|
||||
protected function render_odt_new ($renderer, $state, $data) {
|
||||
switch ($state) {
|
||||
case DOKU_LEXER_ENTER:
|
||||
$css_properties = array ();
|
||||
|
||||
// Get CSS properties for ODT export.
|
||||
$renderer->getODTPropertiesNew ($css_properties, 'div', 'class="'.$data.'"', NULL, true);
|
||||
|
||||
// Create Content
|
||||
// (We only use the CSS parameters that are meaningful for creating the ODT table)
|
||||
$properties = array();
|
||||
$properties ['width'] = '100%';
|
||||
$properties ['align'] = 'center';
|
||||
$properties ['shadow'] = '#808080 0.18cm 0.18cm';
|
||||
$renderer->_odtTableOpenUseProperties($properties);
|
||||
|
||||
$properties = array();
|
||||
$properties ['width'] = '1.5cm';
|
||||
$renderer->_odtTableAddColumnUseProperties($properties);
|
||||
|
||||
$properties = array();
|
||||
$properties ['width'] = '13.5cm';
|
||||
$renderer->_odtTableAddColumnUseProperties($properties);
|
||||
|
||||
$renderer->tablerow_open();
|
||||
|
||||
$properties = array();
|
||||
$properties ['vertical-align'] = $css_properties ['vertical-align'];
|
||||
$properties ['text-align'] = 'center';
|
||||
$properties ['padding'] = '0.1cm';
|
||||
$properties ['border'] = '0.002cm solid #000000';
|
||||
$properties ['background-color'] = $css_properties ['background-color'];
|
||||
$renderer->_odtTableCellOpenUseProperties($properties);
|
||||
|
||||
if ($css_properties ['background-image']) {
|
||||
$renderer->_odtAddImage($css_properties ['background-image']);
|
||||
}
|
||||
|
||||
$renderer->tablecell_close();
|
||||
|
||||
$properties = array();
|
||||
$properties ['vertical-align'] = $css_properties ['vertical-align'];
|
||||
$properties ['text-align'] = $css_properties ['text-align'];
|
||||
$properties ['padding'] = '0.3cm';
|
||||
$properties ['border'] = '0.002cm solid #000000';
|
||||
$properties ['background-color'] = $css_properties ['background-color'];
|
||||
$renderer->_odtTableCellOpenUseProperties($properties);
|
||||
break;
|
||||
|
||||
case DOKU_LEXER_UNMATCHED :
|
||||
$renderer->cdata($data);
|
||||
break;
|
||||
|
||||
case DOKU_LEXER_EXIT :
|
||||
$renderer->tablecell_close();
|
||||
$renderer->tablerow_close();
|
||||
$renderer->_odtTableClose();
|
||||
$renderer->p_open();
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
//Setup VIM: ex: et ts=4 enc=utf-8 :
|