Skip to content

Commit 598ba48

Browse files
committed
Html 5 fixes
Contributes to #3275
1 parent d8ae45c commit 598ba48

60 files changed

Lines changed: 305 additions & 481 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv.htm

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
1-
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><html lang="en">
1+
<!DOCTYPE HTML><html lang="en">
22
<HEAD>
33

44
<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." >
55

6-
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1">
7-
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
8-
9-
<LINK REL="STYLESHEET" HREF="../book.css" CHARSET="ISO-8859-1" TYPE="text/css">
6+
<meta charset="utf-8">
107
<TITLE>Advanced resource concepts</TITLE>
118

129
<link rel="stylesheet" type="text/css" HREF="../book.css">
@@ -15,7 +12,7 @@
1512
<H1>
1613
Advanced resource concepts</H1>
1714
<p>In <a href="resInt.htm">Resources overview</a> we took a look at the
18-
basic services and APIs provided by the <tt>org.eclipse.core.resources</tt>
15+
basic services and APIs provided by the <code>org.eclipse.core.resources</code>
1916
plug-in. This and other related plug-ins also contain many advanced features that are useful
2017
for plug-ins that require a deeper level of integration. For details on these advanced
2118
features, take a gander at some of these topics:

eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_batching.htm

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
1-
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><html lang="en">
1+
<!DOCTYPE HTML><html lang="en">
22
<HEAD>
33

44
<meta name="copyright" content="Copyright (c) IBM Corporation and others 2000, 2005. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
55

6-
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1">
7-
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
8-
9-
<LINK REL="STYLESHEET" HREF="../book.css" CHARSET="ISO-8859-1" TYPE="text/css">
6+
<meta charset="utf-8">
107
<TITLE>
118
Batching resource changes
129
</TITLE>
@@ -65,10 +62,10 @@ <h4>Scheduling Rules and Locking</h4>
6562
</pre>
6663
<p>The runnable is passed to the workspace, followed by the project that the
6764
code is manipulating. This tells the workspace that all of the changes in the
68-
runnable are confined to <tt>myProject</tt>. Any requests by other threads
69-
to change <tt>myProject</tt> will be blocked until this runnable completes.
65+
runnable are confined to <code>myProject</code>. Any requests by other threads
66+
to change <code>myProject</code> will be blocked until this runnable completes.
7067
Likewise, this call will block if some other thread is already modifying
71-
<tt>myProject</tt>. By specifying which part of the resource tree will be
68+
<code>myProject</code>. By specifying which part of the resource tree will be
7269
modified by the runnable, you are allowing other threads to continue modifying
7370
other portions of the workspace. It is important to be sure that your resource rule
7471
matches the work being done inside the runnable. When a non-null scheduling
@@ -77,20 +74,20 @@ <h4>Scheduling Rules and Locking</h4>
7774
</p>
7875
<p>
7976
There are two special scheduling rules that are important to consider. First,
80-
if you use an instance of <tt>IWorkspaceRoot</tt> as the scheduling rule,
77+
if you use an instance of <code>IWorkspaceRoot</code> as the scheduling rule,
8178
it means your thread is blocking access to <b>all</b> resources in the tree.
8279
While a thread holds the root rule, no other thread is allowed to modify the
83-
workspace. Conversely, a rule of <tt>null</tt> indicates that the thread
80+
workspace. Conversely, a rule of <code>null</code> indicates that the thread
8481
will block access to <b>no</b> resources in the tree. While a thread with the
8582
null rule is free to modify the workspace itself, other threads will not be prevented
86-
from performing their own modifications. The <tt>IWorkspaceRoot</tt> and
87-
<tt>null</tt> scheduling rules occupy opposite ends of the concurrency spectrum.
88-
With <tt>IWorkspaceRoot</tt> there is no concurrency
89-
and only one thread is modifying the workspace at a time. With a <tt>null</tt> rule,
83+
from performing their own modifications. The <code>IWorkspaceRoot</code> and
84+
<code>null</code> scheduling rules occupy opposite ends of the concurrency spectrum.
85+
With <code>IWorkspaceRoot</code> there is no concurrency
86+
and only one thread is modifying the workspace at a time. With a <code>null</code> rule,
9087
there is maximum concurrency as all threads can modify the workspace concurrently.
9188
</p>
9289
<p>The third parameter to the <b>run</b> method specifies whether any periodic resource change events should
93-
be broadcast during the scope of this call. Using <tt>IWorkspace.AVOID_UPDATE</tt> tells the platform to suppress any
90+
be broadcast during the scope of this call. Using <code>IWorkspace.AVOID_UPDATE</code> tells the platform to suppress any
9491
resource change events while the runnable is running and to broadcast one event at the end of the changes.
9592
During this call, any other runnables created in the runnable will be considered part of the parent batch
9693
operation. Resource changes made in those runnables will appear in the parent's resource change notification.

eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_buildconfigs.htm

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
1-
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><html lang="en">
1+
<!DOCTYPE HTML><html lang="en">
22
<HEAD>
33

44
<meta name="copyright" content="Copyright (c) Broadcom Corporation and others 2011. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
55

6-
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1">
7-
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
8-
9-
<LINK REL="STYLESHEET" HREF="../book.css" CHARSET="ISO-8859-1" TYPE="text/css">
6+
<meta charset="utf-8">
107
<TITLE>Project Build Configurations</TITLE>
118

129
<link rel="stylesheet" type="text/css" HREF="../book.css">
@@ -72,10 +69,10 @@ <h4>Creating and Setting Build Configurations </h4>
7269

7370
...
7471
// Creating a build configuration
75-
<a href="../reference/api/org/eclipse/core/resources/IWorkspace.html#newBuildConfig(java.lang.String, java.lang.String)">ResourcesPlugin().getWorkspace().newBuildConfig</a>(project.getName(), "myNewBuildConfig");
72+
<a href="../reference/api/org/eclipse/core/resources/IWorkspace.html#newBuildConfig(java.lang.String,%20java.lang.String)">ResourcesPlugin().getWorkspace().newBuildConfig</a>(project.getName(), "myNewBuildConfig");
7673
...
7774
// Set new build configurations on a project
78-
projDesc.<a href="../reference/api/org/eclipse/core/resources/IProjectDescription.html#setBuildConfigs(java.lang.String[])">setBuildConfigs</a>(buildConfigs);
75+
projDesc.<a href="../reference/api/org/eclipse/core/resources/IProjectDescription.html#setBuildConfigs(java.lang.String%5B%5D)">setBuildConfigs</a>(buildConfigs);
7976

8077
// Set the description
8178
project.setDescription(projDesc, null);
@@ -86,7 +83,7 @@ <h4>Creating and Setting Build Configurations </h4>
8683
</p>
8784
<h4>Active Configuration</h4>
8885
<p>By default one configuration on the project is defined as '<b>active</b>'. The active configuration is the one that is built
89-
when a build configurations isn't specified (e.g. when: <a href="../reference/api/org/eclipse/core/resources/IProject.html#build(int, org.eclipse.core.runtime.IProgressMonitor)">
86+
when a build configurations isn't specified (e.g. when: <a href="../reference/api/org/eclipse/core/resources/IProject.html#build(int,%20org.eclipse.core.runtime.IProgressMonitor)">
9087
IProject#build(kind, monitor)</a> is called on the project). To set the active build configuration:
9188
</p>
9289

@@ -101,7 +98,7 @@ <h4> Creating References Between Build Configurations </h4>
10198
</p>
10299

103100
<pre>
104-
projDesc.<a href="../reference/api/org/eclipse/core/resources/IProjectDescription.html#setBuildConfigReferences(java.lang.String,%20org.eclipse.core.resources.IBuildConfiguration[])">setBuildConfigReferences</a>(String configName, IBuildConfiguration[] references);
101+
projDesc.<a href="../reference/api/org/eclipse/core/resources/IProjectDescription.html#setBuildConfigReferences(java.lang.String,%20org.eclipse.core.resources.IBuildConfiguration%5B%5D)">setBuildConfigReferences</a>(String configName, IBuildConfiguration[] references);
105102
</pre>
106103

