DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:orphanmedia

OrphanMedia Plugin

Compatible with DokuWiki

anteater, rincewind, angua, "Adora Belle"

plugin Find orphan and missing media files.

Last updated on
2015-06-07
Provides
Syntax
Repository
Source

Installation

Install the plugin using the Plugin Manager and the download URL above, which points to latest version of the plugin.
Refer to Plugins on how to install plugins manually.

Or just download and extract it as folder “orphanmedia” into your “\lib\plugins” directory.

Changes

Examples/Usage

Example: fcon/doku.php?id=orphanmedia:example
Use this plugin to find orphan and missing media files within your DokuWiki. There are 4 options provided to get the related information.

OrphanMedia show which medias are:

Option Output
all will display the complete set of results of the other parameters togethers
summary Counter based information:
# of Page files
# of Media files
# of Media references
→ Filter settings
# of valid, qualified references
# of valid, relative references
# of Missing media files
# of Orphan media files
valid all valid media links referenced by full qualified path will be displayed
relative all valid media links referenced by relative path will be displayed
missing Missing Media, the media file does not exist, but there are link(s) to it elsewhere on the pages
orphan Orphan Media, the media file exists, but not linked and wasting space only

Detection & Limits

Link Type Comment
standard, local DW media links
{{:ns:mediafile|title}}
full qualified links also as relative links, with or without parameters, all detected
enclosed DW media links
<box params|{{:ns:mediafile|title}}>
all detected
specials excluded medialinks within <code>, <file>, <nowiki>, <php>, <html> and %% are ignored
further can be excluded by adding regexpr to plugin conf
linked external media files
{{http://www.wherever.com/whatsoever.type}}
all detected; if valid, they will be viewed within relative section.
Attention:
mediafile will be displayed as missing in the event a login will be neccesary to open it
(e.g. linked documents from CMS)
gallery plugin references
{{gallery ...
not recognized, will be displayed as orphan if not otherwise linked
flashplayer flashplayer may work for local files (not yet tested sufficiently)
unc path not yet tested sufficiently
windows shares not yet tested sufficiently

Syntax

Basic usage is to place one of the following five syntax lines into the page markup of a page with Admin/Superuser ACL:

 ====== Orphan Media detection ======
  ~~NOCACHE~~
  ~~ORPHANMEDIA:all~~
  ~~ORPHANMEDIA:summary~~
  ~~ORPHANMEDIA:valid~~
  ~~ORPHANMEDIA:relative~~
  ~~ORPHANMEDIA:missing~~
  ~~ORPHANMEDIA:orphan~~

The summary will be displayed in any case.

You can combine outputs. For instance you want to see the summary, missing and orphan option only
the following syntax is valid (put the options together without delimiter):

~~ORPHANMEDIA:missingorphan~~

Further you can specify a filter to limit the output to then specified file-extension according
following example (add file-extensions separated by “:”):

~~ORPHANMEDIA:all:png:jpg:gif~~

:!: The summary counters will be affected accordingly beside the limited output.

It does also check for flashplayer-plugin links if they refer to local path.

Development

Each valuable help is welcome. The code is not that complicated, just looping through and
displaying some filename and path info without any effect to your source.

Change Log

Date Reason
2012-02-02 Intermediate release regarding git issue 11 + enhanced preview sizing of orphan pictures and considers mime type icons on other files
2012-01-27 Improved detection of medialinks especially if enclosed by tags of other syntax plugins
2012-01-10 BugFix: Issue 36, multiple media links within one section
2011-12-20 Updates: Windows fileshares, etc.
2011-12-15 Reworked Plugin: syntax slightly modified, flashplayer links considered
2011-11-26 New Feature: Filter output for defined file extension
2011-04-11 zip-bundle for download created incl. bug-fix if only one missing/orphan file existent and version info, etc. updated
2011-03-12 corrected html output on all function
2011-03-11 fixed link problem for pages with missing media
fixed problem on show details of orphan media files
2011-03-08 change on orphan media output (e.g. incl. small picture preview) and missing media (e.g. listed pages are links now)
2011-03-07 parameter mismatch corrected
2011-03-03 syntax parameter added and corrections (tag/topic links, html table output)
thanks to Flam for your comments and help
2011-02-28 Initial release

Version/Requirements

The plugin was tested with DW 2010-11-07 “Anteater”, 2011-05-25 “Rincewind” and also with related on the Stick versions.
This is not the guarantee that it works for all installations due to PHP version dependencies (5.2+).

Weakpoint

If you have multiple pictures named e.g. Image006.gif then the tool fails.
Please try to keep good style by authoring and give descriptive names to your media files.

Known Bugs and Issues

It could happen that not all media files will be detected or some feed links, etc. interpreted as such.
I tried to filter that out but due to that many syntax plugins it cannot catch all issues.
If you have a real problem please tell me the root cause of your problem at: Orphanmedia - IssueTracker

Sites using this Plugin

Discussion

Please use only the DokuWiki Forum for discussion. To report an issue please refer to: OrphanMedia Issues

Bug Report

  • Wrong date @ plugin.info.txt: should be 2015-06-07 instead of 2015-04-30. The result is, that the extension manager always reports, that there is an update available, even when the latest version is installed. — CasperCasper
    casper

    2015-09-08 23:22
plugin/orphanmedia.txt · Last modified: 2016-01-12 20:24 by 109.110.43.10