From 3c6514aa7a37d98bfe3a2e7aa557e059a60742c7 Mon Sep 17 00:00:00 2001
From: Mark Wood
Date: Mon, 20 Sep 2010 14:37:57 +0000
Subject: [PATCH] HTML cleanup, spelling, and the like
git-svn-id: http://scm.dspace.org/svn/repo/dspace/trunk@5349 9c30dcfa-912a-0410-8fc2-9e0234be79fd
---
.../main/java/org/dspace/browse/package.html | 23 +++++++++++--------
1 file changed, 13 insertions(+), 10 deletions(-)
diff --git a/dspace-api/src/main/java/org/dspace/browse/package.html b/dspace-api/src/main/java/org/dspace/browse/package.html
index a3b66f87c2..9c7b4f21c8 100644
--- a/dspace-api/src/main/java/org/dspace/browse/package.html
+++ b/dspace-api/src/main/java/org/dspace/browse/package.html
@@ -10,21 +10,25 @@
-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
would perform a browse is as follows:
- - Create a BrowserScope object. This object holds all of the parameters
- of your browse request
- - Pass the BrowserScope object into the BrowseEngine object.
- This object should be invoked through either the browse() method or the browseMini() method
- - The BrowseEngine will pass back a BrowseInfo object which contains all the relevant details of your request
+ - Create a BrowserScope object.
+ This object holds all of the parameters of your browse request
+ - Pass the BrowserScope object
+ into the BrowseEngine object. This
+ object should be invoked through either the browse() method or the
+ browseMini() method
+ - The BrowseEngine will pass
+ back a BrowseInfo object which contains
+ all the relevant details of your request
-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.
@@ -32,6 +36,7 @@ in the workflow system) are ignored.
An example use of the Browse API is shown below:
+
// Create or obtain a context object
Context context = new Context();
@@ -56,10 +61,10 @@ An example use of the Browse API is shown below:
BrowseEngine be = new BrowseEngine();
BrowseInfo results = be.browse(scope);
-
In this case, the results might be Items with titles like:
+
Tehran, City of the Ages
@@ -73,8 +78,6 @@ Thesis and Antithesis
...
-
-
Browse Indexes