107104
<p>causes the named build configuration to reference the passed in build configurations.</p>
@@ -118,7 +115,7 @@ <h4> Building Project Build Configurations </h4>
118115
New API exists on the workspace to allow building a build configuration and its references (if required):
119116

120117
<pre>
121-
ResourcesPlugin.getWorkspace().<a href="../reference/api/org/eclipse/core/resources/IWorkspace.html#build(org.eclipse.core.resources.IBuildConfiguration[],%20int,%20boolean,%20org.eclipse.core.runtime.IProgressMonitor)">build</a>(IBuildConfiguration[] buildConfigs, int kind, boolean buildReferences, IProgressMonitor monitor);
118+
ResourcesPlugin.getWorkspace().<a href="../reference/api/org/eclipse/core/resources/IWorkspace.html#build(org.eclipse.core.resources.IBuildConfiguration%5B%5D,%20int,%20boolean,%20org.eclipse.core.runtime.IProgressMonitor)">build</a>(IBuildConfiguration[] buildConfigs, int kind, boolean buildReferences, IProgressMonitor monitor);
122119
</pre>
123120

124121
API also exists on IProject to build a specific build configuration:

eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_builders.htm

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
1-
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><html lang="en">
1+
<!DOCTYPE HTML><html lang="en">
22
<HEAD>
33

44
<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." >
55

6-
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1">
7-
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
8-
9-
<LINK REL="STYLESHEET" HREF="../book.css" CHARSET="ISO-8859-1" TYPE="text/css">
6+
<meta charset="utf-8">
107
<TITLE>Incremental project builders</TITLE>
118

129
<link rel="stylesheet" type="text/css" HREF="../book.css">
10+
<style>
11+
table, td, th {
12+
border: 1px solid;
13+
border-collapse: collapse;
14+
}
15+
</style>
1316
</HEAD>
1417
<BODY>
1518
<H2>
@@ -222,7 +225,7 @@ <h4>Build Locking</h4>
222225
</p>
223226

