# This YAML file can be validated at https://www.yamllint.com/ # Useful YAML pages # https://yaml-multiline.info/ # https://www.codeproject.com/Articles/1214409/Learn-YAML-in-five-minutes # https://www.redhat.com/en/topics/automation/what-is-yaml # (Java processing: https://www.baeldung.com/java-snake-yaml) --- tutorial: backdrop edits: - num: 1 description: Checking for required browse format statement type: MATCH find: |- :
:
:
: - num: 2 description: Rewrite ImageName to Title metadata type: REPLACE find: |- :
text: |- Title:
- num: 3 description: Insert Description metadata type: INSERT_AFTER find: |- Title:
text: |- Description:
--- tutorial: imagesGPS edits: - num: 1 description: Add mapEnabled element at the top of the browse format type: ADD_AT_START text: |- - num: 2 description: Insert mapEnabled element into the display format feature type: INSERT_AFTER find: |- text: |- - num: 3 description: Add mapEnabled element at the top of the search format type: ADD_AT_START text: |- --- tutorial: formattingReports edits: - num: 1 description: Simplyifying browse stmt type: REPLACE find: |- text: |- - num: 2 description: Simplifying global stmt type: REPLACE find: |- Untitled text: |- Untitled - num: 3 description: Adding source icon to search statement type: INSERT_AFTER find: |- text: |- - num: 4 description: Removing doc icon from search statement type: REMOVE find: |- - num: 5 type: INSERT_AFTER description: Adding back doc icon to search stmt find: |- text: |- - num: 6 description: Indicating number of leaf nodes type: INSERT_BEFORE find: |- text: |- () - num: 7 description: Displaying creators, comma separated type: INSERT_AFTER find: |-
()
text: |-
- num: 8 description: Creators separated by space type: REPLACE find: |- text: |- - num: 9 description: Creators separated by newline type: REPLACE find: |- text: |-
--- tutorial: pdfCollection edits: - num: 1 description: "Hide section numbers in display format" type: ADD_AT_START text: |- - num: 2 description: "Hide section titles in display format" type: REPLACE find: |- text: |- - num: 3 description: Highlighting the query terms in a PDF document type: INSERT_AFTER find: |- text: |- /index/assoc//#search="" --- tutorial: associatedFiles edits: - num: 1 description: Adding the equivDoc elements to the browse format statement type: INSERT_AFTER find: |- text: |- - num: 2 description: Adding the equivDoc elements to the search format statement type: REPLACE find: |- text: |- --- tutorial: tudor3_formatting edits: - num: 1 description: Simplified equivalent browse statement type: REPLACE find: |-
()
text: |-
()
- num: 2 description: Making CL2 dc.Subject not display source filename type: REPLACE find: |-
()
text: |- - num: 3 description: Search format statement to display dc.Subject type: INSERT_AFTER find: |- text: |-
- num: 4 description: Modifying the bookshelf display for CL2 dc.Subject by adding Title type: REPLACE find: |- text: |- Title: - num: 5 description: Modifying the bookshelf display for CL2 dc.Subject with heading type: INSERT_AFTER find: |- text: |- Bookshelf title: --- tutorial: tudor4_webLink edits: - num: 1 description: Changing doc icon link to serve up the original web URL type: REPLACE find: |- text: |- --- tutorial: bibliographicColl_MARC edits: - num: 1 description: Checking the default global format statement is as expected type: REPLACE find: |- Untitled text: |- Untitled - num: 2 description: There are no source or thumb icons, so remove them from format statement type: REMOVE find: |- - num: 3 description: Remove reference to ex.Source metadata as it is set to the nul filename type: REMOVE find: |-
()
- num: 4 description: Removing the record title from the document display format statement type: INSERT_AFTER find: |- text: |- - num: 5 description: Override the default documentContent behaviour with a custom format statement type: INSERT_AFTER find: |- text: |-
Title:
Subject:
Publisher:
--- tutorial: CDS_ISIS edits: - num: 1 description: Change BROWSE format statement to display Photographer and Notes metadata type: REPLACE find: |-
()
text: |-
- num: 2 description: SEARCH results also to display Photographer and Notes metadata type: REPLACE find: |- text: |-
- num: 3 description: Controlling documentHeading type: INSERT_AFTER find: |- text: |- - num: 4 description: Custom documentContent with JavaScript to show and hide CDS records type: INSERT_AFTER find: |- text: |-

