<?xml version="1.0" encoding="UTF-8"?>
<!-- generator="wordpress/2.0.12-alpha" -->
<rss version="2.0" 
	xmlns:content="http://purl.org/rss/1.0/modules/content/"
	xmlns:wfw="http://wellformedweb.org/CommentAPI/"
	xmlns:dc="http://purl.org/dc/elements/1.1/"
	>

<channel>
	<title>Jeffrey Friedl's Blog</title>
	<link>http://regex.info/blog</link>
	<description>Not a photo blog, but sometimes I play one on TV</description>
	<pubDate>Thu, 04 Dec 2008 14:35:33 +0000</pubDate>
	<generator>http://wordpress.org/?v=2.0.12-alpha</generator>
	<language>en</language>
			<item>
		<title>Installation and Management of Lightroom Plugins</title>
		<link>http://regex.info/blog/lightroom-goodies/plugin-installation/</link>
		<comments>http://regex.info/blog/lightroom-goodies/plugin-installation/#comments</comments>
		<pubDate>Sun, 27 Jul 2008 22:47:40 +0000</pubDate>
		<dc:creator>Jeffrey Friedl</dc:creator>
		
		<category>General</category>

		<guid isPermaLink="false">http://regex.info/blog/lightroom-goodies/plugin-installation/</guid>
		<description><![CDATA[


Quick Links
&#183; My Lightroom Goodies
&#183; My Photo-Tech Posts
&#183; My Blog



<br style='display:block;margin:5px'/>( This post is for Lightroom 2.0 and later. See here for plugin
installation in Lightroom 1.x )

<br style='display:block;margin:5px'/>Starting with Lightroom 2.0, plugins are added
and maintained via the Plugin Manager, which is accessible from
Lightroom's File menu, and also from a button on the Export Dialog
itself.

<br style='display:block;margin:5px'/>Here's a screenshot of the Plugin Manager on my system, after I
installed half a dozen plugins. At the moment, it's showing my
&#8220;Metadata Wrangler&#8221; plugin selected. Mouseover the labels at
left to highlight areas of the screenshot...

 


(Mouseover items below)

List of plugins I'vealready registered

Register new plugins here
Info / [...]]]></description>
			<content:encoded><![CDATA[

<div style='float:right; position:relative; border: dotted 1px #888; margin: 0 auto; margin-left:2em; padding:20px; padding-top:5px; background-color: #000'>
<center style='font-weight:bold; font-size:120%'>Quick Links</center>
<br/>&middot; <a class='quiet' href='http://regex.info/blog/lightroom-goodies/' style='color:#F55'>My Lightroom Goodies</a>
<br/>&middot; <a class='quiet' href='http://regex.info/blog/photo-tech/'>My Photo-Tech Posts</a>
<br/>&middot; <a class='quiet' href='http://regex.info/blog'>My Blog</a>
</div>


<p>( This post is for Lightroom 2.0 and later. See <a
href='http://regex.info/blog/2007-11-17/638'>here</a> for plugin
installation in Lightroom 1.<i>x</i> )</p>

<p style='margin-top:30px'>Starting with Lightroom 2.0, plugins are added
and maintained via the <b>Plugin Manager</b>, which is accessible from
Lightroom's <b>File</b> menu, and also from a button on the Export Dialog
itself.</p>

<p>Here's a screenshot of the Plugin Manager on my system, after I
installed half a dozen plugins. At the moment, it's showing my
&#8220;<a href='http://regex.info/blog/lightroom-goodies/metadata-wrangler/'>Metadata Wrangler</a>&#8221; plugin selected. Mouseover the labels at
left to highlight areas of the screenshot...</p>

<style type="text/css">
  #post884 .h         { font-weight: bold; font-size: 120% }
  #post884 .hh        { border-bottom: dotted 1px #888 }
  #post884 .hh:hover  { border:none }
  #x884 li            { margin-bottom: 20px }
  #i884 li            { padding: 5px }
</style>
<table>
<tr valign='top'><td id='x884'>
<b>(Mouseover items below)</b>
<ul style='margin-left:0;padding-left:1em' id='i884'>
<li onmouseover='mobin(this, "x884C")' onmouseout='mobout(this, "x884C")'><span class='hh'>List of plugins I've<br/>already registered</span></li>

<li onmouseover='mobin(this, "x884A")' onmouseout='mobout(this, "x884A")'><span class='hh'>Register new plugins here</span></li>
<li onmouseover='mobin(this, "x884D")' onmouseout='mobout(this, "x884D")'><span class='hh'>Info / tools for the<br/>highlighted plugin</span></li>

<li onmouseover='mobin(this, "x884B")' onmouseout='mobout(this, "x884B")'><span class='hh'>Some plugins provide<br/>additional sections</span></li>
<li onmouseover='mobin(this, "x884E")' onmouseout='mobout(this, "x884E")'><span class='hh'>Opens Adobe's<br/>Plugin Exchange<br/>in a browser</span></li>
</ul>
</td><td><div style='position:relative'>
  <a
href='http://regex.info/blog/lightroom-goodies/metadata-wrangler/'><img src="http://regex.info/i/lr/PluginManager.png" width="722" height="517"
class="raw"/></a>
  <img src="http://regex.info/i/lr/PluginManagerA.png" width="722" height="517"
class="raw"
id="x884A"
noindex="1"
style="visibility:hidden; position:absolute; left:0; top:0"/>
  <img src="http://regex.info/i/lr/PluginManagerB.png" width="722" height="517"
class="raw"
id="x884B"
noindex="1"
style="visibility:hidden; position:absolute; left:0; top:0"/>
  <img src="http://regex.info/i/lr/PluginManagerC.png" width="722" height="517"
class="raw"
id="x884C"
style="visibility:hidden; position:absolute; left:0; top:0"/>
  <img src="http://regex.info/i/lr/PluginManagerD.png" width="722" height="517"
class="raw"
id="x884D"
noindex="1"
style="visibility:hidden; position:absolute; left:0; top:0"/>
  <img src="http://regex.info/i/lr/PluginManagerE.png" width="722" height="517"
class="raw"
id="x884E"
noindex="1"
style="visibility:hidden; position:absolute; left:0; top:0"/>
</div>
</td></tr>
</table>

<p style='margin-bottom:0' class='h'>Installing a New Plugin</p>
<p style='margin-top:0'>(short version)</p>

<p>Installing a plugin for use with Lightroom 2 and later usually involves these steps:</p>

<ol><li>Downloading a zip file from the plugin source.</li>
<li>Unzip the plugin, and move the resulting &#8220;...lrplugin&#8221; <b>folder</b> to wherever you'd like to store your plugins.</li>
<li>Bring up Lightroom's <b>Plugin Manager</b> and register that folder with the <b><span class='hh' onmouseover='mobin(this, "A")' onmouseout='mobout(this, "A")'>Add</span></b> button.<br/>(If prompted for a catalog update, do so.)</li>
</ol>

<p style='margin-bottom:0;margin-top:60px' class='h'>Installing a New Plugin</p>
<p style='margin-top:0'>(long version)</p>

<p><b>1. Download a zip file from a plugin source</b></p>
<div style='margin-left:1em'>

<p>Plugins are available from a variety of sources. My plugins are available
from <a href='http://regex.info/blog/lightroom-goodies/'>my Lightroom
goodies</a> page. Tim Armes has written <a
href='http://www.timothyarmes.com/metoyou.php?lang=en-gb&#038;sec=tools'>a
number of plugins</a> as well. The central listing of Lightroom plugins is
<a
href='http://www.adobe.com/cfusion/exchange/index.cfm?event=productHome&#038;exc=25&#038;loc=en_us'>Adobe's
Lightroom Exchange</a>.</p>

<p>After unzipping, you should end up with a <b><i>folder</i></b> whose name ends in
&#8220;<b>.lrplugin</b>&#8221; or&#8220;<b>.lrdevplugin</b>&#8221;. On a
Mac, a &#8220;.lrplugin&#8221; folder actually appears as a &#8220;module&#8221;
package.</p>

<p>You don't normally ever need to be concerned with the contents of a
plugin folder, but if you need to confirm that the folder actually contains
a plugin in the first place, check for an &#8220;Info.lua&#8221; file. (On Macs, you
may need to &#8220;Show Package Contents&#8221; in Finder to view the files
inside.) <span class='nobr'>I mention</span> this because some programs
that produce zip files create a <span
class='nobr'>&#8220...<b>.</b>lrplugin&#8221;</span> folder <i>into
which</i> they drop the actual plugin &#8220;.lrplugin&#8221; folder, which
can cause confusion.</p>

</div>
<p><b>2. Move the plugin folder to wherever you'd like to store your plugins</b></p>
<div style='margin-left:1em'>

<p>Starting with Version 2.0, Lightroom allows you to keep the plugins
wherever you like &mdash; you just have to tell it where you place each one
&mdash; so it's up to you to pick a spot to save them. For example, <span
class='nobr'>I usually</span> create a &#8220;Plugins&#8221; folder in one of the
Lightroom data folders, and then drop plugin folders in there. Here are the
locations <span class='nobr'>I create</span> for plugins:</p>

<table style='margin-left:1em; border: solid 1px #333; padding: 10px 1em'>
<tr><td>Windows XP</td><td>  %APPDATA%\Adobe\Lightroom\Plugins\</td></tr>
<tr><td>Windows Vista&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td><td>\Users\<i>username</i>\AppData\Roaming\Adobe\Lightroom\Plugins\</td></tr>
<tr><td>Mac OSX</td><td>~/Library/Application Support/Adobe/Lightroom/Plugins/</td></tr>
</table>

<p>Again, you're free to pick wherever you like, with the caveat that
Lightroom treats some of its application-data folders specially (as <a href='#legacy'>discussed</a> below).</p>

</div>
<p><b>3. Register the plugin with Lightroom</b></p>
<div style='margin-left:1em'>

<p>Bring up Lightroom's <b>Plugin Manager</b>, either from the <b>File</b>
menu, or from the <b>Plugin Manager</b> button on the Export Dialog. Click
the <b>Add</b> button, then navigate to the &#8220;.lrplugin&#8221; folder.</p>

<img src="http://regex.info/i/lr/UpdateCatalog.png" width="428" height="161"
class="img_right raw"/>

<p>Some plugins add their own set of per-image metadata to the catalog, and
for such plugins, you are prompted for permission to update the catalog
upon install. You should upgrade.</p>

<p>For example, my &#8220;<a
href='http://regex.info/blog/lightroom-goodies/flickr/'>Update to
Flickr</a>&#8221; plugin maintains in the catalog data about which images
have been updated to Flickr, and their location at Flickr. This supports a
number of features, such as the ability to replace an image during upload,
the ability to filter within Lightroom for images that have/haven't been
updated, the ability to include the Flickr-upload-status in Lightroom smart
collections, etc.</p>

<p>You are also prompted in the same way when upgrading a plugin if the new
version has any changes to the set of custom plugin metadata.</p>

</div>

<p class='h'><a name='using'>Using an Export Plugin</a></p>

<p>An export plugin can be selected by bringing up Lightroom's export
dialog, then clicking on the &#8220;Files on Disk&#8221; banner across its top. That
brings up a popup list of the export handlers available (both the built-in
ones, and the ones you've added via the Plugin Manager)....</p>

<div class='ic'><img src="http://regex.info/i/lr/ExportDestination.png" width="633" height="242"
class="raw"/></div>

<p class='h'>Using a Filter Plugin (a &#8220;Post-Process Action&#8221; Plugin)</p>

<p>Some plugins aren't intended to be an export destination, but, rather,
to provide generic support for any export. For example, my <a
href='http://regex.info/blog/lightroom-goodies/metadata-wrangler/'>Metadata
Wrangler plugin</a> allows you to strip selected metadata from exported
copies as they are produced. It can be used with the built-in &#8220;Export to
Disk&#8221; standard export, with my &#8220;Export to....&#8221; plugins (e.g. Export to
Flickr), or with other third-party export plugins.</p>

<p>Adobe calls these &#8220;Post-process Actions&#8221;, but most people call them
&#8220;Export Filters&#8221;.</p>

<p>Once you've added and enabled a filter plugin via the Plugin Manager, it
shows up in the lower-left of the export dialog....</p>

<div class='ic tight'><img src="http://regex.info/i/lr/PluginFilter.png" width="665" height="265"
class="raw"/></div>

<p>Click on its name, then the <b>Insert</b> button at the bottom, and
you'll see it added to the main dialog. In the screen snippet above, the
&#8220;Metadata Wrangler&#8221; dialog section is shown collapsed, so you only see its
banner. If you were to click on the little triangle beside the name, you'd
see the full dialog for the plugin, which, in this case (my Metadata
Wrangler filter) is huge (see <a
href='http://regex.info/blog/lightroom-goodies/metadata-wrangler/'>here</a>
for a screenshot).</p>

<p class='h'>Plugin Maintenance &amp; Upgrades</p>

<p>Once a plugin has been registered with Lightroom, you can enable or
disable it from the <b>Status</b> section of the Plugin Manager. A disabled
plugin can't be used from within Lightroom, but remains registered in the
Plugin Manager, so can be easily enabled for use.</p>

<p>You can fully de-register a plugin with the <b>Remove</b> button, on the
bottom of the left-hand column. Plugins installed in legacy plugin
locations &ndash; the locations that plugins had to be installed for
Lightroom 1.<i>x</i> &ndash; can't be removed this way, and the
<b>Remove</b> button remains gray. You have to actually remove the folder.

</p>

<p>The <b>Status</b> section might also display plugin version and web-site
information, if the plugin provides it (such as in the screenshot
above).</p>

<p><b>Upgrading a plugin</b></p>

<p>Upgrading a plugin to a newer version is similar to installing the first
time, except that if you <i>replace</i> the original
&#8220;.lrplugin&#8221; folder with the new one, you don't have to
re-register the location with Lightroom. In that case, you simply need to
restart Lightroom, or click the &#8220;<b>Reload Plug-in</b>&#8221; button
in the Plugin-Manager's &#8220;Plug-in Author Tools&#8220; section.</p>

<p>If you install the new version in a new location, and register it via
the Plugin Manager, the previous version will remain, but be disabled. You
can enable only one version of any particular plugin at a time. Simply
<b>Remove</b> the older versions when you no longer need them.</p>

<p><b><a name='upgrade'>Upgrading one of my plugins</a></b></p>

<img src="http://regex.info/i/lr/UpgradePlugin.png" width="557" height="163"
class="raw img_right"/>

<p>I've built an upgrade mechanism into my plugins, such that when a new
version is available, you can simply press the <b>Upgrade Now</b> button in
the Plugin Manager. That causes the new version to be downloaded and
unzipped in place over top of the old version. You then press the <b>Reload
Plug-in</b> button, or restart Lightroom, to have the new version take
effect.</p>

<p>(If something goes wrong with the upgrade process, you'll have to
manually download and install the new version. In such a case, you might
want to inspect the log file left in the temporary-files area of the
system, named for the plugin, e.g. &#8220;flickr-log.txt&#8221; for the
Flickr plugin).</p>

<p class='h'><a name='legacy'>Legacy Plugin Folders</a></p>

<p>If Lightroom 2.0 finds a plugin in any of the legacy install locations
from Lightroom 1.<i>x</i> (described <a
href='http://regex.info/blog/2007-11-17/638'>here</a>), they are
automatically registered with the Plugin Manager.</p>

<p>As with any plugin, such auto-registered plugins can be enabled and
disabled within the Plugin Manager. They can not, however, be fully
de-registered (removed) via the Plugin Manager. To remove them completely
from Lightroom, you have to manually remove the plugins from disk (or, at
least, from the legacy plugin folders).</p>

<p>Some people prefer to continue to use the legacy install locations,
simply adding new plugins there (thereby avoiding the need to register them
with the Plugin Manager). This approach is perfectly acceptable, of course,
but comes with the drawback that added plugins are not auto-registered
except when Lightroom starts.</p>

]]></content:encoded>
			<wfw:commentRss>http://regex.info/blog/lightroom-goodies/plugin-installation/feed/</wfw:commentRss>
		</item>
	</channel>
</rss>
