Docs: making tt2 docs more modular
authorJane Sandberg <sandbej@linnbenton.edu>
Fri, 17 Nov 2017 04:11:20 +0000 (20:11 -0800)
committerJane Sandberg <sandbej@linnbenton.edu>
Fri, 17 Nov 2017 04:11:20 +0000 (20:11 -0800)
Signed-off-by: Jane Sandberg <sandbej@linnbenton.edu>
docs/admin/search_interface.adoc [new file with mode: 0644]
docs/admin_initial_setup/designing_your_catalog.adoc
docs/root_command_line_admin.adoc

diff --git a/docs/admin/search_interface.adoc b/docs/admin/search_interface.adoc
new file mode 100644 (file)
index 0000000..92685dc
--- /dev/null
@@ -0,0 +1,100 @@
+Designing the patron search experience
+======================================
+
+Editing the formats select box options in the search interface
+---------------------------------------------------------------
+
+You may wish to remove, rename or organize the options in the formats select
+box. This can be accomplished from the staff client.
+
+. From the staff client, navigate to *Administration -> Server Administration ->  Marc Coded
+Value Maps* 
+. Select _Type_ from the *Record Attribute Type* select box.
+. Double click on the format type you wish to edit.
+
+To change the label for the type, enter a value in the *Search Label* field.
+
+To  move the option to a top list separated by a dashed line from the others,
+check the *Is Simple Selector* check box.
+
+To hide the type so that it does not appear in the search interface, uncheck the
+*OPAC Visible* checkbox.
+
+Changes will be immediate.
+
+Adding and removing search fields in advanced search
+-----------------------------------------------------
+
+It is possible to add and remove search fields on the advanced search page by
+editing the _opac/parts/config.tt2_ file in your template directory. Look for
+this section of the file:
+
+----
+search.adv_config = [
+    {adv_label => l("Item Type"), adv_attr => ["mattype", "item_type"]},
+    {adv_label => l("Item Form"), adv_attr => "item_form"},
+    {adv_label => l("Language"),  adv_attr => "item_lang"},
+    {adv_label => l("Audience"),  adv_attr => ["audience_group", "audience"], adv_break => 1},
+    {adv_label => l("Video Format"), adv_attr => "vr_format"},
+    {adv_label => l("Bib Level"), adv_attr => "bib_level"},
+    {adv_label => l("Literary Form"), adv_attr => "lit_form", adv_break => 1},
+    {adv_label => l("Search Library"), adv_special => "lib_selector"},
+    {adv_label => l("Publication Year"), adv_special => "pub_year"},
+    {adv_label => l("Sort Results"), adv_special => "sort_selector"},
+];
+----
+
+For example, if you delete the line:
+
+----
+{adv_label => l("Language"),  adv_attr => "item_lang"},
+----
+
+the language field will no longer appear on your advanced search page. Changes
+will appear immediately after you save your changes.
+
+You can also add fields based on Search Facet Groups that you create in the
+staff client's Local Administration menu. This can be helpful if you want to
+simplify your patrons' experience by presenting them with only certain
+limiters (e.g. the most commonly used languages in your area).  To do this,
+
+. Click *Administration -> Local Administration -> Search Facet Groups*.
+. Click *New*.
+. Enter descriptive values into the code and label fields.  The owner needs to
+be set to your consortium.
+. Once the Facet Group is created, click on the blue hyperlinked code value.
+. Click the *New* button to create the necessary values for your field.
+. Go to the _opac/parts/config.tt2_ file, and add a line like the following,
+where *Our Library's Field* is the name you'd like to be displayed next to
+your field, and *facet_group_code* is the code you've added using the staff
+client.
++
+----
+ {adv_label => l("Our Library's Field"), adv_filter => "facet_group_code"},
+----
+
+Changing the display of facets and facet groups
+-----------------------------------------------
+
+Facets can be reordered on the search results page by editing the
+_opac/parts/config.tt2_ file in your template directory.  
+
+Edit the following section of _config.tt2_, changing the order of the facet
+categories according to your needs:
+
+----
+
+facet.display = [
+    {facet_class => 'author',  facet_order => ['personal', 'corporate']},
+    {facet_class => 'subject', facet_order => ['topic']},
+    {facet_class => 'series',  facet_order => ['seriestitle']},
+    {facet_class => 'subject', facet_order => ['name', 'geographic']}
+];
+
+----
+
+You may also change the default number of facets appearing under each category
+by editing the _facet.default_display_count_ value in _config.tt2_. The default 
+value is 5.
+
+
index ed18c63..0e13ce9 100644 (file)
@@ -373,103 +373,6 @@ Changes require web server reload to take effect. As root run the command
 service apache2 restart
 ----
 
