Skip to content

Commit b4521ef

Browse files
roblibsoftwareroblibsoftware
committed
update docs
welcome page, borrower import
1 parent 3ba9226 commit b4521ef

9 files changed

Lines changed: 297 additions & 48 deletions

File tree

‎assets/.DS_Store‎

-6 KB
Binary file not shown.

‎assets/img/athenaeum_windows.png‎

23.9 KB
Loading

‎assets/img/web_pages_480.png‎

39.7 KB
Loading

‎assets/javascripts/.DS_Store‎

-6 KB
Binary file not shown.

‎borrower_import/index.html‎

Lines changed: 116 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -833,6 +833,15 @@
833833
</label>
834834
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
835835

836+
<li class="md-nav__item">
837+
<a href="#basic-fields" class="md-nav__link">
838+
<span class="md-ellipsis">
839+
Basic Fields
840+
</span>
841+
</a>
842+
843+
</li>
844+
836845
<li class="md-nav__item">
837846
<a href="#import-generic-csv-data" class="md-nav__link">
838847
<span class="md-ellipsis">
@@ -1463,6 +1472,15 @@
14631472
</label>
14641473
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
14651474

1475+
<li class="md-nav__item">
1476+
<a href="#basic-fields" class="md-nav__link">
1477+
<span class="md-ellipsis">
1478+
Basic Fields
1479+
</span>
1480+
</a>
1481+
1482+
</li>
1483+
14661484
<li class="md-nav__item">
14671485
<a href="#import-generic-csv-data" class="md-nav__link">
14681486
<span class="md-ellipsis">
@@ -1650,12 +1668,109 @@ <h1 id="importing-borrowers">Importing Borrowers</h1>
16501668
<p>As described earlier, borrowers can be any entity to whom you issue items, in accordance with your library policy. Students, Teachers, Rooms, Other Libraries.</p>
16511669
<p>While manually entering borrowers is one way, importing data from a variety of sources is much quicker.</p>
16521670
<p>Imports are generally performed while viewing the list of borrowers and clicking the Utility button (or pressing "u" on the keyboard), clicking the Manipulate/utility tab and the choosing your import.</p>
1671+
<p>You will import the basic data and then adjust some settings such as the borrower type (which can be done in bulk, of course).</p>
16531672
<p><img alt="borrower utility import tab" src="../assets/img/borrower_utility_import_tab.png" /></p>
16541673
<p>Athenaeum can import generic CSV (comma separated value) files and can also import particular CSV files from a number of common New Zealand based student management systems.</p>
1674+
<h2 id="basic-fields">Basic Fields</h2>
1675+
<p>There are many fields available for borrower information. However, the suggested minimum fields are:</p>
1676+
<table>
1677+
<thead>
1678+
<tr>
1679+
<th>field</th>
1680+
<th>description</th>
1681+
</tr>
1682+
</thead>
1683+
<tbody>
1684+
<tr>
1685+
<td>code</td>
1686+
<td>a unique code for that borrower that becomes their bar code (this should be consistent over multiple imports as it is used to marry up to existing borrowers)</td>
1687+
</tr>
1688+
<tr>
1689+
<td>first name</td>
1690+
<td></td>
1691+
</tr>
1692+
<tr>
1693+
<td>last name</td>
1694+
<td>the family name of the borrower</td>
1695+
</tr>
1696+
<tr>
1697+
<td>preferred name</td>
1698+
<td>(optional) can be used if different to the first name</td>
1699+
</tr>
1700+
<tr>
1701+
<td>group 1</td>
1702+
<td>in schools, this is usually the "Year" level</td>
1703+
</tr>
1704+
<tr>
1705+
<td>group 2</td>
1706+
<td>in schools, this is usually the "home room" or "whanau" or "tutor group" (etc.)</td>
1707+
</tr>
1708+
<tr>
1709+
<td>email</td>
1710+
<td>(optional and helpful)</td>
1711+
</tr>
1712+
</tbody>
1713+
</table>
1714+
<p>Athenaeum also has extra fields available should you choose to use them:</p>
1715+
<table>
1716+
<thead>
1717+
<tr>
1718+
<th>field</th>
1719+
<th>description</th>
1720+
</tr>
1721+
</thead>
1722+
<tbody>
1723+
<tr>
1724+
<td>gender</td>
1725+
<td>(optional) useful if analysing issues by gender</td>
1726+
</tr>
1727+
<tr>
1728+
<td>ethnicity</td>
1729+
<td>(optional)</td>
1730+
</tr>
1731+
<tr>
1732+
<td>custom 1</td>
1733+
<td></td>
1734+
</tr>
1735+
<tr>
1736+
<td>custom 2</td>
1737+
<td></td>
1738+
</tr>
1739+
<tr>
1740+
<td>custom 3</td>
1741+
<td></td>
1742+
</tr>
1743+
<tr>
1744+
<td>custom 4</td>
1745+
<td></td>
1746+
</tr>
1747+
<tr>
1748+
<td>contact name first</td>
1749+
<td></td>
1750+
</tr>
1751+
<tr>
1752+
<td>contact name last</td>
1753+
<td></td>
1754+
</tr>
1755+
<tr>
1756+
<td>address fields 1 to 4 plus postcode</td>
1757+
<td></td>
1758+
</tr>
1759+
<tr>
1760+
<td>contact phone number</td>
1761+
<td></td>
1762+
</tr>
1763+
<tr>
1764+
<td>optional log in account</td>
1765+
<td></td>
1766+
</tr>
1767+
</tbody>
1768+
</table>
16551769
<h2 id="import-generic-csv-data">Import generic CSV data</h2>
16561770
<p>Will allow you to import a CSV file into Athenaeum which will then match the data using the bar code and load into the borrower table.</p>
1771+
<p>The data required to be imported is relatively minimal.</p>
16571772
<p>When you click the import button and choose your file, you are presented with an "import mapping" dialog box. This allows you to align (map) the fields (columns) in the CSV file to the target fields in Athenaeum.</p>
1658-
<p><img alt="Borrower Import map" src="../assets/img/borrower_import_map.png" /> </p>
1773+
<p><img alt="Borrower Import map" src="../assets/img/borrower_import_map.png" /></p>
16591774
<p>There is quite a lot going on with this window and this flexibility allows us to process different kinds of CSV files.</p>
16601775
<p>On the right is the mapping of the import data to the field names in Athenaeum.</p>
16611776
<p>At to top, you can choose to "Add" the data - which is the normal action in these scripted import actions.</p>