Show/Hide CDS Record
CDS Record:
--- tutorial: multimedia edits: - num: 1 description: Display different icons depending on dc.Format metadata type: REPLACE find: |- text: |- - num: 2 description: Remove the source filename from where it appears after each document type: REMOVE find: |-
()
- num: 3 description: Making bookshelves show how many items they contain type: INSERT_AFTER find: |- text: |- () - num: 5 description: Using different icons for the multimedia folders type: REPLACE find: |- text: |- --- tutorial: scannedImages edits: - num: 1 description: Changing Titles format stmt to display more information about the documents - part 1 type: REPLACE find: |-
()
text: |- Volume: Number: Date: - num: 2 description: Changing Titles format stmt to display more information about the documents - part 2 type: REPLACE find: |- text: |- () - num: 3 description: Formatting the DateList classifier - part 1 type: REPLACE find: |-
()
text: |- - num: 4 description: Formatting the DateList classifier - part 2 type: ADD_AT_END text: |- undated - num: 5 description: Removing the special date-formatting type: REPLACE find: |- undated text: |- undated - num: 6 description: Making search format statement work for both whole newspapers and pages type: REPLACE find: |- text: |- Volume: Number: - Page: Volume: Number:
undated --- tutorial: OAICollection edits: - num: 1 description: Replacing the browse format statement's documentNode and VList classifierNode type: REPLACE text: |- - num: 2 description: Replacing the search format statement in entirety (replaces search documentNode) type: REPLACE text: |- - num: 3 description: Appending a custom documentHeading to the display format statement type: ADD_AT_END text: |-

