Skip to content

Commit ba68ba9

Browse files
spmorrisonspmorrison
authored
Docs: 3.16 updates to kids_opac.adoc
1 parent 7e2f1b7 commit ba68ba9

1 file changed

Lines changed: 58 additions & 150 deletions

File tree

‎docs/modules/opac/pages/kids_opac.adoc‎

Lines changed: 58 additions & 150 deletions
Original file line numberDiff line numberDiff line change
@@ -3,191 +3,99 @@
33

44
== Introduction ==
55

6-
The Kids OPAC (KPAC) is a public catalog search that was designed for children
7-
and teens. Colorful menu items,large buttons, and simple navigation make this
8-
an appealing search interface for kids. Librarians will appreciate the flexible
9-
configuration of the KPAC. Librarians can create links to canned search results
10-
for kids and can apply these links by branch. The KPAC uses the same infrastructure
11-
as the Template Toolkit OPAC (TPAC), the adult catalog search, so you can easily
12-
extend the KPAC using the code that already exists in the TPAC. Finally, third
13-
party content, such as reader reviews, can be integrated into the KPAC.
6+
The Kids’ Catalog (KPAC) is a public catalog search that was designed for children
7+
and teens. Colorful menu items, large buttons, and simple navigation make this
8+
an appealing search interface for kids.
149

15-
== Choose a Skin ==
10+
For steps on configuring the KPAC, see xref:admin_initial_setup:KidsOPAC[Kids’ OPAC Configuration].
1611

17-
Two skins, or design interfaces, have been created for the KPAC. The KPAC was
18-
designed to run multiple skins on a single web server. A consortium, then, could
19-
allow each library system to choose a skin for their patrons.
12+
== Access the Kids’ Catalog ==
2013

21-
*Default Skin:*
14+
To access the catalog, you can click the Kids’ Catalog link in the header of the main public catalog (OPAC), or you can go directly to the URL at https://[domain]/eg/kpac/home.
2215

23-
In this skin, the search bar is the focal point of the top panel and is centered
24-
on the screen. The search grid appears beneath the search bar. Help and Login
25-
links appear at the top right of the interface. You can customize the appearance
26-
and position of these links with CSS. After you login, the user name is displayed
27-
in the top right corner, and the Login link becomes an option to Logout.
16+
== Search the Kids’ Catalog ==
2817

29-
image::kpac/Kids_OPAC1.jpg[Kids_OPAC1]
18+
You can search the catalog using the search bar at the top of the screen or by clicking on a topic in the grid.
3019

31-
*Alternate Monster Skin:*
20+
=== Search Using the Search Bar ===
3221

33-
In this skin, the search bar shares the top panel with a playful monster. The
34-
search grid appears beneath the search bar. Help and Login links appear in bold
35-
colors at the top right of the interface although you can customize these with CSS.
36-
After you login, the Login button disappears.
22+
The following filters are available when completing a search:
3723

38-
image::kpac/Kids_OPAC2.jpg[Kids_OPAC2]
24+
* _Search words_: Type in your search terms here.
25+
* _Type of search_: Options include Word, Title, and Author. Word is the default.
26+
+
27+
image::kpac/kpac_search type.png[Type of search menu with options of Word, Title, and Author]
28+
+
29+
* _Age group_: All Age Groups is the default. Age groups include Preschool, Primary School, Tween, and Juvenile.
30+
+
31+
image::kpac/kpac_age groups.png[Age group selections]
32+
+
33+
* _Library selector_: Click the dropdown to narrow the search to a system or branch.
3934

