diff options
Diffstat (limited to 'plugins/help')
| -rw-r--r-- | plugins/help/README | 1 | ||||
| -rw-r--r-- | plugins/help/content/about.html | 37 | ||||
| -rw-r--r-- | plugins/help/content/license.html | 387 | ||||
| -rw-r--r-- | plugins/help/help.php | 90 | ||||
| -rw-r--r-- | plugins/help/localization/en_UK.inc | 8 | ||||
| -rw-r--r-- | plugins/help/localization/en_US.inc | 8 | ||||
| -rw-r--r-- | plugins/help/localization/pl_PL.inc | 8 | ||||
| -rw-r--r-- | plugins/help/skins/default/help.css | 26 | ||||
| -rw-r--r-- | plugins/help/skins/default/help.gif | bin | 0 -> 1146 bytes | |||
| -rw-r--r-- | plugins/help/skins/default/templates/help.html | 38 |
10 files changed, 603 insertions, 0 deletions
diff --git a/plugins/help/README b/plugins/help/README new file mode 100644 index 000000000..f1298763a --- /dev/null +++ b/plugins/help/README @@ -0,0 +1 @@ +Please refer to main plugin script ...
\ No newline at end of file diff --git a/plugins/help/content/about.html b/plugins/help/content/about.html new file mode 100644 index 000000000..afaded6f4 --- /dev/null +++ b/plugins/help/content/about.html @@ -0,0 +1,37 @@ +<div id="helpabout"> +<h3 align="center">Copyright © 2005-2009, RoundCube Dev. - Switzerland</h3> + +<p>This program is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License version 2 +as published by the Free Software Foundation. +</p> +<p> +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. +</p> +<p> +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., +51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. +</p> + +<div align="center"> +<h3>Project management and administration</h3> +<b>Thomas Bruederli (thomasb)</b> - Project leader and head developer<br /> +<b>Till Klampäckel (till)</b> - Co-leader<br /> +<b>Brett Patterson</b> - Forum administrator<br /> +<b>Adam Grelck</b> - Trac administrator<br /> +<b>Jason Fesler</b> - Mailing list administrator<br /> +<b>Brennan Stehling</b> - Mentor, Coordinator + +<h3>Developers</h3> +<b>Eric Stadtherr (estadtherr)</b><br /> +<b>Robin Elfrink (robin, wobin)</b><br /> +<b>Rich Sandberg (richs)</b><br /> +<b>Tomasz Pajor (tomekp)</b><br /> +<b>Fourat Zouari (fourat.zouari)</b><br /> +<b>Aleksander Machniak (alec)</b> +</div> +</div> diff --git a/plugins/help/content/license.html b/plugins/help/content/license.html new file mode 100644 index 000000000..2d83c6013 --- /dev/null +++ b/plugins/help/content/license.html @@ -0,0 +1,387 @@ +<div id="helplicense"> +<h3>GNU GENERAL PUBLIC LICENSE</h3> +<p> +Version 2, June 1991 +</p> + +<pre> +Copyright (C) 1989, 1991 Free Software Foundation, Inc. +51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA + +Everyone is permitted to copy and distribute verbatim copies +of this license document, but changing it is not allowed. +</pre> + +<h3>Preamble</h3> + +<p> +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 Lesser General Public License instead.) You can apply it to +your programs, too. +</p> + +<p> +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. +</p> + +<p> +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. +</p> + +<p> +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. +</p> + +<p> +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. +</p> + +<p> +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. +</p> + +<p> +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. +</p> + +<p> + The precise terms and conditions for copying, distribution and +modification follow. +</p> + + +<h3>TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION</h3> + + +<p> +<strong>0.</strong> +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". +</p> + +<p> +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. +</p> + +<p> +<strong>1.</strong> +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. +</p> + +<p> +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. +</p> + +<p> +<strong>2.</strong> +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: +</p> + +<dl> + <dt></dt> + <dd> + <strong>a)</strong> + You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + </dd> + <dt></dt> + <dd> + <strong>b)</strong> + 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. + </dd> + <dt></dt> + <dd> + <strong>c)</strong> + 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.) + </dd> +</dl> + +<p> +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. +</p> + +<p> +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. +</p> + +<p> +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. +</p> + +<p> +<strong>3.</strong> +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: +</p> + +<dl> + <dt></dt> + <dd> + <strong>a)</strong> + 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, + </dd> + <dt></dt> + <dd> + <strong>b)</strong> + 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, + </dd> + <dt></dt> + <dd> + <strong>c)</strong> + 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.) + </dd> +</dl> + +<p> +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. +</p> + +<p> +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. +</p> + +<p> +<strong>4.</strong> +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. +</p> + +<p> +<strong>5.</strong> +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. +</p> + +<p> +<strong>6.</strong> +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. +</p> + +<p> +<strong>7.</strong> +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. +</p> + +<p> +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. +</p> + +<p> +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. +</p> + +<p> +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. +</p> + +<p> +<strong>8.</strong> +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. +</p> + +<p> +<strong>9.</strong> +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. +</p> + +<p> +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. +</p> + +<p> +<strong>10.</strong> +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. +</p> + +<p><strong>NO WARRANTY</strong></p> + +<p> +<strong>11.</strong> +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. +</p> + +<p> +<strong>12.</strong> +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. +</p> +</div> diff --git a/plugins/help/help.php b/plugins/help/help.php new file mode 100644 index 000000000..336321c88 --- /dev/null +++ b/plugins/help/help.php @@ -0,0 +1,90 @@ +<?php + +/** + * Help Plugin + * + * @author Aleksander 'A.L.E.C' Machniak + * @licence GNU GPL + * + * Enable the plugin in config/main.inc.php and set Help content iframe source + * $rcmail_config['help_source'] = 'http://trac.roundcube.net/wiki'; + * + **/ + +class help extends rcube_plugin +{ + function init() + { + $this->add_texts('localization/', false); + + // register actions + $this->register_action('plugin.help', array($this, 'action')); + $this->register_action('plugin.helpabout', array($this, 'action')); + $this->register_action('plugin.helplicense', array($this, 'action')); + + // add taskbar button + $this->add_button(array( + 'name' => 'helptask', + 'class' => 'button-help', + 'label' => 'help.help', + 'href' => './?_task=dummy&_action=plugin.help', + ), 'taskbar'); + + $skin = rcmail::get_instance()->config->get('skin'); + if (!file_exists($this->home."/skins/$skin/help.css")) + $skin = 'default'; + + // add style for taskbar button (must be here) and Help UI + $this->include_stylesheet("skins/$skin/help.css"); + } + + function action() + { + $rcmail = rcmail::get_instance(); + + // register UI objects + $rcmail->output->add_handlers(array( + 'helpcontent' => array($this, 'content'), + )); + + if ($rcmail->action == 'plugin.helpabout') + $rcmail->output->set_pagetitle($this->gettext('about')); + else if ($rcmail->action == 'plugin.helplicense') + $rcmail->output->set_pagetitle($this->gettext('license')); + else + $rcmail->output->set_pagetitle($this->gettext('help')); + + $rcmail->output->send('help.help'); + } + + function content($attrib) + { + $rcmail = rcmail::get_instance(); + + if ($rcmail->action == 'plugin.helpabout') { + return @file_get_contents($this->home.'/content/about.html'); + } + else if ($rcmail->action == 'plugin.helplicense') { + return @file_get_contents($this->home.'/content/license.html'); + } + + // default content: iframe + + if ($src = $rcmail->config->get('help_source')) + $attrib['src'] = $src; + + if (empty($attrib['id'])) + $attrib['id'] = 'rcmailhelpcontent'; + + // allow the following attributes to be added to the <iframe> tag + $attrib_str = create_attrib_string($attrib, array('id', 'class', 'style', 'src', 'width', 'height', 'frameborder')); + $framename = $attrib['id']; + + $out = sprintf('<iframe name="%s"%s></iframe>'."\n", $framename, $attrib_str); + + return $out; + } + +} + +?> diff --git a/plugins/help/localization/en_UK.inc b/plugins/help/localization/en_UK.inc new file mode 100644 index 000000000..cfc3980a4 --- /dev/null +++ b/plugins/help/localization/en_UK.inc @@ -0,0 +1,8 @@ +<?php + +$labels = array(); +$labels['help'] = 'Help'; +$labels['about'] = 'About'; +$labels['license'] = 'Licence'; + +?> diff --git a/plugins/help/localization/en_US.inc b/plugins/help/localization/en_US.inc new file mode 100644 index 000000000..8c2d1517c --- /dev/null +++ b/plugins/help/localization/en_US.inc @@ -0,0 +1,8 @@ +<?php + +$labels = array(); +$labels['help'] = 'Help'; +$labels['about'] = 'About'; +$labels['license'] = 'License'; + +?> diff --git a/plugins/help/localization/pl_PL.inc b/plugins/help/localization/pl_PL.inc new file mode 100644 index 000000000..087bc0726 --- /dev/null +++ b/plugins/help/localization/pl_PL.inc @@ -0,0 +1,8 @@ +<?php + +$labels = array(); +$labels['help'] = 'Pomoc'; +$labels['about'] = 'O programie'; +$labels['license'] = 'Licencja'; + +?> diff --git a/plugins/help/skins/default/help.css b/plugins/help/skins/default/help.css new file mode 100644 index 000000000..7ccc671a2 --- /dev/null +++ b/plugins/help/skins/default/help.css @@ -0,0 +1,26 @@ +/***** RoundCube|Mail Help task styles *****/ + +#taskbar a.button-help +{ + background-image: url('help.gif'); +} + +#help-box +{ + position: absolute; + bottom: 30px; + top: 95px; + left: 20px; + right: 20px; + border: 1px solid #999999; + overflow: auto; + background-color: #F2F2F2; + /* IE hack */ + height: expression((parseInt(document.documentElement.clientHeight)-125)+'px'); + width: expression((parseInt(document.documentElement.clientWight)-40)+'px'); +} + +#helplicense, #helpabout +{ + padding: 20px; +} diff --git a/plugins/help/skins/default/help.gif b/plugins/help/skins/default/help.gif Binary files differnew file mode 100644 index 000000000..1ae90320c --- /dev/null +++ b/plugins/help/skins/default/help.gif diff --git a/plugins/help/skins/default/templates/help.html b/plugins/help/skins/default/templates/help.html new file mode 100644 index 000000000..14b8fca52 --- /dev/null +++ b/plugins/help/skins/default/templates/help.html @@ -0,0 +1,38 @@ +<!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"> +<head> +<title><roundcube:object name="pagetitle" /></title> +<roundcube:include file="/includes/links.html" /> +<link rel="stylesheet" type="text/css" href="/this/help.css" /> +<link rel="stylesheet" type="text/css" href="/settings.css" /> +<script type="text/javascript"> +function help_init_settings_tabs() +{ + var tab = '#helptabdefault'; + if (window.rcmail && rcmail.env.action) { + var action = rcmail.env.action.replace(/^plugin\.help/, ''); + tab = '#helptab' + (action ? action : 'default'); + } + $(tab).addClass('tablink-selected'); +} +</script> +</head> +<body> + +<roundcube:include file="/includes/taskbar.html" /> +<roundcube:include file="/includes/header.html" /> + +<div id="tabsbar"> +<span id="helptabdefault" class="tablink"><roundcube:button name="helpdefault" href="?_task=dummy&_action=plugin.help" type="link" label="help.help" title="help.help" /></span> +<span id="helptababout" class="tablink"><roundcube:button name="helpabout" href="?_task=dummy&_action=plugin.helpabout" type="link" label="help.about" title="help.about" class="tablink" /></span> +<span id="helptablicense" class="tablink"><roundcube:button name="helplicense" href="?_task=dummy&_action=plugin.helplicense" type="link" label="help.license" title="help.license" class="tablink" /></span> +<roundcube:container name="helptabs" id="helptabsbar" /> +<script type="text/javascript"> if (window.rcmail) rcmail.add_onload(help_init_settings_tabs);</script> +</div> + +<div id="help-box"> +<roundcube:object name="helpcontent" id="helpcontentframe" width="100%" height="100%" frameborder="0" src="/watermark.html" /> +</div> + +</body> +</html> |
