Changeset 8757 for trunk/gsdl3/docs/manual

Timestamp:

2004-12-08T17:19:29+13:00 (19 years ago)

Author:

kjdon

Message:

more stuff

File:

• trunk/gsdl3/docs/manual/manual.tex (modified) (4 diffs)

trunk/gsdl3/docs/manual/manual.tex

@@ -683 +683 @@
 \end{verbatim}\end{gsc}
 
-Scope determines on what text the replacements are carried out: text, metadata, or both (all). An empty scope attribute is equivalent to scope=all. Each replace type can be used with all scope values. Replacing uses Java's 'String.replaceAll' functionality, so macro and replacement text are actually regular expressions. The first example is a straight is a straight textual replacement. The second example uses dictionary lookups. xxx will be replaced with the (language-dependent) value for key zzz in resource bundle yyy. The thrid example uses metadata: xxx will be replaced by the value of the yyy metadata for that document.
-
-Some examples that have been used for existing Greenstone 2 collections are:
-\begin{gsc}\begin{verbatim}
-<replaceList>
-<replace scope='text' macro="\backslash\backslash?\backslash\backslash\backslash/" text="\backslash("/>
-<replace scope='metadata' macro="_magazines_" bundle="NZDLMacros" key="Magazines"/>
-<replace scope='all' macro='_thisOID_' metadata='archivedir'/>
-<replace macro="_httpcollimg_" text="sites/localsite/collect/folktale/index/assoc"/>
-<replace macro="_httpextlink_&amp;rl=1&amp;href=" text="?a=d&amp;c=folktale&amp;s0.ext=1&amp;d="/>
-<replace macro="_httpextlink_&amp;rl=0&amp;href=" text="?a=p&amp;sa=html&amp;c=folktale&amp;url="/>
-</replaceList>
-\end{verbatim}\end{gsc}
-
-The last two examples show how to deal with Greenstone 2's external link macros. The first one is for a 'relative' external link. In this case, the links are like URL's but they actually refer to Greenstone internal documents. So the Greensotne 3 link is to the document, but with parameter s0.ext signifying that the d argument will need translating before retrieving the content.
-The second example is a truly external link. This is translated into a html type page action, where the url is presented as a frame along with the collection header in a separate frame.
+Scope determines on what text the replacements are carried out: text, metadata, or both (all). An empty scope attribute is equivalent to scope=all. Each replace type can be used with all scope values. Replacing uses Java's 'String.replaceAll' functionality, so macro and replacement text are actually regular expressions. The first example is a straight textual replacement. The second example uses dictionary lookups. xxx will be replaced with the (language-dependent) value for key zzz in resource bundle yyy. The third example uses metadata: xxx will be replaced by the value of the yyy metadata for that document.
+
+Appendix~\ref{app:gs2replace} gives some examples that have been used for Greenstone 2 collections.
 
 \subsection{buildConfig.xml}\label{sec:buildconfig}
@@ -798 +785 @@
 \end{verbatim}\end{gsc}
 
-Table~\ref{tab:gsf-format} shows the set of 'gsf' (Greenstone Format) elements. If you have come from a \gsii\  background, Appendix~\ref{app:format} shows \gsii\  format elements and their equivalents in \gsiii\ .
+Table~\ref{tab:gsf-format} shows the set of 'gsf' (Greenstone Format) elements. If you have come from a \gsii\  background, Appendix~\ref{app:gs2format} shows \gsii\  format elements and their equivalents in \gsiii\ .
  
 \begin{table}
@@ -2382 +2369 @@
 
 \newpage
-\section{Format statements: \gsii\  vs \gsiii\ }\label{app:format}
+\section{Tidying up the formatting for imported Greenstone 2 collections}\label{app:gs2tidy}
+
+\subsection{Format statements: \gsii\  vs \gsiii\ }\label{app:gs2format}
 The following table shows the \gsii\  format elements, and their equivalents in \gsiii\ 
 \begin{table}[h]
@@ -2425 +2414 @@
 \end{tabular}}
 \end{table}
+\subsection{Cleaning up macros}\label{app:gs2replace}
+
+Here we show some of the replace items that have been used for Greenstone 2 collections.
+
+Getting rid of silly backslashes:
+\begin{gsc}\begin{verbatim}
+<replace scope='text' macro="\backslash\backslash?\backslash\backslash\backslash(" text="\backslash("/>
+\end{verbatim}\end{gsc}
+
+Macro resolving using resource bundles and metadata:
+\begin{gsc}\begin{verbatim}
+<replace scope='metadata' macro="_magazines_" bundle="NZDLMacros" key="Magazines"/>
+<replace scope='all' macro='_thisOID_' metadata='archivedir'/>
+<replace macro="_httpcollimg_" text="sites/localsite/collect/folktale/index/assoc"/>
+\end{verbatim}\end{gsc}
+
+Fixing up broken external links:
+\begin{gsc}\begin{verbatim}
+<replace macro="_httpextlink_&amp;rl=1&amp;href=" text="?a=d&amp;c=folktale&amp;s0.ext=1&amp;d="/>
+<replace macro="_httpextlink_&amp;rl=0&amp;href=" text="?a=p&amp;sa=html&amp;c=folktale&amp;url="/>
+</replaceList>
+\end{verbatim}\end{gsc}
+
+These two examples show how to deal with Greenstone 2's external link macros. The first one is for a 'relative' external link. In this case, the links are like URL's but they actually refer to Greenstone internal documents. So the Greensotne 3 link is to the document, but with parameter s0.ext signifying that the d argument will need translating before retrieving the content.
+The second example is a truly external link. This is translated into a html type page action, where the url is presented as a frame along with the collection header in a separate frame.
+
+Sometimes we need to add in macros to be resolved in a second step:
+\begin{gsc}\begin{verbatim}
+<replace macro="_iconpdf_" scope="metadata" text="&lt;img border='0' height='26' width='26' alt='PDF' title='_texticonpdf_' src='interfaces/default/images/ipdf.gif'/&gt;"/>
+<replace macro="_texticonpdf_" scope="metadata" bundle="interface_classic" key="texticonpdf"/>
+\end{verbatim}\end{gsc}
+
 \end{document}