Menu
▾
▴
[TWiki-Dev] [SVN] SvenDowideit r15800 - twiki/branches/MAIN/twikiplugins/UpdateAttachmentsPlugin/data/TWiki
|
From: <de...@de...> - 2007-11-27 09:18:50
|
Author: SvenDowideit Date: 2007-11-27 03:18:52 -0600 (Tue, 27 Nov 2007) New Revision: 15800 Trac url: http://develop.twiki.org/trac/changeset/15800 Modified: twiki/branches/MAIN/twikiplugins/UpdateAttachmentsPlugin/data/TWiki/UpdateAttachmentsPlugin.txt Log: Item5002: attempt to reduce spelling mistakes - thanks Arthur Modified: twiki/branches/MAIN/twikiplugins/UpdateAttachmentsPlugin/data/TWiki/UpdateAttachmentsPlugin.txt =================================================================== --- twiki/branches/MAIN/twikiplugins/UpdateAttachmentsPlugin/data/TWiki/UpdateAttachmentsPlugin.txt 2007-11-27 04:44:22 UTC (rev 15799) +++ twiki/branches/MAIN/twikiplugins/UpdateAttachmentsPlugin/data/TWiki/UpdateAttachmentsPlugin.txt 2007-11-27 09:18:52 UTC (rev 15800) @@ -4,7 +4,7 @@ ---+!! !UpdateAttachmentsPlugin <!-- One line description, required for extensions repository catalog. - * Set SHORTDESCRIPTION = A batched alternative to AutoAttachments (adds and removes attachements) + * Set SHORTDESCRIPTION = A batched alternative to !AutoAttachments (adds and removes attachments) --> %SHORTDESCRIPTION% @@ -12,22 +12,24 @@ ---++ Usage -This plugin provides a rest handler that can replace the inbuilt ={AutoAttachPubFiles}= functionality with a batched update. +This plugin provides a rest handler that can replace the inbuilt ={AutoAttachPubFiles}= functionality with a batched update - so you can upload (ftp, drag&drop etc) thousands of images into TWiki's pub area, and then tell TWiki to update the attachments to all your topics. +This will allow you to SEARCH for attachments, use DBCacheContrib & DBCachePlugin, and use any other functionality that relies on the topic files containing references to the attachments. + Doing this may provide a speed advantage as it will remove the need for TWiki to scan the requested topics' attachment directory. Also, it will (optionally) remove attachment references to files that no longer exist in the topic's attachment directory. -Warning: because TWiki does deal well with attachments with special characters (or even spaces) in them, these will be ignored on update. +Warning: because TWiki does not deal well with attachments with special characters (or even spaces) in them, these files will be ignored on update. Warning: checking 28500 topics (many with attachments) takes around 2-3 minutes on my test system, with no plugins that have an beforeSave or afterSave handler registered. ----+++ Triggering an Attachement Update -As this is a TWiki.RestHandler based plugin, you can trigger it to run from a suitably authenticated url (it will only update topics +---+++ Triggering an Attachment Update +As this is a TWiki.RestHandler based plugin, you can trigger it to run from a suitably authenticated URL (it will only update topics your user as permission to edit) - for example, to update the Sandbox web * %SCRIPTURL{rest}%/UpdateAttachmentsPlugin/update?topic=Sandbox.WebHome -Or using a cronjob - make sure the cronjob is running as the same user as twiki's web access is +Or using a cronjob - make sure the cronjob is running as the same user as TWiki's web access is * =./rest UpdateAttachmentsPlugin.update topic Sandbox.WebHome= (if you get a 500 or premature end of script error, chances are your current user does not have permission to change the web or topics) @@ -38,7 +40,7 @@ * =$TWiki::cfg{Plugins}{UpdateAttachmentsPlugin}{UseDangerousNoHandlersSave}= - use with extreme caution, _if_ you understand what the results of a no_handler save are, and _if_ you are able to recover your TWiki if it fails. * =$TWiki::cfg{Plugins}{UpdateAttachmentsPlugin}{Debug}= - to see what topics are updated (edit LocalSite.cfg by hand to add this setting). -It is recomended to disable $TWiki::cfg{AutoAttachPubFiles}. +It is recommended to disable $TWiki::cfg{AutoAttachPubFiles}. ---++ Installation Instructions @@ -48,7 +50,7 @@ ---++ Plugin Info -| Plugin Author(s): | TWiki:Main.SvenDowideit - http://distributedINFORMATION.com a %PUBURL%/%WEB%/%TOPIC%/wikiring.png [[http://WikiRing.com][WikiRing]] founding partner | +| Plugin Author(s): | TWiki:Main.SvenDowideit - http://distributedINFORMATION.com a %PUBURL%/%WEB%/%TOPIC%/wikiringlogo20x20.png [[http://WikiRing.com][WikiRing]] founding partner | | Copyright: | © Sve...@di... | | Attachment Icon | based on eXperience Crystal, by David Christian Berg | | License: | [[http://www.gnu.org/licenses/gpl.html][GPL (Gnu General Public License)]] | @@ -64,5 +66,3 @@ <!-- Do _not_ attempt to edit this topic; it is auto-generated. Please add comments/questions/remarks to the feedback topic on twiki.org instead. --> -%META:FILEATTACHMENT{name="wikiringlogo20x20.png" attr="h" autoattached="1" comment="" date="1196132654" path="wikiringlogo20x20.png" size="1343" version=""}% -%META:FILEATTACHMENT{name="wikiring-attach.png" attr="h" autoattached="1" comment="" date="1196134816" path="wikiring-attach.png" size="34351" version=""}% |