Merge branch 'permissions' into 'master'
authorChris Cormack <chris@bigballofwax.co.nz>
Thu, 6 Dec 2018 20:05:58 +0000 (20:05 +0000)
committerChris Cormack <chris@bigballofwax.co.nz>
Thu, 6 Dec 2018 20:05:58 +0000 (20:05 +0000)
Taiga 726, 727: Add new granular parameters permissions

See merge request koha-community/koha-manual!201

README.md
source/administration.rst

index 3c86d77..581559d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,5 +1,61 @@
 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
index e1e706f..9473fa3 100644 (file)
@@ -407,6 +407,15 @@ use, for instance 'Lost'.
 
    -  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