Koha Documentation
==================
-This is the main repository for the Koha manual
-It is mirrored at git.koha-community.org also
\ No newline at end of file
+This is the main repository for the Koha manual.
+It is mirrored at git.koha-community.org.
+
+The manual is generated with Sphinx.
+
+Setup
+-----
+
+> sudo apt-get install python3-sphinx python3-sphinxcontrib.spelling
+
+Outputing Docs
+--------------
+
+### For HTML
+> make html
+
+### For HTML in a single page
+> make singlehtml
+
+### For an epub
+> make epub
+
+### For a pdf (Work in progress)
+
+Install latexmk, the latexpdf builder needs it
+
+> apt install latexmk
+
+Install texlive-full. Attention: this is very huge
+
+> apt install texlive-full
+
+Generate the latex files
+
+> make latex
+
+Generate the PDF file
+
+> make latexpdf
+
+
+Other useful commands
+---------------------
+
+To find everything that you can do, you can just do
+
+> make
+
+And it will list all the available options. Some useful ones are
+
+### Check spelling
+> make spelling
+
+### Check links in the documentation
+> make linkcheck
+
+### Generate .po files for translation
+> make gettext
- Orders added to the basket in this way will notify the patron via
email that their suggestion has been ordered and will update the
- patron's ':ref:`My purchase suggestions <my-purchase-suggestions-label>`' page
+ patron's ':ref:`your purchase suggestions <your-purchase-suggestions-label>`' page
in the OPAC.
- If you're using the `Serials <#serials>`__ module you can link your
You will be unable to edit the 'Library code'
+.. _library-groups-label:
+
Library groups
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- Collection codes (appears when cataloging and working with items)
+- CONTROL\_NUM\_SEQUENCE
+
+ - Used to generate control numbers in the advanced cataloguing editor.
+ Enter a string ending with a number as the authorized value and use
+ the description to describe the type of number. For example: 'sprLib0001'
+ 'Springfield library'. In the advanced editor this will activate a
+ new widget that will allow you to choose the type of number and
+ generate the next number in the sequence.
+
- COUNTRY
- Used in UNIMARC 102 $a
|image1216|
These options will appear in the OPAC for patrons to choose from on the
-:ref:`messaging tab <my-messaging-label>` if you have
+:ref:`messaging tab <your-messaging-label>` if you have
:ref:`EnhancedMessagingPreferences`
enabled.
Lists
~~~~~~~~~~~~~~~~~~~~~~
-Patrons can manage their own private lists by visiting the 'my lists'
+Patrons can manage their own private lists by visiting the 'your lists'
section of their account.
|image965|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Once the list is saved patrons can begin adding items to it. From the
-'my lists' tab on the patron record the patron can edit and delete the
+'your lists' tab on the patron record the patron can edit and delete the
lists they have created by clicking the appropriate link to the right of
the list name.
more appropriate (be it an adult, resident, non resident, student, etc)
and add a cardnumber/barcode.
-.. _my-account-label:
+.. _your-account-label:
-My Account
+Your account
-------------------------------
From the OPAC patrons can log in and access their account if you have
|image1303|
-.. _my-summary-label:
+.. _your-summary-label:
-My Summary
+Your summary
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|image1003|
-From the 'my summary' tab, patrons will see all of the items they have
+From the 'your summary' tab, patrons will see all of the items they have
checked out with the overdue items highlighted in red. If you have
:ref:`OpacRenewalAllowed` set to 'Allow' then your
patrons will be able to renew their books right from the OPAC. If you
|image1391|
If their guarantee has allowed it via :ref:`their
-privacy <my-privacy-label>`, when the guarantor logs in they will see a
+privacy <your-privacy-label>`, when the guarantor logs in they will see a
tab labeled "Relatives' checkouts" on their summary tab.
|image1304|
|image1008|
The 'Fines' tab will show just a total of what the patron owes. Clicking
-on the total will take them to the 'my fines' tab where they will see a
+on the total will take them to the 'your fines' tab where they will see a
complete breakdown of their fines and bills. If you don't charge fines
at your library you can turn the display of these tabs off by setting
the :ref:`OPACFinesTab` preference to 'Don't Allow.'
|image1013|
-.. _my-fines-label:
+.. _your-fines-label:
-My Fines
+Your fines
~~~~~~~~~~~~~~~~~~~~~~~~~~~
-If your library charges fines the next tab on the left is 'my fines.'
+If your library charges fines the next tab on the left is 'your fines'.
Opening this tab will show the patron an entire history of their
accounting at the library.
|image1308|
-.. _my-details-label:
+.. _your-details-label:
-My Details
+Your personal details
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you have your :ref:`OPACPatronDetails` preference
set to 'Allow', your patrons will see a form filled in with their
-contacting information by clicking on the 'my personal details' tab. You
+contacting information by clicking on the 'Your personal details' tab. You
can control what fields patrons see and can modify via the OPAC by
setting the
:ref:`PatronSelfRegistrationBorrowerMandatoryField`
|image1018|
-.. _my-tags-label:
+.. _your-tags-label:
-My Tags
+Your tags
~~~~~~~~~~~~~~~~~~~~~~~~~
If your library has :ref:`TagsEnabled` set to 'Allowed' then
-the next tab on the left will be 'my tags.' This tab will show patrons
+the next tab on the left will be 'your tags'. This tab will show patrons
all of the tags in the system as a cloud and then all of the tags they
have applied in a list format. From here patrons have the ability to
remove tags that they have added if they want.
|image1019|
-.. _change-my-password-label:
+.. _change-your-password-label:
-Change My Password
+Change your password
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Next, if you have :ref:`OpacPasswordChange` set to
-'Allow' the next tab will be 'change my password,' where patrons can
+'Allow' the next tab will be 'change your password,' where patrons can
change their password for logging into the OPAC. Patrons will be
presented with a standard form asking them to enter their old password
and then their new password twice.
|image1020|
-.. _my-search-history-label:
+.. _your-search-history-label:
-My Search History
+Your search history
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you have your :ref:`EnableOpacSearchHistory`
preference set to 'Allow' then your patrons can access their search
-history via the 'my search history' tab.
+history via the 'your search history' tab.
|image1021|
|image1022|
-.. _my-reading-history-label:
+.. _your-reading-history-label:
-My Reading History
+Your reading history
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Depending on your library's setting for
:ref:`opacreadinghistory` your patrons may see the
-'my reading history' tab next. This will show the patron their entire
+'your reading history' tab next. This will show the patron their entire
reading history unless they have asked the library to not keep that
-information via the 'my privacy' tab which will appear if you have the
+information via the 'your privacy' tab which will appear if you have the
:ref:`OPACPrivacy` preference set to 'Allow.'
|image1023|
:ref:`OPACMySummaryHTML` preference then you will see
that to the right of the 'Date' column.
-.. _my-privacy-label:
+.. _your-privacy-label:
-My Privacy
+Your privacy
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-The 'my privacy' tab will appear if you have both the
+The 'your privacy' tab will appear if you have both the
:ref:`opacreadinghistory` and the
:ref:`OPACPrivacy` preferences set to 'Allow.' This tab will
allow the patrons to decide how the library keeps their circulation
- Never: Delete my reading history immediately. This will delete all
record of the item that was checked-out upon check-in.
-Depending on the patron's suggestions the contents of the ':ref:`my reading
-history <my-reading-history-label>`' tab and the ':ref:`Circulation
+Depending on the patron's suggestions the contents of the ':ref:`Your reading
+history <your-reading-history-label>`' tab and the ':ref:`Circulation
History <circulation-history-label>`' tab in the staff client may change.
Regardless of the patron's choice they can delete their reading history
|image1310|
-.. _my-purchase-suggestions-label:
+.. _your-purchase-suggestions-label:
-My Purchase Suggestions
+Your purchase suggestions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If your library allows patrons to make purchase suggestions the next tab
set to 'Show' then patrons will be able to search suggestions from the
top of this list.
-.. _my-messaging-label:
+.. _your-messaging-label:
-My Messaging
+Your messaging
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If your library has the
'Digest only?' if you would like to receive a digest of the
messages.
-.. _my-lists-label:
+.. _your-lists-label:
-My Lists
+Your lists
~~~~~~~~~~~~~~~~~~~~~~~~~~~
If your library has the :ref:`virtualshelves`
-set to 'Allow' they will see the 'my lists' tab. From here your
+set to 'Allow' they will see the 'your lists' tab. From here your
patrons can review public lists and create or edit their own private
lists.
|image1032|
-.. _my-interlibrary-loan-requests-label:
+.. _your-interlibrary-loan-requests-label:
-My Interlibrary Loan Requests
+Your interlibrary loan requests
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If your library has the :ref:`ILLModule` preference set to ‘Enable’ patrons will have the option to make ILL requests when logged in to their OPAC account. From here they can view their existing requests and place new ones.
|image1034|
-And there will be a link on the patron's :ref:`My Purchase
-Suggestions <my-purchase-suggestions-label>` tab.
+And there will be a link on the patron's :ref:`Your purchase
+suggestions <your-purchase-suggestions-label>` tab.
|image1035|
to perform all of these actions. If you would like to control parameter
permissions on a more granular level choose from these options:
+- manage\_audio\_alerts
+
+ - Manage audio alerts
+
+ - The ability to access the :ref:`Audio alerts <audio-alerts-label>`
+ configuration in the administration module.
+
+- manage\_auth\_values
+
+ - Manage authorized value categories and authorised values
+
+ - The ability to access the :ref:`Auhorized values <authorized-values-label>`
+ configuration in the administration module.
+
- manage\_circ\_rules
- Manage circulation rules
- The ability to access the :ref:`Circulation and fines
- rules <circulation-and-fine-rules-label>` in the administration area
+ rules <circulation-and-fine-rules-label>` configuration
+ in the administration module.
+
+- manage\_circ\_rules\_from\_any\_libraries
+
+ - Manage circulation rules form any library. If not set the logged in user can
+ only edit circulation rules from their own library (please note that
+ manage\_circ\_rules is still required).
+
+- manage\_cities
+
+ - Manage cities and towns
+
+ - The ability to access the :ref:`Cities and towns <cities-and-towns-label>`
+ configuration in the administration module.
+
+- manage\_classifications
+
+ - Manage classification sources and filing rules
+
+ - The ability to access the :ref:`Classification sources <classification-sources-label>`
+ configuration in the administration module.
+
+- manage\_column\_config
+
+ - Manage column configuration
+
+ - The ability the access the :ref:`Configure columns <column-settings-label>`
+ page in the administration module.
+
+- manage\_didyoumean
+
+ - Manage Did you mean? configuration
+
+ - The ability to access the :ref:`Did you mean? <did-you-mean?-label>`
+ configuration in the administration module.
+
+- manage\_item\_circ\_alerts
+
+ - Manage item circulation alerts
+
+ - The ability to access the :ref:`Item circulation alerts <item-circulation-alerts-label>`
+ configuration in the administration module.
+
+- manage\_item\_search\_fields
+
+ - Manage item search fields
+
+ - The ability to access the :ref:`Item search fields <item-search-fields-label>`
+ configuration in the administration module.
+
+- manage\_itemtypes
+
+ - Manage item types
+
+ - The ability to access the :ref:`Item types <item-types-label>`
+ configuration in the administratoin module.
+
+- manage\_keywords2koha\_mappings
+
+ - Manage Keywords to Koha mappings
+
+ - The ability to access the :ref:`Keywords to MARC mapping <keywords-to-marc-mapping-label>`
+ configuration in the administration module.
+
+- manage\_libraries
+
+ - Manage libraries and library groups
+
+ - The ability to access the :ref:`Libraries <libraries-label>` and
+ :ref:`Library groups <library-groups-label>` configuration pages
+ in the administration module.
+
+- manage\_marc\_frameworks
+
+ - Manage MARC bibliographic and authority frameworks and test them
+
+ - The ability to access the
+ :ref:`MARC bibliographic framework <marc-bibliographic-frameworks-label>`,
+ :ref:`Authority types <authority-types-label>`,
+ :ref:`Koha to MARC mapping <koha-to-marc-mapping-label> `, and
+ :ref:`MARC Bibliographic framework test <marc-bibliographic-framework-test-label>`
+ configuration areas in the administration module.
+
+- manage\_matching\_rules
+
+ - Manage record matching rules
+
+ - The ability to access the :ref:`Record matching rules <record-matching-rules-label>`
+ configuration in the administration module.
+
+- manage\_oai\_sets
+
+ - Manage OAI sets
+
+ - The ability to access the :ref:`OAI sets <oai-sets-configuration-label>`
+ configuration in the administration module.
+
+- manage\_patron\_attributes
+
+ - Manage extened patron attributes
+
+ - The ability to access the :ref:`Patron attribute types <patron-attribute-types-label>`
+ configuration in the administration module.
+
+- manage\_patron\_categories
+
+ - Manage patron categories
+
+ - The ability to access the :ref:`Patron categories <patron-categories-label>`
+ configuration in the administration module.
+
+- manage\_search\_engine\_config
+
+ - Manage search engine configuration
+
+ - The ability to access the Search engine configuraton in the
+ administration module. Note: This area will only be visible when
+ the :ref:`SearchEngine` system preference is set to 'Elasticsearch'.
+
+- manage\_search\_targets
+
+ - Manage Z39.50 and SRU server configuration
+
+ - The ability to access the :ref:`Z39.50/SRU servers <z39.50/sru-servers-label>`
+ configuration in the administration module.
+
+- manage\_sms_providers
+
+ - Manage SMS cellular providers
+
+ - The ability to access the :ref:`SMS cellular providers <sms-cellular-providers-label>` configuration
+ in the administration module. Note: This area will only be visible when
+ the :ref:`SMSSendDriver` system preference is set to 'Email'.
+
+- manage\_sysprefs
+
+ - Manage global system preferences
+
+ - The ability to access the :ref:`Global system preferences <administration-label>`
+ in the administration module.
+
+- manage\_transfers
+
+ - Manage library transfer limits and transport cost matrix
+
+ - The ability to access the :ref:`Library transfer limits <library-transfer-limits-label>`
+ and :ref:`Transport cost matrix <transport-cost-matrix-label>`
+ configuration pages in the administration module.
+
+- manage\_usage\_stats
+
+ - Manage usage statistics settings
+
+ - Ability to access the :ref:`Share your usage statistics <share-anonymous-usage-statistics-label>`
+ configuration in the administration module.
- parameters\_remaining\_permissions
- Remaining system parameters permissions
- - The ability to access all areas in Administration (other than the
- Circulation and fines rules)
+ - The ability to access all remaining areas in the administration module.
.. _granular-borrowers-permissions-label:
- budget\_add\_del
- - Add and delete budgets (but can't modify budgets)
+ - Add and delete funds (but can't modify funds)
- budget\_manage
- - Manage budgets
+ - Manage funds
- budget\_manage\_all
- - Manage all budgets
+ - Manage all funds
budget\_modify
- - Modify budget (can't create lines, but can modify existing ones)
+ - Modify funds (can't create lines, but can modify existing ones)
- contracts\_manage
- Manage contracts
- currencies\_manage
-
+
- Manage currencies and exchange rates
+
+ - The ability to access the :ref:`Currencies and exchange rates <currencies-and-exchange-rates-label>`
+ configuration page.
- edi\_manage
- group\_manage
- - Manage orders and basket groups
+ - Manage basket groups
- order\_manage
- - Manage orders and baskets
+ - Manage baskets and order lines
- order\_manage\_all
- - Manage all orders and baskets, regardless of restrictions on them
+ - Manage all baskets and order lines, regardless of restrictions on them
- order\_receive
- - Manage orders and baskets
+ - Receive orders and manage shipments
- period\_manage
- - Manage periods
+ - Manage budgets
- planning\_manage
- - Manage budget planning
+ - Manage budget plannings
- suggestions\_manage
- vendors\_manage
- Manage vendors
+
+ - Note: Vendors are used in the acquisition and the serials module.
.. _granular-serials-permissions-label:
OPACMySummaryHTML
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Asks: Include a "Links" column on the "my summary" tab when a user is
+Asks: Include a "Links" column on the "your summary" tab when a user is
logged in to the OPAC, with the following HTML (leave blank to disable).
Description:
- In this preference you can enter HTML that will appear on the
- 'Checked Out' tab on the 'My Summary' section when logged in to the
+ 'Checked Out' tab on the 'your summary' section when logged in to the
OPAC. The placeholders {BIBLIONUMBER}, {TITLE}, {ISBN} and {AUTHOR}
will be replaced with information from the displayed record. This can
be used to enter in 'share' links for social networks or generate
- This preference will display text above the patron's summary and
below the welcome message when the patron logs in to the OPAC and
- view their 'my summary' tab.
+ view their 'your summary' tab.
|image1193|
Description:
- If you're :ref:`allowing patrons to make purchase
- suggestions <suggestion-label>` then they will see the 'my
+ suggestions <suggestion-label>` then they will see the 'your purchase
suggestions' tab when logged in. This tab shows the patron the
librarian who approved or rejected the purchase suggestion. This
preference controls if the patron sees the librarian's name or not.
Default: Allow
-Asks: \_\_\_ patrons to access the Fines tab on the My Account page on
+Asks: \_\_\_ patrons to access the Fines tab on the 'your summary' page on
the OPAC.
Values:
Reading history is still stored, regardless of staff being allowed
access or not unless the patron has chosen to have their history
- anonymized via their :ref:`privacy page <my-privacy-label>`.
+ anonymized via their :ref:`privacy page <your-privacy-label>`.
.. _maxfine-label:
2. The patron has requested to receive this notice
- - *Get there:*\ OPAC > Login > my messaging
+ - *Get there:*\ OPAC > Login > your messaging
- *Get there:*\ Staff client > Patron record >
:ref:`Notices`
2. The patron has requested to receive this notice
- - *Get there:*\ OPAC > Login > my messaging
+ - *Get there:*\ OPAC > Login > your messaging
- *Get there:*\ Staff client > Patron record >
:ref:`Notices`
2. The patron has requested to receive this notice
- - *Get there:*\ OPAC > Login > my messaging
+ - *Get there:*\ OPAC > Login > your messaging
- *Get there:*\ Staff client > Patron record >
:ref:`Notices`
2. The patron has requested to receive this notice as a digest
- - *Get there:*\ OPAC > Login > my messaging
+ - *Get there:*\ OPAC > Login > your messaging
- *Get there:*\ Staff client > Patron record >
:ref:`Notices`
2. The patron has requested to receive this notice
- - *Get there:*\ OPAC > Login > my messaging
+ - *Get there:*\ OPAC > Login > your messaging
- *Get there:*\ Staff client > Patron record >
:ref:`Notices`
2. The patron has requested to receive this notice
- - *Get there:*\ OPAC > Login > my messaging
+ - *Get there:*\ OPAC > Login > your messaging
- *Get there:*\ Staff client > Patron record >
:ref:`Notices`
2. The patron has requested to receive this notice as a digest
- - *Get there:*\ OPAC > Login > my messaging
+ - *Get there:*\ OPAC > Login > your messaging
- *Get there:*\ Staff client > Patron record >
:ref:`Notices`
3. The patron has requested to receive the checkout notice
- - *Get there:*\ OPAC > Login > my messaging
+ - *Get there:*\ OPAC > Login > your messaging
- *Get there:*\ Staff client > Patron record >
:ref:`Notices`
projects / kohadocs.git / commitdiff