blob: 88c9760a8af12d2acf4f5eb7e1e4b80dcee44b70 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html lang="en">
<HEAD>
<meta name="copyright" content="Copyright (c) IBM Corporation and others 2000, 2011. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="../book.css" CHARSET="ISO-8859-1" TYPE="text/css">
<title>Path variables</title>
<script language="JavaScript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js" type="text/javascript"> </script>
</HEAD>
<BODY BGCOLOR="#ffffff">
<H1 CLASS="Head">Path variables</H1>
<p>
Path variables specify locations on the file system. The location of linked resources
may be specified relative to these path variables. They allow you to avoid references to
a fixed location on your file system.
</p>
<p>
By using a path variable, you can share projects containing linked resources with
team members without requiring the exact same directory structure as on your file
system.
</p>
<p>
Path variables can be either defined at the project level or at the workspace level. Creating
path variables at the project level ensures that projects that contain linked resources using
those path variables remain portable across workspace and computers.
</p>
<p>
Each project contain a pre-defined set of path variables available for defining linked resources,
including <b>ECLIPSE_HOME</b>, <b>PARENT_LOC</b>, <b>PROJECT_LOC</b> and <b>WORKSPACE_LOC</b>.
</p>
<p>
New path variables can be defined relative to existing path variables by using the ${VAR} syntax.
For example, a path variable FOO can be defined relative to BAR by defining it to "${BAR}../foo".
</p>
<p>
You can load a project that uses path variables even if you do not currently have all
the path variables defined in the project or workspace. A linked resource that uses a missing path
variable is flagged using a special decorator icon. In addition, the
<b>File &gt; Properties &gt; Resource</b>
property page and the Properties view
(<a class="command-link" href='javascript:executeCommand("org.eclipse.ui.views.showView(org.eclipse.ui.views.showView.viewId=org.eclipse.ui.views.PropertySheet)")'>
<img src="PLUGINS_ROOT/org.eclipse.help/command_link.svg" alt="command link">
<b>Window &gt; Show View &gt; Other... &gt; General &gt; Properties</b></a>)
for a linked resource indicate the
variable and whether it is defined or not. A path variable can also specify a
location that does not currently exist on the file system. Linked resources that use such
a path variable are indicated using the same decorator icon mentioned above.
</p>
<p>
You can create new path variables and edit and remove existing path variables in
the <b>File &gt; Properties &gt; Resource &gt; Linked Resources</b> property page for a project resource
and at the workspace level on the
<a class="command-link" href='javascript:executeCommand("org.eclipse.ui.window.preferences(preferencePageId=org.eclipse.ui.preferencePages.LinkedResources)")'>
<img src="PLUGINS_ROOT/org.eclipse.help/command_link.svg" alt="command link">
<b>General &gt; Workspace &gt; Linked Resources</b></a> preference page.
</p>
<h3 class="related">Related concepts</h3>
<a href="concepts-13.htm">Linked resources</a><br>
<h3 class="related">Related tasks</h3>
<a href="../tasks/tasks-45.htm">Creating linked resources</a><br>
<a href="../tasks/tasks-49.htm">Viewing resource properties</a><br>
<h3 class="related">Related reference</h3>
<a href="../reference/ref-14b.htm">Linked resources</a>
</BODY>
</HTML>