‎index.html‎

Lines changed: 150 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -280,13 +280,64 @@
280280
</li>
281281

282282
<li class="md-nav__item">
283-
<a href="#inbuilt-resources" class="md-nav__link">
283+
<a href="#multiple-components" class="md-nav__link">
284284
<span class="md-ellipsis">
285-
Inbuilt resources
285+
Multiple components
286286
</span>
287287
</a>
288288

289-
<nav class="md-nav" aria-label="Inbuilt resources">
289+
<nav class="md-nav" aria-label="Multiple components">
290+
<ul class="md-nav__list">
291+
292+
<li class="md-nav__item">
293+
<a href="#servers" class="md-nav__link">
294+
<span class="md-ellipsis">
295+
Server(s)
296+
</span>
297+
</a>
298+
299+
</li>
300+
301+
<li class="md-nav__item">
302+
<a href="#the-main-app" class="md-nav__link">
303+
<span class="md-ellipsis">
304+
The main app
305+
</span>
306+
</a>
307+
308+
</li>
309+
310+
<li class="md-nav__item">
311+
<a href="#the-web-portal" class="md-nav__link">
312+
<span class="md-ellipsis">
313+
The Web portal
314+
</span>
315+
</a>
316+
317+
</li>
318+
319+
<li class="md-nav__item">
320+
<a href="#webdirect" class="md-nav__link">
321+
<span class="md-ellipsis">
322+
WebDirect
323+
</span>
324+
</a>
325+
326+
</li>
327+
328+
</ul>
329+
</nav>
330+
331+
</li>
332+
333+
<li class="md-nav__item">
334+
<a href="#inbuilt-support-resources" class="md-nav__link">
335+
<span class="md-ellipsis">
336+
Inbuilt support resources
337+
</span>
338+
</a>
339+
340+
<nav class="md-nav" aria-label="Inbuilt support resources">
290341
<ul class="md-nav__list">
291342

