CopyrightPlugin < TWiki

---+!! <nop>%TOPIC%
<!--
   Contributions to this plugin are appreciated. Please update the plugin page at
   http://twiki.org/cgi-bin/view/Plugins/CopyrightPlugin or provide feedback at
   http://twiki.org/cgi-bin/view/Plugins/CopyrightPluginDev.
   If you are a TWiki contributor please update the plugin in the SVN repository.
-->
<sticky><div style="float:right; background-color:#EBEEF0; margin:0 0 20px 20px; padding: 0 10px 0 10px;">
%TOC{title="Page contents"}%
</div></sticky>
%SHORTDESCRIPTION%

---++ Overview

This plugin is designed for publishing copyright information about topics. The original author (copyright holder) is given to the twiki user that created the topic and this information along with the creation date is kept for copyright notices. Those that edit the topic are also kept for crediting the modifications. The copyright holder can be over ridden with a TWiki variable. 

---++ Syntax Rules

   * =%<nop>AUTHORS%,%<nop>AUTHORS{show="full|holder|modifiers" toc="1" topics=<comma separated list of topics>}%,=

---++ Examples

   * =%<nop>AUTHORS%,%<nop>AUTHORS{MySite:TitleOne,MySite:TitleTwo}%,%<nop>AUTHORS{show="holder"}%=

---++ Plugin Settings

Overload plugin settings in [[%USERSWEB%.TWikiPreferences]] by prefixing the name of the setting with =COPYRIGHTPLUGIN_=, such as =COPYRIGHTPLUGIN_TOPICSEXCLUDE=

   * Set SHORTDESCRIPTION = List copyright information based on topic authors
   * Set USERSEXCLUDE =
   * Set TOPICSEXCLUDE = WebTopicList, WebTopicEditTemplate, WebTopicCreator, WebStatistics, WebSearchAdvanced, WebSearch, WebRss, WebPreferences, WebNotify, WebLeftBar, WebIndex, WebHome, WebChanges, WebAtom

---++ Plugin Installation Instructions

__Note:__ You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the TWiki server.

   * For an __automated installation__, run the [[%SCRIPTURL{configure}%][configure]] script and follow "Find More Extensions" in the in the __Extensions__ section.

   * Or, follow these __manual installation__ steps:
      * Download the ZIP file from the Plugins home (see below).
      * Unzip ==%TOPIC%.zip== in your twiki installation directory. Content:
        | *File:* | *Description:* |
        | ==data/TWiki/%TOPIC%.txt== | Plugin topic |
        | ==lib/TWiki/Plugins/%TOPIC%.pm== | Plugin Perl module |
      * Set the ownership of the extracted directories and files to the webserver user.

   * Plugin __configuration__:
      * Run the [[%SCRIPTURL{configure}%][configure]] script and enable the plugin in the __Plugins__ section.

---++ Plugin Info

|  Plugin Author: | TWiki:Main.AleksandarErkalovic |
|  Copyright: | &copy; 2007, TWiki:Main.AleksandarErkalovic <br /> &copy; 2008-2011 TWiki:TWiki.TWikiContributor |
|  License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) |
|  Plugin Version: | 2011-03-05 |
|  Change History: | <!-- versions below in reverse order -->&nbsp; |
|  2011-03-05: | Doc fixes; changing TWIKIWEB to SYSTEMWEB -- TWiki:Main.PeterThoeny |
|  2007-04-29: | Initial version |
|  TWiki Dependency: | $TWiki::Plugins::VERSION 1.1 |
|  CPAN Dependencies: | List::Compare::Functional  |
|  Other Dependencies: | none |
|  Perl Version: | 5.005 or above |
|  [[TWiki:Plugins/Benchmark][Benchmarks]]: | %SYSTEMWEB%.GoodStyle nn%, %SYSTEMWEB%.FormattedSearch nn%, %TOPIC% nn% |
|  Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC% |
|  Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev |
|  Appraisal: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal |

__Related Topics:__ %SYSTEMWEB%.TWikiPlugins, %SYSTEMWEB%.DeveloperDocumentationCategory, %SYSTEMWEB%.AdminDocumentationCategory, %SYSTEMWEB%.TWikiPreferences
This topic: TWiki > CopyrightPlugin
Topic revision: r2 - 2019-01-03 - TWikiAdminUser
Copyright &© 1999-2025 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.CopyrightPlugin.