-
-Editing the formats select box options in the search interface.
----------------------------------------------------------------
-
-You may wish to remove, rename or organize the options in the formats select
-box. This can be accomplished from the staff client.
-
-. From the staff client, navigate to *Administration -> Server Administration ->  Marc Coded
-Value Maps* 
-. Select _Type_ from the *Record Attribute Type* select box.
-. Double click on the format type you wish to edit.
-
-To change the label for the type, enter a value in the *Search Label* field.
-
-To  move the option to a top list separated by a dashed line from the others,
-check the *Is Simple Selector* check box.
-
-To hide the type so that it does not appear in the search interface, uncheck the
-*OPAC Visible* checkbox.
-
-Changes will be immediate.
-
-Adding and removing search fields in advanced search
------------------------------------------------------
-
-It is possible to add and remove search fields on the advanced search page by
-editing the _opac/parts/config.tt2_ file in your template directory. Look for
-this section of the file:
-
-----
-search.adv_config = [
-    {adv_label => l("Item Type"), adv_attr => ["mattype", "item_type"]},
-    {adv_label => l("Item Form"), adv_attr => "item_form"},
-    {adv_label => l("Language"),  adv_attr => "item_lang"},
-    {adv_label => l("Audience"),  adv_attr => ["audience_group", "audience"], adv_break => 1},
-    {adv_label => l("Video Format"), adv_attr => "vr_format"},
-    {adv_label => l("Bib Level"), adv_attr => "bib_level"},
-    {adv_label => l("Literary Form"), adv_attr => "lit_form", adv_break => 1},
-    {adv_label => l("Search Library"), adv_special => "lib_selector"},
-    {adv_label => l("Publication Year"), adv_special => "pub_year"},
-    {adv_label => l("Sort Results"), adv_special => "sort_selector"},
-];
-----
-
-For example, if you delete the line:
-
-----
-{adv_label => l("Language"),  adv_attr => "item_lang"},
-----
-
-the language field will no longer appear on your advanced search page. Changes
-will appear immediately after you save your changes.
-
-You can also add fields based on Search Facet Groups that you create in the
-staff client's Local Administration menu. This can be helpful if you want to
-simplify your patrons' experience by presenting them with only certain
-limiters (e.g. the most commonly used languages in your area).  To do this,
-
-. Click *Administration -> Local Administration -> Search Facet Groups*.
-. Click *New*.
-. Enter descriptive values into the code and label fields.  The owner needs to
-be set to your consortium.
-. Once the Facet Group is created, click on the blue hyperlinked code value.
-. Click the *New* button to create the necessary values for your field.
-. Go to the _opac/parts/config.tt2_ file, and add a line like the following,
-where *Our Library's Field* is the name you'd like to be displayed next to
-your field, and *facet_group_code* is the code you've added using the staff
-client.
-+
-----
- {adv_label => l("Our Library's Field"), adv_filter => "facet_group_code"},
-----
-
-Changing the display of facets and facet groups
------------------------------------------------
-
-Facets can be reordered on the search results page by editing the
-_opac/parts/config.tt2_ file in your template directory.  
-
-Edit the following section of _config.tt2_, changing the order of the facet
-categories according to your needs:
-
-----
-
-facet.display = [
-    {facet_class => 'author',  facet_order => ['personal', 'corporate']},
-    {facet_class => 'subject', facet_order => ['topic']},
-    {facet_class => 'series',  facet_order => ['seriestitle']},
-    {facet_class => 'subject', facet_order => ['name', 'geographic']}
-];
-
-----
-
-You may also change the default number of facets appearing under each category
-by editing the _facet.default_display_count_ value in _config.tt2_. The default 
-value is 5.
-
 Change Date Format in Patron Account View
 -----------------------------------------
 Libraries with same-day circulations may want their patrons to be able to view
index 4d27150..43b2dc5 100644 (file)
@@ -139,6 +139,8 @@ include::admin/template_toolkit.adoc[]
 
 include::admin_initial_setup/designing_your_catalog.adoc[]
 
+include::admin/search_interface.adoc[]
+
 include::opac/sitemap.adoc[]
 
 include::admin/sitemap_admin.adoc[]