292343
<li class="md-nav__item">
@@ -1352,13 +1403,64 @@
13521403
</li>
13531404

13541405
<li class="md-nav__item">
1355-
<a href="#inbuilt-resources" class="md-nav__link">
1406+
<a href="#multiple-components" class="md-nav__link">
1407+
<span class="md-ellipsis">
1408+
Multiple components
1409+
</span>
1410+
</a>
1411+
1412+
<nav class="md-nav" aria-label="Multiple components">
1413+
<ul class="md-nav__list">
1414+
1415+
<li class="md-nav__item">
1416+
<a href="#servers" class="md-nav__link">
1417+
<span class="md-ellipsis">
1418+
Server(s)
1419+
</span>
1420+
</a>
1421+
1422+
</li>
1423+
1424+
<li class="md-nav__item">
1425+
<a href="#the-main-app" class="md-nav__link">
1426+
<span class="md-ellipsis">
1427+
The main app
1428+
</span>
1429+
</a>
1430+
1431+
</li>
1432+
1433+
<li class="md-nav__item">
1434+
<a href="#the-web-portal" class="md-nav__link">
1435+
<span class="md-ellipsis">
1436+
The Web portal
1437+
</span>
1438+
</a>
1439+
1440+
</li>
1441+
1442+
<li class="md-nav__item">
1443+
<a href="#webdirect" class="md-nav__link">
1444+
<span class="md-ellipsis">
1445+
WebDirect
1446+
</span>
1447+
</a>
1448+
1449+
</li>
1450+
1451+
</ul>
1452+
</nav>
1453+
1454+
</li>
1455+
1456+
<li class="md-nav__item">
1457+
<a href="#inbuilt-support-resources" class="md-nav__link">
13561458
<span class="md-ellipsis">
1357-
Inbuilt resources
1459+
Inbuilt support resources
13581460
</span>
13591461
</a>
13601462

1361-
<nav class="md-nav" aria-label="Inbuilt resources">
1463+
<nav class="md-nav" aria-label="Inbuilt support resources">
13621464
<ul class="md-nav__list">
13631465