40-
41-
== Search the Catalog ==
42-
43-
You can search the catalog using only the search bar, the search grid, or the search
44-
bar and the collection drop down menu.
45-
46-
47-
*Search using the Search Bar*
48-
49-
To search the catalog from the home page, enter text into the search bar in the
35+
To search the catalog from the homepage, enter text into the search bar in the
5036
center of the main page, or enter text into the search bar to the right of the
51-
results on a results page. Search indices are configurable, but the default search
52-
indices include author, title and (key)word.
53-
54-
You can use this search bar to search the entire catalog, or, using the configuration
55-
files, you can apply a filter so that search queries entered here retrieve records
56-
that meet specific criteria, such as child-friendly copy locations or MARC audience
57-
codes.
58-
59-
60-
*Search using the Grid*
61-
62-
From the home page, you can search the catalog by clicking on the grid of icons.
63-
An icon search can link to an external web link or to a canned search. For example,
64-
the icon, Musical Instruments, could link to the results of a catalog search on
65-
the subject heading, Musical instruments.
66-
67-
The labels on the grid of icons and the content that they search are configurable
68-
by branch. You can use the grid to search the entire catalog, or, using the
69-
configuration files, you can apply a filter so that search queries entered here
70-
retrieve records associated with specific criteria, such as child-friendly copy
71-
locations or MARC audience codes.
72-
73-
74-
image::kpac/Kids_OPAC4.jpg[Kids_OPAC4]
37+
results on a results page, and click *Search*.
7538

39+
=== Search Using the Grid ===
7640

77-
You can add multiple layers of icons and searches to your grid:
41+
From the homepage, you can click on a topic icon in the grid to see the list of search results within that topic.
7842

43+
Note that some topics have further subtopics that you can filter by.
7944

80-
image::kpac/Kids_OPAC5.jpg[Kids_OPAC5]
45+
image::kpac/kpac_topics.png[Examples of subtopics with icons]
8146

47+
In the screenshot below, the _Counting_ topic was chosen. When viewing the results, you can see the default search terms input to produce results on the topic.
8248

49+
image::kpac/Kpac_topics_results.png[""]
8350

84-
*Search using the Search Bar and the _Collection_ Drop Down Menu*
51+
An icon search can link to an external web link or to a canned search. For example,
52+
the icon for _Musical Instruments_, could link to the results of a catalog search on
53+
the subject heading, _Musical instruments_.
8554

86-
On the search results page, a search bar and drop down menu appear on the right
87-
side of the screen. You can enter a search term and into the search bar and select
88-
a collection from the drop down menu to search these configured collections.
89-
Configured collections might provide more targeted searching for your audience
90-
than a general catalog search. For example, you could create collections by shelving
91-
location or by MARC audience code.
55+
You can add multiple layers of icons and searches to your grid.
9256

57+
Brief information displays for each title in the search results.
9358

94-
image::kpac/Kids_OPAC17.jpg[Kids_OPAC17]
95-
96-
97-
Using any search method, the search results display in the center of the screen.
98-
Brief information displays beneath each title in the initial search result. The
99-
brief information that displays, such as title, author, or publication information,
100-
is configurable.
101-
102-
103-
image::kpac/Kids_OPAC6.jpg[Kids_OPAC6]
104-
105-
106-
For full details on a title, click *More Info*. The full details displays the
107-
configured fields from the title record and copy information. Click *Show more
108-
copies* to display up to fifty results. Use the breadcrumbs at the top to trace
109-
your search history.
110-
111-
112-
image::kpac/Kids_OPAC7.jpg[Kids_OPAC7]
113-
59+
image::kpac/kpac_title options.png[Search results with options for More Info, Ask for This, and Add to List]
11460

61+
For full details on a title, click *More Info*. The full details display the
62+
configured fields from the title record and item information. Click *Show more
63+
copies* to display more results.
11564

11665
== Place a Hold ==
11766

118-
From the search results, click the *Get it!* link to place a hold.
119-
120-
121-
image::kpac/Kids_OPAC11.jpg[Kids_OPAC11]
67+
To place a hold:
12268

69+
. From either the search results or on the title record page, click *Ask for This*.
70+
. You will be led to a _Place Hold_ screen, where you will be prompted to log in if you have not logged in already.
71+
. Once logged in, use the *Select a Library* dropdown to select the pickup location.
72+
. Click *Send Your Request*.
12373