224227
<pre>
225-
public ISchedulingRule <a href="../reference/api/org/eclipse/core/resources/IncrementalProjectBuilder.html#getRule(int, java.util.Map)">getRule</a>(int kind, Map&lt;String,String&gt; args) {
228+
public ISchedulingRule <a href="../reference/api/org/eclipse/core/resources/IncrementalProjectBuilder.html#getRule(int,%20java.util.Map)">getRule</a>(int kind, Map&lt;String,String&gt; args) {
226229
// Allow any resource to be modified concurrently with this buidler's invocation.
227230
return null;
228231
}
@@ -284,7 +287,7 @@ <H3>
284287
Configuring a project's builder is done just once, usually as the project is being created.
285288
A common way to associate a builder with a project is by configuring a <a href="resAdv_natures.htm">project nature</a>.
286289
</P>
287-
<H3><a name="advanced_build_kinds">Advanced Build Kinds</a></H3>
290+
<H3><a id="advanced_build_kinds">Advanced Build Kinds</a></H3>
288291

289292
<h4>Triggers vs. Kinds</h4>
290293
<p>When a build is invoked on an IProject or IWorkspace, we call the passed in build kind the build <i>trigger</i>.
@@ -293,7 +296,7 @@ <h4>Triggers vs. Kinds</h4>
293296
<p>The major exception to this is where no delta exists. In this case the build <i>trigger</i> is always promoted to <b>FULL_BUILD</b>.</p>
294297

295298
The mapping between triggers and kinds looks like:
296-
<table border="1">
299+
<table>
297300
<tr>
298301
<th>Trigger</th>
299302
<th>Kind</th>

eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_concurrency.htm

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
1-
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><html lang="en">
1+
<!DOCTYPE HTML><html lang="en">
22
<HEAD>
33

44
<meta name="copyright" content="Copyright (c) IBM Corporation and others 2000, 2005. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
55

6-
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1">
7-
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
8-
9-
<LINK REL="STYLESHEET" HREF="../book.css" CHARSET="ISO-8859-1" TYPE="text/css">
6+
<meta charset="utf-8">
107
<TITLE>
118
Concurrency and the workspace
129
</TITLE>
@@ -67,7 +64,7 @@ <h4>Workspace Jobs</h4>
6764
</pre>
6865
<p>Our job is scheduled like any other job. The platform job manager will run it according to its
6966
priority, other jobs in the queue, and the scheduling rules. Note that we must attach the
70-
scheduling rule to the job in order to prevent simultaneous modification of <tt>myProject</tt>.
67+
scheduling rule to the job in order to prevent simultaneous modification of <code>myProject</code>.
7168
</p>
7269
<pre>MyWorkspaceJob job = new MyWorkspaceJob();
7370
<b>job.setRule(myProject);</b>

eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_derived.htm

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
1-
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><html lang="en">
1+
<!DOCTYPE HTML><html lang="en">
22
<HEAD>
33

44
<meta name="copyright" content="Copyright (c) IBM Corporation and others 2000, 2005. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
55

6-
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1">
7-
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
8-
9-
<LINK REL="STYLESHEET" HREF="../book.css" CHARSET="ISO-8859-1" TYPE="text/css">
6+
<meta charset="utf-8">
107
<TITLE>
118
Derived resources
129
</TITLE>

eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_efs_api.htm

Lines changed: 17 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
1-
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><html lang="en">
1+
<!DOCTYPE HTML><html lang="en">
22
<HEAD>
33

44
<meta name="copyright" content="Copyright (c) IBM Corporation and others 2006. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
55

6-
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1">
7-
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
8-
9-
<LINK REL="STYLESHEET" HREF="../book.css" CHARSET="ISO-8859-1" TYPE="text/css">
6+
<meta charset="utf-8">
107
<TITLE>
118
Using the file system API
129
</TITLE>
@@ -16,21 +13,21 @@
1613
<BODY>
1714
<h3>Using the File System API</h3>
1815
<p>
19-
The <tt>org.eclipse.core.filesystem</tt> plug-in provides a generic API for
20-
interacting with an arbitrary file system. This API is similar to <tt>java.io.File</tt>,
16+
The <code>org.eclipse.core.filesystem</code> plug-in provides a generic API for
17+
interacting with an arbitrary file system. This API is similar to <code>java.io.File</code>,
2118
with a few key differences:
2219
</p>
2320
<ul>
2421
<li>Plug-ins can install providers for different types of file systems.</li>
2522
<li>All methods integrate support for reporting progress and responding to cancelation,
2623
making it easier to integrate into a graphical user interface.</li>
27-
<li>There is support for some additional functionality not available in <tt>java.io.File</tt>,
24+
<li>There is support for some additional functionality not available in <code>java.io.File</code>,
2825
such as getting and setting file permissions.</li>
2926
<li>There are more convenience methods, such as copy, move, and recursive deletion.</li>
3027
</ul>
3128
<p>
3229
In the file system API, the path for any given file is represented as a hierarchical
33-
<tt>java.net.URI</tt>. The URI scheme represents the kind of file system,
30+
<code>java.net.URI</code>. The URI scheme represents the kind of file system,
3431
and the URI path component represents the location of the file within the file
3532
system tree. Thus any given hierarchical URI represents a potential file or
3633
directory in some arbitrary file system.
@@ -40,23 +37,23 @@ <h3>Using the File System API</h3>
4037
<b><a href="../reference/api/org/eclipse/core/filesystem/package-summary.html">org.eclipse.core.filesystem</a></b>)
4138
package. The central API type is
4239
<b><a href="../reference/api/org/eclipse/core/filesystem/IFileStore.html">IFileStore</a></b>
43-
Each instance of <tt>IFileStore</tt> represents
44-
a single file in the file system. As with <tt>IResource</tt>, the existence of
45-
an <tt>IFileStore</tt> instance does not mean that such a file exists on disk. You
46-
can use an <tt>IFileStore</tt> instance to create, delete, copy, move, or open
47-
streams on files. For a given <tt>URI</tt>, you can get your hands on an <tt>IFileStore</tt>
48-
instance using the static method <tt>EFS.getStore(URI)</tt>
40+
Each instance of <code>IFileStore</code> represents
41+
a single file in the file system. As with <code>IResource</code>, the existence of
42+
an <code>IFileStore</code> instance does not mean that such a file exists on disk. You
43+
can use an <code>IFileStore</code> instance to create, delete, copy, move, or open
44+
streams on files. For a given <code>URI</code>, you can get your hands on an <code>IFileStore</code>
45+
instance using the static method <code>EFS.getStore(URI)</code>
4946
</p>
5047
<p>
5148
The <b><a href="../reference/api/org/eclipse/core/filesystem/IFileSystem.html">IFileSystem</a></b>
5249
interface can be used to find out things about the file system as a whole. Each
53-
<tt>IFileSystem</tt> instance represents a single URI scheme, such as "file:",
50+
<code>IFileSystem</code> instance represents a single URI scheme, such as "file:",
5451
"ftp:", etc. You can use this type to ask questions such as what file attributes
5552
are supported, or whether the file system is case-sensitive. You can also use
56-
this type to obtain an <tt>IFileStore</tt> for a given <tt>URI</tt>.
53+
this type to obtain an <code>IFileStore</code> for a given <code>URI</code>.
5754
</p>
5855
<p>
59-
Most methods on <tt>IFileStore</tt> have a flag parameter that allows
56+
Most methods on <code>IFileStore</code> have a flag parameter that allows
6057
extra options to be supplied. The flag values can be found
6158
in the <b><a href="../reference/api/org/eclipse/core/filesystem/EFS.html">EFS</a></b>
6259
class. For example, to open an output stream for appending to a file, use:
@@ -87,12 +84,12 @@ <h3>Using the File System API</h3>
8784
This style of API allows you to obtain and change file information with
8885
a single call to the file system. In the above example, there is only
8986
one file system call to fetch the info, and then you can perform as many
90-
operations as you want on the <tt>IFileInfo</tt> object without hitting
87+
operations as you want on the <code>IFileInfo</code> object without hitting
9188
the disk again.
9289
</p>
9390
<p>
9491
The <b><a href="../reference/api/org/eclipse/core/filesystem/EFS.html">EFS</a></b>
95-
class has static factory methods for obtaining <tt>IFileStore</tt> and <tt>IFileSystem</tt>
92+
class has static factory methods for obtaining <code>IFileStore</code> and <code>IFileSystem</code>
9693
instances, as well as various option constants and error codes.
9794
</p>
9895
</BODY>

eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_efs_intro.htm

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
1-
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><html lang="en">
1+
<!DOCTYPE HTML><html lang="en">
22
<HEAD>
33

44
<meta name="copyright" content="Copyright (c) IBM Corporation and others 2006. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
55

6-
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1">
7-
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
8-
9-
<LINK REL="STYLESHEET" HREF="../book.css" CHARSET="ISO-8859-1" TYPE="text/css">
6+
<meta charset="utf-8">
107
<TITLE>
118
Alternate file systems
129
</TITLE>
@@ -18,7 +15,7 @@ <h3>Alternate File Systems</h3>
1815

1916
<p>
2017
Most of the time, resources in the workspace are stored in a local file system
21-
that is accessible via <tt>java.io.File</tt>. However, it is also possible
18+
that is accessible via <code>java.io.File</code>. However, it is also possible
2219
to create resources that are stored in other kinds of file systems, such
2320
as network file systems or a database.
2421
</p>

0 commit comments

Comments
 (0)