hazza/DSpace
1
0
Fork 0
mirror of https://github.com/DSpace/DSpace.git synced 2025-10-07 18:14:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

HTML cleanup, spelling, and the like

Browse Source 
git-svn-id: http://scm.dspace.org/svn/repo/dspace/trunk@5349 9c30dcfa-912a-0410-8fc2-9e0234be79fd
This commit is contained in:
Mark Wood
2010-09-20 14:37:57 +00:00
parent 7ffe2ba155
commit 3c6514aa7a
1 changed files with 13 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
dspace-api/src/main/java/org/dspace/browse/package.html
View File

@@ -10,21 +10,25 @@
</head> </head>
<body bgcolor="white"> <body bgcolor="white">
<p> <p>
Provides classes and mehtods for browsing Items in DSpace by whatever Provides classes and methods for browsing Items in DSpace by whatever
is specified in the configuration. The standard method by which you is specified in the configuration. The standard method by which you
would perform a browse is as follows: would perform a browse is as follows:
</p> </p>
<ul> <ul>
<li>Create a <a href="BrowserScope.html">BrowserScope</a> object. This object holds all of the parameters <li>Create a <a href="BrowserScope.html">BrowserScope</a> object.
of your browse request</li> This object holds all of the parameters of your browse request</li>
<li>Pass the <a href="BrowserScope.html">BrowserScope</a> object into the <a href="BrowseEngine.html">BrowseEngine</a> object. <li>Pass the <a href="BrowserScope.html">BrowserScope</a> object
This object should be invoked through either the browse() method or the browseMini() method</li> into the <a href="BrowseEngine.html">BrowseEngine</a> object. This
<li>The <a href="BrowseEngine.html">BrowseEngine</a> will pass back a <a href="BrowseInfo.html">BrowseInfo</a> object which contains all the relevant details of your request</li> object should be invoked through either the browse() method or the
browseMini() method</li>
<li>The <a href="BrowseEngine.html">BrowseEngine</a> will pass
back a <a href="BrowseInfo.html">BrowseInfo</a> object which contains
all the relevant details of your request</li>
</ul> </ul>
<p> <p>
Browses only return archived Items; other Items (eg, those Browses only return archived Items; other Items (e.g. those
in the workflow system) are ignored. in the workflow system) are ignored.
</p> </p>
@@ -32,6 +36,7 @@ in the workflow system) are ignored.
<p> <p>
An example use of the Browse API is shown below: An example use of the Browse API is shown below:
</p>
<pre> <pre>
// Create or obtain a context object // Create or obtain a context object
Context context = new Context(); Context context = new Context();
@@ -56,10 +61,10 @@ An example use of the Browse API is shown below:
BrowseEngine be = new BrowseEngine(); BrowseEngine be = new BrowseEngine();
BrowseInfo results = be.browse(scope); BrowseInfo results = be.browse(scope);
</pre> </pre>
</p>
<p> <p>
In this case, the results might be Items with titles like: In this case, the results might be Items with titles like:
</p>
<pre> <pre>
Tehran, City of the Ages Tehran, City of the Ages
@@ -73,8 +78,6 @@ Thesis and Antithesis
... ...
</pre> </pre>
</p>
<h2>Browse Indexes</h2> <h2>Browse Indexes</h2>
<p> <p>