1
<%@ page language="java" contentType="text/html; charset=UTF8"
5
request.setAttribute("page", "help");
7
String completePath = request.getRequestURL().toString();
8
int lastSlash = completePath.lastIndexOf("/");
9
String lastPart = completePath.substring(0, lastSlash + 1);
10
//out.print(lastPart);
12
<jsp:include page="inc/header.jsp" />
16
<h2>How to use the GoobiContentServer</h2>
18
<p>At this place you can find descriptions for all parameters that are needed to control the
19
GoobiContentServer.</p>
20
<p>The GoobiContentServer is reachable under the following address <b>"<%
21
out.print(lastPart + "gcs");
22
%>"</b>, where automatically the Action "echo" gets called.</p>
24
<h3 id="echo">echo</h3>
25
<p>By requesting the URL <b>"<%
26
out.print(lastPart + "gcs?action=echo");
27
%>"</b> the action "echo" gets executed. As a result you get an overview of all request parameters which were used in the request.</p>
29
<h3 id="help">help</h3>
30
<p>By requesting the URL <b>"<%
31
out.print(lastPart + "gcs?action=help");
32
%>"</b> you get this help page with descriptions for all parameters on how to control the GoobiContentServer.</p>
34
<h3 id="about">about</h3>
35
<p>By requesting the URL <b>"<%
36
out.print(lastPart + "cs?action=about");
37
%>"</b> you will get a page with some basic information about the GoobiContentServer project.</p>
40
<p>By calling the action "pdf" you receive one pdf file on basis of a given mets file, including page names, bookmarks, watermarks and title pages.
41
Simply call the following URL: <b>"<%
42
out.print(lastPart + "gcs?action=pdf");
43
%>"</b> and combine it with some parameters to generate your pdf file. The following URL is an example on how you can process one mets file and generate one pdf file from it: <br />
47
out.print(lastPart); %>gcs?action=pdf&metsFile=FaustTragedy.xml&targetFileName=Goethe_Faust_FirstPart.pdf">
49
out.print(lastPart); %>gcs?action=pdf&metsFile=FaustTragedy.xml&targetFileName=Goethe_Faust_FirstPart.pdf</a></p>
58
<td>Define the name of the METS file. Use here only the relative path coming from the defined repository.<br />
59
sample: "metsFile=FaustTragedy.xml"</td>
62
<td>targetFileName</td>
63
<td>define the name of the target pdf file<br />
64
sample: "targetFileName=Goethe_Faust_FirstPart.pdf"</td>
68
<td>define the mets div by id which should be generated as pdf file<br />
69
sample: "divID=log9"</td>
73
<td>define if the pdf should be written as Pdf/A file<br />
74
sample: "writeAsPdfA=false"</td>
77
<td>metsFileGroup</td>
78
<td>define which metsFileGroup should be used<br />
79
sample: "metsFileGroup=PRESENTATION"</td>
83
<td>define which pagesize should be used ('A4', 'original', 'A4Box <br />
84
sample: "pagesize=A4"</td>
88
<td>if the content of the metsfile should not be parsed automatically you can define here a title page for the PDF-file. Its content will be used directly without any change. Be sure to use an url as parameter here.<br />
89
sample: "pdftitlepage=http://intranda.com/GDZ/samplepdftitlepage.xml"</td>
93
<td>define here if a pdf file from cache should be ignored<br />
94
sample: "ignoreCache=true"</td>
98
<h3 id="metsImage">metsImage</h3>
99
<p>By calling the action "metsImage" you receive one image file from a given mets file with the given divID which can be processed by the embedded contentSever image library.
100
Simply call the following URL: <b>"<%
101
out.print(lastPart + "gcs?action=metsImage");
102
%>"</b> and combine it with some parameters to process the requested image file. The following URL is an example on how you can process one image from a mets file: <br />
106
out.print(lastPart); %>gcs?action=metsImage&metsFile=FaustTragedy.xml&divID=phys2&scale=30&rotate=90&format=jpeg&resolution=200">
108
out.print(lastPart); %>gcs?action=metsImage&metsFile=FaustTragedy.xml&divID=phys2&scale=30&rotate=90&format=jpeg&resolution=200</a></p>
117
<td>Define the name of the METS file. Use here only the relative path coming from the defined repository.<br />
118
sample: "metsFile=FaustTragedy.xml"</td>
122
<td>define the mets div id of the requested image which should be processed, the id have to be a physical one<br />
123
sample: "divID=phys2"</td>
126
<td>metsFileGroup</td>
127
<td>define which metsFileGroup should be used; the image is taken from this file group; if not defined, the value from configuration file will be used<br />
128
sample: "metsFileGroup=PRESENTATION"</td>
133
<td>value of the rotation angle as number between 0 and 360<br />
134
sample: "rotate=90"</td>
138
<td>value of zoom factor (for example: 50 represents 50% and 100
139
represents 100%)<br />
140
sample: "scale=50"</td>
144
<td>pixel for zoom to fixed width (for example: 800 represents 800px width)<br />
145
sample: "width=800"</td>
149
<td>pixel for zoom to fixed height (for example: 1000 represents 1000px height)<br />
150
sample: "height=1000"</td>
154
<td>format of target file, possible formats are: jpeg $ png $ jp2
159
<td>define resolution of target image in dpi (default is 600 dpi)</td>
163
<td>define coordinates for highlighting inside the image; define
164
4 coordinates for each highlighting area; for multiple highlighting
165
areas separate the coordinates of each area using a dollar sign "$"<br />
166
sample for one area: "highlight=10,50,80,150"<br />
167
sample for two areas: "highlight=10,50,80,150$60,80,160,200"</td>
170
<td>targetFileName</td>
171
<td>define the name of the target image file<br />
172
sample: "targetFileName=myGeneratedImage.jpg"</td>
176
<td>format of the error report; possible values "image" and
177
"jsp"; if parameter is not defined "jsp" is taken<br />
178
sample: "errorReport=image"</td>
183
<h3 id="multiPdf">multiPdf</h3>
184
<p>By calling the action "multiPdf" you receive one pdf file from a given list of mets and pdf files.
185
Simply call the following URL: <b>"<%
186
out.print(lastPart + "gcs?action=multiPdf");
187
%>"</b> and combine it with some parameters to process the given files. The following URL is an example on how you can process one mets file and one pdf file into one merged pdf file: <br />
191
out.print(lastPart); %>gcs?action=multiPdf&files=mets$someMetsFile.xml$$pdf$somePdfFile.pdf&metsFileGroup=DEFAULT">
193
out.print(lastPart); %>gcs?action=multiPdf&files=mets$someMetsFile.xml$$pdf$somePdfFile.pdf&metsFileGroup=DEFAULT</a></p>
202
<td>Define the list of files to process into one large pdf file. Each file section is devided by a double dollar sign '$$' from each other and consists of two or three parameters devided by a single dollar sign '$'.
203
The parameters are: filetype, url and divid. The filetype and the url parameter always have to be present. The divid parameter is optional and only valid for metsfiles.<br/>
204
As filetype you can use 'pdf' and 'mets'.<br/>
205
The url parameter defines the name of the PDF or METS file. Use here only the relative path coming from the defined repository.<br />
206
As divid you can insert a physical mets div id.<br />
207
sample: "files=mets$someMetsFile.xml$$pdf$somePdfFile.pdf$$mets$someMetsFileWithDivId.xml$phys2"</td>
210
<td>metsFileGroup</td>
211
<td>define which metsFileGroup should be used; the image is taken from this file group; if not defined, the value from configuration file will be used<br />
212
sample: "metsFileGroup=PRESENTATION"</td>
215
<td>targetFileName</td>
216
<td>define the name of the target image file<br />
217
sample: "targetFileName=myGeneratedImage.jpg"</td>
221
<td>define if the pdf should be written as Pdf/A file<br />
222
sample: "writeAsPdfA=false"</td>
226
<td>define which pagesize should be used ('A4', 'original', 'A4Box <br />
227
sample: "pagesize=A4"</td>
230
<!-- main ends --></div>
235
<ul class="sidemenu">
236
<li><a href="#echo">echo</a></li>
237
<li><a href="#help">help</a></li>
238
<li><a href="#about">about</a></li>
239
<li><a href="#pdf">pdf</a></li>
240
<li><a href="#metsImage">metsImage</a></li>
241
<li><a href="#multiPdf">multiPdf</a></li>
244
<!-- sidebar ends --></div>
246
<jsp:include page="inc/footer.jsp" />
added
removed
WebContent/help.jsp