- num: 4 description: Appending a custom documentContent to the display format statement type: ADD_AT_END text: |-
Caption:
original x available
Subject:
Publisher:
Rights:
--- tutorial: unknownConverterPluginTutorial edits: - num: 1 description: Replacing the search format statement to see djvuicon in search results type: REPLACE text: |- Also available as: --- tutorial: stoneD edits: - num: 1 description: Adding equivDoc to the browse format statement type: INSERT_BEFORE find: |-
text: |-
Also available as:
- num: 2 description: Display the ex.dc.Title for the CL2 (ex.dc.Contributor) classifier type: REPLACE find: |- text: |- - num: 3 description: Editing the title of CL2's VList classifierNode type: REPLACE find: |- text: |- () - num: 4 description: Adding equivDoc to the CL2 (ex.dc.Contributor) format statement type: INSERT_BEFORE find: |-
text: |-
Also available as:
- num: 5 description: Adding equivDoc to the search format statement type: INSERT_BEFORE find: |-
text: |-
Also available as:
--- tutorial: OAIDownload edits: - num: 1 description: Repeating backdrop. Replacing browse format statement type: REPLACE text: |- Title:
Description:
Width:
Height:
Size:
Title: - num: 2 description: Repeating backdrop. Modifying search format statement type: REPLACE text: |- Title:
Description:
Width:
Height:
Size:
--- tutorial: customisingThemes edits: - num: 1 description: Modifying default/transform/pages/pref.xsl to use the TutorialTheme filename: web/interfaces/default/transform/pages/pref.xsl type: REPLACE find: |- {title:"Greenstone Custom 3", name:"custom-theme3", icon:"theme_90_trontastic.png", url:"interfaces/" + gs.xsltParams.interface_name + "/style/themes/alt_theme_3/jquery-ui.theme.css"}, text: |- {title:"Greenstone Custom 3", name:"custom-theme3", icon:"theme_90_trontastic.png", url:"interfaces/" + gs.xsltParams.interface_name + "/style/themes/alt_theme_3/jquery-ui.theme.css"}, {title:"Tutorial Theme", name:"TutorialTheme", icon:"TutorialTheme.png", url:"interfaces/" + gs.xsltParams.interface_name + "/style/themes/TutorialTheme/jquery-ui.theme.min.css"} --- tutorial: collectionSpecificTheme edits: - num: 1 description: Modifying backdrop's global format statement to use CollectionTheme type: ADD_AT_END text: |- --- tutorial: customisingHomePage edits: - num: 1 description: Modifying interfaceConfig.xml to use home-tutorial.xsl instead of home.xsl filename: web/interfaces/default/interfaceConfig.xml type: REPLACE find: |- text: |- - num: 2 description: Adding the collectionsList template to home-tutorial.xsl filename: web/interfaces/default/transform/pages/home-tutorial.xsl type: INSERT_BEFORE find: |- text: |-
  • - num: 3 description: Calling the newly added collectionsList template. filename: web/interfaces/default/transform/pages/home-tutorial.xsl type: REPLACE find: |-
  • Collection 1
  • Collection 2
  • Collection 3
  • Collection 4
  • Collection 5
  • text: |- - num: 4 description: Replacing default search box with one that searches all collections in library. filename: web/interfaces/default/transform/pages/home-tutorial.xsl type: INSERT_BEFORE find: |- text: |-
    - num: 5 description: Calling the newly added searchBox template. filename: web/interfaces/default/transform/pages/home-tutorial.xsl type: REPLACE find: |-
    text: |- - num: 6 description: Define and call a template to display the correct links when user logged in vs not filename: web/interfaces/default/transform/pages/home-tutorial.xsl type: INSERT_BEFORE find: |- text: |- - num: 7 description: Calling the newly added loginButton template. filename: web/interfaces/default/transform/pages/home-tutorial.xsl type: REPLACE find: |-
  • Login
  • Account Settings
  • Register a new user
  • Administration
  • Logout
  • text: |- - num: 8 description: Using a template to produce a consistent library name. filename: web/interfaces/default/transform/pages/home-tutorial.xsl type: REPLACE occurrence: 0 find: |- A New Home Page text: |- - num: 9 description: Changing the library name referred to by template in its one place. filename: web/sites/localsite/siteConfig.xml type: REPLACE find: |- My Greenstone Library text: |- The Best Digital Library --- tutorial: definingLibraries edits: - num: 1 description: Checking the default library uses localsite and default interface - part 1 filename: resources/web/servlets.xml.in type: MATCH find: |- library The standard gsdl3 library program org.greenstone.gsdl3.LibraryServlet library_name library - num: 2 description: Checking the default library uses localsite and default interface - part 2 filename: resources/web/servlets.xml.in type: MATCH find: |- site_name localsite interface_name default - num: 3 description: Checking halftone-library uses localsite and halftone interface filename: resources/web/servlets.xml.in type: MATCH find: |- halftone-library A library servlet using the standard content, but with the halftone interface. org.greenstone.gsdl3.LibraryServlet library_name halftone-library site_name localsite interface_name halftone - num: 4 description: Checking servlet mapping for the default library filename: resources/web/servlets.xml.in type: MATCH find: |- library /library/* - num: 5 description: Editing servlets.xml.in to define library2 that uses default interface and mysite filename: resources/web/servlets.xml.in type: ADD_AT_END text: |- library2 A new library with my new site! org.greenstone.gsdl3.LibraryServlet library_name library2 site_name mysite interface_name default receptionist_class DefaultReceptionist default_lang en library2 /library2/* - num: 6 description: Edit servlets.xml.in to define library rand to use mysite and althor interface filename: resources/web/servlets.xml.in type: ADD_AT_END text: |- rand A new library with my new interface! org.greenstone.gsdl3.LibraryServlet library_name rand site_name mysite interface_name althor receptionist_class DefaultReceptionist default_lang en rand /rand/* --- tutorial: designingANewInterface1 edits: - num: 1 description: Modifying perrin's interfaceConfig.xml to inherit from default interface. filename: web/interfaces/perrin/interfaceConfig.xml type: REPLACE find: |- text: |- - num: 2 description: Edit servlets.xml.in to define library golden using localsite and perrin interface filename: resources/web/servlets.xml.in type: ADD_AT_END text: |- golden A new library with my new interface! org.greenstone.gsdl3.LibraryServlet library_name golden site_name localsite interface_name perrin receptionist_class DefaultReceptionist default_lang en golden /golden/* - num: 3 description: Remove css table import line filename: web/interfaces/perrin/styles/layout.css type: REMOVE find: |- @import url("tables.css"); - num: 3 description: Remove css table import line filename: web/interfaces/perrin/styles/featured_slide.css type: REPLACE find: |- .loader{background:url("../scripts/galleryviewthemes/loader.gif") center center no-repeat;} text: |- .loader{background:url("../images/galleryviewthemes/loader.gif") center center no-repeat;} --- tutorial: designingANewInterface2 edits: - num: 1 description: Replacing placeholder text on new interface's home page. filename: web/interfaces/perrin/transform/pages/home.xsl type: REPLACE find: |- HOME PAGE CONTENT GOES HERE text: |-
    - num: 2 description: Adding collSlider template to end of perrin interface's home.xsl filename: web/interfaces/perrin/transform/pages/home.xsl type: INSERT_BEFORE find: |- text: |- sites//collect//images/ interfaces//images/default.jpg
  • - num: 3 description: Adding template additionalHeaderContent to end of perrin interface's home.xsl filename: web/interfaces/perrin/transform/pages/home.xsl type: INSERT_BEFORE find: |- text: |- - num: 4 description: Appending custom content area to page/pageResponse template in perrin home.xsl filename: web/interfaces/perrin/transform/pages/home.xsl type: INSERT_BEFORE find: |- text: |-
    • Highlighted Item 1
      This is a place where you can put information about an item you would like to highlight in your collection, with or without an accompanying image.

    • Highlighted Item 2
      This is a place where you can put information about an item you would like to highlight in your collection,with or without an accompanying image.

    • Highlighted Item 3
      This is a place where you can put information about an item you would like to highlight in your collection, with or without an accompanying image.


    - num: 5 description: Appending collectionsList and collDescription templates to perrin's home.xsl filename: web/interfaces/perrin/transform/pages/home.xsl type: INSERT_BEFORE find: |- text: |-
    - num: 6 description: Calling collectionsList template from page/pageResponse of perrin's home.xsl filename: web/interfaces/perrin/transform/pages/home.xsl type: INSERT_BEFORE find: |- text: |-

    {$collectionName}

    Welcome to the collection. This collection contains documents.

    - num: 7 description: Replacing the CSS files referred to by perrin's header.xsl filename: web/interfaces/perrin/transform/layouts/header.xsl type: REPLACE find: |- text: |- --- tutorial: designingANewInterface3 edits: - num: 1 description: Insert footer content into perrin's main.xsl filename: web/interfaces/perrin/transform/layouts/main.xsl type: INSERT_AFTER find: |- text: |-
    - num: 2 description: Moving image slider and the highlighted items away from edge filename: web/interfaces/perrin/transform/layouts/main.xsl type: REPLACE find: |-
    text: |-

    - num: 3 description: Part 1 of Navigation Bar and Search Box steps combined in perrin's main.xsl filename: web/interfaces/perrin/transform/layouts/main.xsl type: INSERT_AFTER find: |- text: |-
    - num: 4 description: Part 2 of Navigation Bar and Search Box steps combined in perrin's main.xsl filename: web/interfaces/perrin/transform/layouts/main.xsl type: INSERT_BEFORE find: |- text: |-
  • Home
  • active About
  • Browse
  • Search
  • active /collection//browse/ /collection//browse/1


  • - num: 5 description: Header to display library name and on collection page also coll title. filename: web/interfaces/perrin/transform/layouts/main.xsl type: INSERT_AFTER find: |- text: |-
    - num: 6 description: Part 1 of adding top bar with links for login, help and preferences filename: web/interfaces/perrin/transform/layouts/main.xsl type: REPLACE find: |- text: |- - num: 7 description: Part 2 of adding top bar with links for login, help and preferences filename: web/interfaces/perrin/transform/layouts/main.xsl type: INSERT_BEFORE find: |- text: |- ...