124-
The brief information about the title appears, and, if you have not yet logged in,
125-
the *Get It!* panel appears with fields for username and password. Enter the username
126-
and password, and select the pick up library. Then click *Submit*. If you have
127-
already logged into your account, you need only to select the pick up location,
128-
and click *Submit*.
74+
image::kpac/kpac_place hold.png[Place Hold screen with library selector]
12975

76+
If the hold succeeds, you will get a confirmation message.
13077

131-
image::kpac/Kids_OPAC12.jpg[Kids_OPAC12]
78+
image::kpac/kpac_place hold_success.png[Alert text: Hold Successful! Hooray! Your request for [title] was successful. We will contact you when your item is ready to pick up at [library]]
13279

80+
If the hold fails, you will receive a fail message:
13381

134-
A confirmation of hold placement appears. You can return to the previous record
135-
or to your search results.
136-
137-
138-
image::kpac/Kids_OPAC13.jpg[Kids_OPAC13]
139-
140-
141-
142-
== Save Items to a List ==
143-
144-
You can save items to a temporary list, or, if you are logged in, you can save to
145-
a list of your own creation. To save items to a list, click the *Get it* button
146-
on the Search Results page.
147-
148-
149-
image::kpac/Kids_OPAC14.jpg[Kids_OPAC14]
150-
151-
152-
Select a list in the *Save It!* panel beneath the brief information, and click *Submit*.
153-
154-
155-
image::kpac/Kids_OPAC16.jpg[Kids_OPAC16]
156-
157-
158-
A confirmation of the saved item appears. To save the item to a list or to manage
159-
the lists, click the *My Lists* link to return to the list management feature in
160-
the TPAC.
161-
162-
163-
image::kpac/Kids_OPAC15.jpg[Kids_OPAC15]
164-
165-
166-
167-
== Third Party Content ==
168-
169-
Third party content, such as reader reviews, can be viewed in the Kids OPAC. The
170-
reviews link appears adjacent to the brief information.
171-
172-
image::kpac/Kids_OPAC8.jpg[Kids_OPAC8]
173-
174-
175-
Click the Reviews link to view reader reviews from a third party source. The reader
176-
reviews open beneath the brief information.
82+
image::kpac/kpac_place hold_fail.png[Alert text: Hold Failed. We're sorry. We were unable to request [title] for you. Please ask a librarian to help.]
17783

84+
You can return to the previous record or to your search results. Use the breadcrumbs at the top to trace
85+
your search history.
17886

179-
image::kpac/Kids_OPAC9.jpg[Kids_OPAC9]
87+
image::kpac/kpac_search breadcrumbs.png[Search path links]
18088

89+
== Save Titles to a List ==
18190

182-
Summaries and reviews from other publications appear in separate tabs beneath the
183-
copy information.
91+
You can save titles to a temporary list, or, if you are logged in, you can save a title to one of your existing lists. If you need to create a new list, you will be prompted to do so in your account in the main catalog.
18492

93+
To save items to a list:
18594

186-
image::kpac/Kids_OPAC10.jpg[Kids_OPAC10]
95+
. Click *Add to List*.
96+
. Choose the list name from the *Select a List* dropdown menu.
97+
. Click *Add to Your List*.
18798

188-
== Configuration Files ==
99+
You will receive a success message with links to that specific list and all of your lists, which will open in the main public catalog.
189100

190-
Configuration files allow you to define labels for canned searches in the icon
191-
grid, determine how icons lead users to new pages, and define whether those icons
192-
are canned searches or links to external resources. Documentation describing how
193-
to use the configuration files is available in the Evergreen repository.
101+
image::kpac/kpac_add to list_success.png[Alert text: Hooray! You have added [title] to your list. To access your lists go to My Lists]

0 commit comments

Comments
 (0)