13641466
<li class="md-nav__item">
@@ -1413,9 +1515,49 @@ <h1 id="athenaeum-library-software">Athenaeum Library Software</h1>
14131515
<p><a href="https://librarysoftware.nz/">https://librarysoftware.nz/</a></p>
14141516
<h2 id="welcome-to-athenaeum">Welcome to Athenaeum</h2>
14151517
<p>Athenaeum has been designed with librarians from around the world to be easy to start using and - when you are ready - have more features and configurability to do the things you are likely to want to do. It is focussed predominantly for schools though is used by community and private libraries around the world.</p>
1416-
<p>First introduced in 1996 and has been in continual development - driven largely by the user base. Commencing in 2013, and released officially in 2018, Athenaeum was been completely rewritten as a single file solution<sup id="fnref:1"><a class="footnote-ref" href="#fn:1">1</a></sup> using modern FileMaker techniques with a view to creating a "lighter" solution, optimising performance over wide area networks, for FileMaker WebDirect (e.g. using Chrome/Edge/Safari), FileMaker Go (iPad/iPhone).</p>
1518+
<p>First introduced in 1996 and has been in continual development - driven largely by the user base. Commencing in 2013, and released officially in 2018, Athenaeum was been completely rewritten with a view to creating a "lighter" solution, optimising performance over wide area networks, for FileMaker WebDirect (e.g. using Chrome/Edge/Safari), FileMaker Go (iPad/iPhone). The web portal and blog has also been redeveloped for new and modern features.</p>
14171519
<p>Since then, hundreds of tweaks and new features have been rolled out.</p>
1418-
<h2 id="inbuilt-resources">Inbuilt resources</h2>
1520+
<h2 id="multiple-components">Multiple components</h2>
1521+
<p>Athenaeum is a set of technologies that work together and are deployed according to requirements.</p>
1522+
<h3 id="servers">Server(s)</h3>
1523+
<p>The server(s) run the main database and the web portals. These can be different machines. Users don't normally interact directly with the server, except the web pages that may be hosted.</p>
1524+
<h3 id="the-main-app">The main app</h3>
1525+
<p>The main app is a FileMaker Pro database that connects to the server and provides:</p>
1526+
<ul>
1527+
<li>
1528+
<p>catalogue administration</p>
1529+
</li>
1530+
<li>
1531+
<p>circulation services (issuing, returning, extending, etc)</p>
1532+
</li>
1533+
<li>
1534+
<p>detailed reporting</p>
1535+
</li>
1536+
<li>
1537+
<p>borrower administration</p>
1538+
</li>
1539+
</ul>
1540+
<p><img alt="screen snippets from the main app" src="assets/img/athenaeum_windows.png" /></p>
1541+
<h3 id="the-web-portal">The Web portal</h3>
1542+
<p>The main entry point for most users providing:</p>
1543+
<ul>
1544+
<li>
1545+
<p>the library "blog" (the landing page for library announcements, highlighted features, guided searches, internal and external curriculum information links)</p>
1546+
</li>
1547+
<li>
1548+
<p>catalogue search</p>
1549+
</li>
1550+
<li>
1551+
<p>when authenticated, borrower current issues, reserves and history along with optional reserve and review options</p>
1552+
</li>
1553+
<li>
1554+
<p>optional issuing, returning and stock taking for authenticated users</p>
1555+
</li>
1556+
</ul>
1557+
<p><img alt="some typical web pages - each styled according to their library's preference" src="assets/img/web_pages_480.png" /></p>
1558+
<h3 id="webdirect">WebDirect</h3>
1559+
<p>When configured, WebDirect allows access to many administration functions of the main app in a web page. Some options are not available here.</p>
1560+
<h2 id="inbuilt-support-resources">Inbuilt support resources</h2>
14191561
<p>The Athenaeum support resources contain 100s of short silent and narrated videos showing how to perform many tasks in Athenaeum. Current support holders have access to all published resources. Expired support users can access a base "free to view" set.</p>
14201562
<h3 id="searchable-database">Searchable database</h3>
14211563
<p>Access the searchable list of support resources at the administrator main menu:</p>
@@ -1432,14 +1574,6 @@ <h2 id="other-resources">Other resources</h2>
14321574
<li><a href="http://librarysoftware.nz/download/doc/index.html">Documentation - what you are reading now</a></li>
14331575
<li><a href="https://groups.google.com/forum/#!forum/athenaeum-user-group">Athenaeum forum - an invitation only closed forum for discussion all things Athenaeum and libraries</a></li>
14341576
</ul>
1435-
<div class="footnote">
1436-
<hr />
1437-
<ol>
1438-
<li id="fn:1">
1439-
<p>the separate bar code file can be deployed when necessary&#160;<a class="footnote-backref" href="#fnref:1" title="Jump back to footnote 1 in the text">&#8617;</a></p>
1440-
</li>
1441-
</ol>
1442-
</div>
14431577

14441578

14451579

‎search/search_index.json‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)