/
app.conf
executable file
·2234 lines (1934 loc) · 101 KB
/
app.conf
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# __
# / _|
# __ _ _ __ _ __ ___ ___ _ __ | |_
# / _` | '_ \| '_ \ / __/ _ \| '_ \| _|
# | (_| | |_) | |_) | (_| (_) | | | | |
# \__,_| .__/| .__(_)___\___/|_| |_|_|
# | | | |
# |_| |_|
# -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
# Providence
# -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
#
# Info @ http://docs.collectiveaccess.org/wiki/App.conf#App.conf
# -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
#
# WHAT: This is the main application configuration file for Providence, designed so that users can easy manage various
# system-wide settings in one convenient location.
#
# WHEN TO CUSTOMIZE: App.conf handles most customizations that are not controlled through the UI or profile (with
# the notable exceptions of: browse, id number configurations, and additional settings for dates, media and search).
# This document is broken into the following sections: Disable, Hierarchies, Titles & Ids, Search,
# Feature Settings, Access Control, Styling, Mapping, System Defaults, Media, Admin Configuration and Export
#
# -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#
# __ __
# | \/ |
# | \ / | ___ _ __ _ _ ___
# | |\/| |/ _ \ '_ \| | | / __|
# | | | | __/ | | | |_| \__ \
# |_| |_|\___|_| |_|\__,_|___/
#
# Control the "New" and "Find" menus in Providence
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
# -----------------------------------
# Menu bar preferences
# -----------------------------------
#
# By default each of the follow record types has a sub-menu in the top-level "New" menu
# list out the configured types. When you choose a type the creation of new record of that type
# is initiated. If you have several types configured sub-menus make sense, but if your setup only
# has one or two types, or is deeply nested then you may want to push the first level of types
# directly onto the menu. Setting the directives below will force the first level of the sub-menu onto
# the "new" menu itself.
#
ca_object_lots_no_new_submenu = 0
ca_objects_no_new_submenu = 0
ca_entities_no_new_submenu = 0
ca_collections_no_new_submenu = 0
ca_occurrences_no_new_submenu = 1
ca_loans_no_new_submenu = 0
ca_movements_no_new_submenu = 0
ca_tours_no_new_submenu = 0
ca_object_representations_no_new_submenu = 0
# -----------------------------------
# Find menu formatting
# -----------------------------------
#
# By default only the top-level item classes ("objects", "entities", "collections") appear in the find menu
# Set the following to a non-zero value to break out each top-level item into a submenu with types
# This allows you do to type-specific searches and browses
#
ca_objects_breakout_find_by_type_in_submenu = 0
ca_object_lots_breakout_find_by_type_in_submenu = 0
ca_object_representations_breakout_find_by_type_in_submenu = 0
ca_entities_breakout_find_by_type_in_submenu = 0
ca_places_breakout_find_by_type_in_submenu = 0
ca_occurrences_breakout_find_by_type_in_submenu = 0
ca_collections_breakout_find_by_type_in_submenu = 0
ca_loans_breakout_find_by_type_in_submenu = 0
ca_movements_breakout_find_by_type_in_submenu = 0
ca_sets_breakout_find_by_type_in_submenu = 1
# Set the following to a non-zero value to put types directly into the find menu, replacing the top-level item class
# This allows you do to type-specific searches and browses where the types are treated as generic top-level items
#
ca_objects_breakout_find_by_type_in_menu = 0
ca_object_lots_breakout_find_by_type_in_menu = 0
ca_object_representations_breakout_find_by_type_in_menu = 0
ca_entities_breakout_find_by_type_in_menu = 0
ca_places_breakout_find_by_type_in_menu = 0
ca_occurrences_breakout_find_by_type_in_menu = 1
ca_collections_breakout_find_by_type_in_menu = 0
ca_loans_breakout_find_by_type_in_menu = 0
ca_movements_breakout_find_by_type_in_menu = 0
ca_sets_breakout_find_by_type_in_menu = 0
# -----------------------------------
# Navigation options
# -----------------------------------
#
# If you only want to allow users to create new records with top-level types for
# a give item type, set the appropriate directive below to 1; if set users will still be able
# to create records for sub-types, but only from within an existing record with a top-level types
# This can be useful if you have a system where sub-types need to be subsidiary to top-level records -
# eg. sub-type records need to have a top-level parent and cannot exist on their own
#
ca_objects_navigation_new_menu_shows_top_level_types_only = 0
ca_entities_navigation_new_menu_shows_top_level_types_only = 0
ca_places_navigation_new_menu_shows_top_level_types_only = 0
ca_occurrences_navigation_new_menu_shows_top_level_types_only = 0
ca_collections_navigation_new_menu_shows_top_level_types_only = 0
ca_object_lots_navigation_new_menu_shows_top_level_types_only = 0
ca_storage_locations_navigation_new_menu_shows_top_level_types_only = 0
ca_loans_navigation_new_menu_shows_top_level_types_only = 0
ca_movements_navigation_new_menu_shows_top_level_types_only = 0
ca_object_representations_navigation_new_menu_shows_top_level_types_only = 0
# You can enumerate the types and sub-types shown in the new menu below.
ca_objects_navigation_new_menu_limit_types_to = []
ca_entities_navigation_new_menu_limit_types_to = []
ca_places_navigation_new_menu_limit_types_to = []
ca_occurrences_navigation_new_menu_limit_types_to = []
ca_collections_navigation_new_menu_limit_types_to = []
ca_object_lots_navigation_new_menu_limit_types_to = []
ca_storage_locations_navigation_new_menu_limit_types_to = []
ca_loans_navigation_new_menu_limit_types_to = []
ca_movements_navigation_new_menu_limit_types_to = []
ca_object_representations_navigation_new_menu_limit_types_to = []
# -----------------------------------
# Show/Hide Representations
# -----------------------------------
#
# Sometimes you want representations enabled for relationship purposes but don't want
# to have the option to create or edit them as free-standing records. You can control
# whether the object representations, when enabled in general above, show up in the "new"
# and "find" menus using the directives below. Set them to a non-zero value to remove
# object representations from the specified menu.
#
ca_object_representations_dont_show_in_new_menu = 0
ca_object_representations_dont_show_in_find_menu = 0
# -----------------------------------
# Show/Hide Tables
# -----------------------------------
#
# If you don't want certain modules to show up in the "New" menu, you can disable them
# here. They will still be searchable and can be created using QuickAdd or direct links
# (e.g. in the editor inspector of a related record, like an Object created from a Lot)
#
ca_objects_dont_show_in_new_menu = 0
ca_entities_dont_show_in_new_menu = 0
ca_places_dont_show_in_new_menu = 0
ca_occurrences_dont_show_in_new_menu = 0
ca_collections_dont_show_in_new_menu = 0
ca_object_lots_dont_show_in_new_menu = 0
ca_storage_locations_dont_show_in_new_menu = 0
ca_loans_dont_show_in_new_menu = 0
ca_movements_dont_show_in_new_menu = 0
# -----------------------------------
# Menu bar caching
# -----------------------------------
#
# Caching the menu bar can significantly increase performance
# If you are developing a profile. caching can prevent you from seeing profile
# changes in real-time, however. So you can disable it here if need be. When using
# the system "in production" it is usually best to leave this enabled
#
do_menu_bar_caching = 1
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#
# _____ _ _ _
# | __ \(_) | | | |
# | | | |_ ___ __ _| |__ | | ___
# | | | | / __|/ _` | '_ \| |/ _ \
# | |__| | \__ \ (_| | |_) | | __/
# |_____/|_|___/\__,_|_.__/|_|\___|
#
# Turn off (or on) various features and database areas.
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
# -----------------------------------
# Editor "disable" switches
# -----------------------------------
#
# If you're not using certain editors in your system (you don't catalogue places for example)
# you can disable the menu items for them by setting the various *_disable directives below to a non-zero value
#
ca_objects_disable = 0
ca_entities_disable = 0
ca_places_disable = 0
ca_occurrences_disable = 0
ca_collections_disable = 0
ca_object_lots_disable = 0
ca_storage_locations_disable = 0
ca_loans_disable = 0
ca_movements_disable = 1
ca_tours_disable = 1
ca_tour_stops_disable = 1
ca_object_representations_disable = 1
# -----------------------------------
# QuickAdd disable switches
# -----------------------------------
#
ca_objects_disable_quickadd = 0
ca_entities_disable_quickadd = 0
ca_places_disable_quickadd = 0
ca_occurrences_disable_quickadd = 0
ca_collections_disable_quickadd = 0
ca_object_lots_disable_quickadd = 0
ca_storage_locations_disable_quickadd = 0
ca_loans_disable_quickadd = 0
ca_movements_disable_quickadd = 0
# -----------------------------------
# Disable "Add new <object> to lot"
# -----------------------------------
# (in the object lot editor inspector)
#
disable_add_object_to_lot_inspector_controls = 0
# -----------------------------------
# Show related counts in the inspector?
# -----------------------------------
#
ca_objects_show_related_counts_in_inspector_for = []
ca_entities_show_related_counts_in_inspector_for = [ca_objects]
ca_places_show_related_counts_in_inspector_for = []
ca_occurrences_show_related_counts_in_inspector_for = [ca_objects]
ca_collections_show_related_counts_in_inspector_for = [ca_objects]
ca_storage_locations_show_related_counts_in_inspector_for = []
ca_loans_show_related_counts_in_inspector_for = []
ca_movements_show_related_counts_in_inspector_for = []
ca_tour_stops_show_related_counts_in_inspector_for = []
# -----------------------------------
# Show "add child record" control in editor inspector?
# -----------------------------------
#
ca_objects_show_add_child_control_in_inspector = 0
ca_entities_show_add_child_control_in_inspector = 0
ca_places_show_add_child_control_in_inspector = 1
ca_occurrences_show_add_child_control_in_inspector = 0
ca_collections_show_add_child_control_in_inspector = 1
ca_storage_locations_show_add_child_control_in_inspector = 1
ca_loans_show_add_child_control_in_inspector = 0
ca_movements_show_add_child_control_in_inspector = 0
ca_tour_stops_show_add_child_control_in_inspector = 0
# -----------------------------------
# Set duplication disable
# -----------------------------------
# If you want to disable the ability to duplicate all items in a set across the board set this
#
ca_sets_disable_duplication_of_items = 0
# -----------------------------------
# Set type controls
# -----------------------------------
#
enable_set_type_controls = 0
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#
# _ _ _ _ _
# | | | (_) | | (_)
# | |__| |_ ___ _ __ __ _ _ __ ___| |__ _ ___ ___
# | __ | |/ _ \ '__/ _` | '__/ __| '_ \| |/ _ \/ __|
# | | | | | __/ | | (_| | | | (__| | | | | __/\__ \
# |_| |_|_|\___|_| \__,_|_| \___|_| |_|_|\___||___/
#
# Settings for hierarchical properties and display.
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
# -----------------------------------
# Strict type hierarchies
# -----------------------------------
#
# When fully enabled, top-level records may only be created with top-level types, and sub-records may only be created
# with types that are direct sub-types of the parent's type. This ensures conformance with the type hierarchy. So
# if you have an object type hierarchy like this:
#
# Book
# -- Page
# ---- Figure
# -- Frontspiece
#
# ... then top-level records can only be of type "Book." Sub-records of books may only be "Page" or "Frontspiece";
# and sub-records of "Page" can be "Figure." "Frontspiece" may not take sub-records.
#
# We partially enabled, top-level records may only be created with top-level types, but sub-records may be of *any*
# type below the top-level type, not just direct sub-types. In the example above, the sub-records of a "book" can be
# of type "Page", "Figure" or Frontspiece; sub-records of a "Page" may be only of type "Figure."
#
# When disabled, all types are allowed anywhere.
#
# The type hierarchy behavior can be independently for each type of hierarchical record.
# Set to 1 to fully enable, 0 to disable and ~ (tilde character) to partially enable restrictions.
#
ca_objects_enforce_strict_type_hierarchy = 0
ca_entities_enforce_strict_type_hierarchy = 0
ca_places_enforce_strict_type_hierarchy = 0
ca_occurrences_enforce_strict_type_hierarchy = 0
ca_collections_enforce_strict_type_hierarchy = 0
ca_storage_locations_enforce_strict_type_hierarchy = 0
ca_loans_enforce_strict_type_hierarchy = 0
ca_tour_stops_enforce_strict_type_hierarchy = 0
ca_list_items_enforce_strict_type_hierarchy = 0
# -----------------------------------
# Hierarchy browser items
# -----------------------------------
#
ca_objects_hierarchy_browser_display_settings = ^ca_objects.preferred_labels.name (^ca_objects.idno)
ca_object_lots_hierarchy_browser_display_settings = ^ca_object_lots.preferred_labels (^ca_object_lots.idno_stub)
ca_entities_hierarchy_browser_display_settings = ^ca_entities.preferred_labels (^ca_entities.idno)
ca_places_hierarchy_browser_display_settings = ^ca_places.preferred_labels (^ca_places.idno)
ca_occurrences_hierarchy_browser_display_settings = ^ca_occurrences.preferred_labels (^ca_occurrences.idno)
ca_collections_hierarchy_browser_display_settings = ^ca_collections.preferred_labels (^ca_collections.idno)
ca_list_hierarchy_browser_display_settings = ^ca_lists.preferred_labels.name (^ca_lists.list_code)
ca_list_items_hierarchy_browser_display_settings = ^ca_list_items.preferred_labels.name_plural (^ca_list_items.idno)
ca_storage_locations_hierarchy_browser_display_settings = ^ca_storage_locations.preferred_labels (^ca_storage_locations.idno)
ca_tour_stops_hierarchy_browser_display_settings = ^ca_tour_stops.preferred_labels (^ca_tour_stops.idno)
ca_relationship_types_hierarchy_browser_display_settings = ^ca_relationship_types.preferred_labels (^ca_relationship_types.type_code)
ca_loans_hierarchy_browser_display_settings = ^ca_loans.preferred_labels (^ca_loans.idno)
ca_movements_hierarchy_browser_display_settings = ^ca_movements.preferred_labels (^ca_movements.idno)
ca_objects_hierarchy_browser_sort_values = [ca_objects.idno_sort]
ca_objects_hierarchy_browser_sort_direction = asc
ca_object_lots_hierarchy_browser_sort_values = [ca_object_lots.idno_stub_sort]
ca_object_lots_hierarchy_browser_sort_direction = asc
ca_entities_hierarchy_browser_sort_values = [ca_entities.preferred_labels.surname, ca_entities.preferred_labels.forename]
ca_entities_hierarchy_browser_sort_direction = asc
ca_places_hierarchy_browser_sort_values = [ca_places.rank, ca_places.preferred_labels.name_sort]
ca_places_hierarchy_browser_sort_direction = asc
ca_occurrences_hierarchy_browser_sort_values = [ca_occurrences.preferred_labels.name_sort]
ca_occurrences_hierarchy_browser_sort_direction = asc
ca_collections_hierarchy_browser_sort_values = [ca_collections.rank, ca_collections.preferred_labels.name_sort]
ca_collections_hierarchy_browser_sort_direction = asc
ca_list_items_hierarchy_browser_sort_values = [ca_list_items.preferred_labels.name_sort_plural]
ca_list_items_hierarchy_browser_sort_direction = asc
ca_list_items_hierarchy_browser_disabled_items_mode = full
ca_storage_locations_hierarchy_browser_sort_values = [ca_storage_locations.rank, ca_storage_locations.preferred_labels.name_sort]
ca_storage_locations_hierarchy_browser_sort_direction = asc
ca_storage_locations_hierarchy_browser_disabled_items_mode = disabled
ca_tour_stops_hierarchy_browser_sort_values = [ca_tour_stops.preferred_labels.name_sort]
ca_tour_stops_hierarchy_browser_sort_direction = asc
ca_relationship_types_hierarchy_browser_sort_values = [ca_relationship_types.preferred_labels.typename]
ca_relationship_types_hierarchy_browser_sort_direction = asc
ca_loans_hierarchy_browser_sort_values = [ca_loans.preferred_labels.name_sort]
ca_loans_hierarchy_browser_sort_direction = asc
ca_movements_hierarchy_browser_sort_values = [ca_movements.preferred_labels.name_sort]
ca_movements_hierarchy_browser_sort_direction = asc
# -----------------------------------
# Collection hierarchies on the Summary screen
# -----------------------------------
#
# The summary screen includes a visual hierarchy by default for hierarchical collections.
# Use these directives to set the sort value for the hierarchical display, as well as the display
# template used for format data. If nothing is set below the system will default to the settings
# outlined in ca_collections_hierarchy_browser_sort_values.
#
ca_collections_hierarchy_summary_display_settings =
ca_collections_hierarchy_summary_sort_values =
ca_objects_hierarchy_summary_display_settings =
ca_collections_hierarchy_summary_show_full_object_hierarachy = 0
# -----------------------------------
# Show/Hide hierarchy root (Storage Locations & Places)
# -----------------------------------
#
# Hide hierarchy root for storage locations or places in New and Find screens
# Note that if you haven't added any items to the hierarchies yet, enabling
# this might prevent you from doing so (because you can't select a parent).
#
ca_storage_locations_hierarchy_browser_hide_root = 0
ca_places_locations_hierarchy_browser_hide_root = 0
# -----------------------------------
# Show/Hide child records in search/browse results
# -----------------------------------
#
# Normally all results, regardless of their position in a hierarchy, are displayed
# in search/browse results. Set this option for alternative policies. Possible
# settings are:
# show = show all results by default; allow user to filter children if they wish
# hide = hide all child records (those that are not at the top of their hierarchy) by default; allow user to remove filtering if desired
# alwaysShow = show all results; do not allow filtering
# alwaysHide = hide all child records; do not allow the user to disable filtering
#
# "alwaysShow" is the default.
#
# While this option may be set for any table, it is typically used only for objects.
#
ca_objects_children_display_mode_in_results = alwaysShow
# -----------------------------------
# Enable display of collections and objects as a single hierarchy
# -----------------------------------
# ca_objects_x_collections_hierarchy_enabled = 1
# ca_objects_x_collections_hierarchy_relationship_type =
# ca_objects_x_collections_hierarchy_disable_object_collection_idno_inheritance =
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#
# _______ _ _ _ _____ _
# |__ __(_) | | | _ |_ _| | |
# | | _| |_| | ___ ___ _| |_ | | __| |___
# | | | | __| |/ _ \/ __| |_ _| | | / _` / __|
# | | | | |_| | __/\__ \ |_| _| || (_| \__ \
# |_| |_|\__|_|\___||___/ |_____\__,_|___/
#
# Set whether or not titles and identifiers are required and unique.
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
# -----------------------------------
# Require input id number value to conform to format? (0=no, 1=yes)
# -----------------------------------
#
require_valid_id_number_for_ca_objects = 0
require_valid_id_number_for_ca_object_lots = 0
require_valid_id_number_for_ca_entities = 1
require_valid_id_number_for_ca_places = 1
require_valid_id_number_for_ca_collections = 1
require_valid_id_number_for_ca_occurrences = 1
require_valid_id_number_for_ca_loans = 0
require_valid_id_number_for_ca_movements = 0
require_valid_id_number_for_ca_tours = 0
require_valid_id_number_for_ca_tour_stops = 0
require_valid_id_number_for_ca_object_representations = 0
require_valid_id_number_for_ca_storage_locations = 0
# -----------------------------------
# Allow dupe id numbers? (0=no, 1=yes)
# -----------------------------------
#
allow_duplicate_id_number_for_ca_objects = 1
allow_duplicate_id_number_for_ca_object_lots = 1
allow_duplicate_id_number_for_ca_entities = 1
allow_duplicate_id_number_for_ca_places = 1
allow_duplicate_id_number_for_ca_collections= 1
allow_duplicate_id_number_for_ca_occurrences= 1
allow_duplicate_id_number_for_ca_list_items= 1
allow_duplicate_id_number_for_ca_loans= 0
allow_duplicate_id_number_for_ca_movements= 0
allow_duplicate_id_number_for_ca_tours= 0
allow_duplicate_id_number_for_ca_tour_stops= 0
allow_duplicate_id_number_for_ca_object_representations = 1
allow_duplicate_id_number_for_ca_storage_locations = 1
# -----------------------------------
# Allow dupe labels? (0=no, 1=yes)
# -----------------------------------
# If set to no, then atttempting to save records with a label already
# in use by another record will fail
#
allow_duplicate_labels_for_ca_objects = 1
allow_duplicate_labels_for_ca_object_lots = 1
allow_duplicate_labels_for_ca_entities = 0
allow_duplicate_labels_for_ca_places = 1
allow_duplicate_labels_for_ca_collections= 0
allow_duplicate_labels_for_ca_occurrences= 0
allow_duplicate_labels_for_ca_storage_locations= 1
allow_duplicate_labels_for_ca_list_items= 1
allow_duplicate_labels_for_ca_loans = 1
allow_duplicate_labels_for_ca_movements= 1
allow_duplicate_labels_for_ca_object_representations= 1
allow_duplicate_labels_for_ca_relationship_types= 1
allow_duplicate_labels_for_ca_set_items= 1
allow_duplicate_labels_for_ca_search_forms= 1
allow_duplicate_labels_for_ca_bundle_displays= 1
allow_duplicate_labels_for_ca_metadata_alert_rules = 1
allow_duplicate_labels_for_ca_editor_uis= 1
allow_duplicate_labels_for_ca_editor_ui_screens= 1
allow_duplicate_labels_for_ca_tours= 1
allow_duplicate_labels_for_ca_tour_stops= 1
# -----------------------------------
# Entity dupe name?
# -----------------------------------
# Set this to 1 if you want to display a warning when a new entity with
# a name that already exists (preferred or nonpreferred) is about to be created
#
ca_entities_warn_when_preferred_label_exists = 0
# -----------------------------------
# Require preferred label? (0=no, 1=yes)
# -----------------------------------
# If set to yes, then attempting to save records without a preferred label
# will fail. If set to no (default) then attempting to save a record without
# a preferred label will automatically set the preferred label to "[BLANK]"
#
require_preferred_label_for_ca_objects = 0
require_preferred_label_for_ca_object_lots = 0
require_preferred_label_for_ca_entities = 0
require_preferred_label_for_ca_places = 0
require_preferred_label_for_ca_collections = 0
require_preferred_label_for_ca_occurrences = 0
require_preferred_label_for_ca_storage_locations = 0
require_preferred_label_for_ca_list_items = 0
require_preferred_label_for_ca_loans = 0
require_preferred_label_for_ca_movements = 0
require_preferred_label_for_ca_object_representations = 0
require_preferred_label_for_ca_relationship_types = 0
require_preferred_label_for_ca_set_items = 0
require_preferred_label_for_ca_search_forms = 0
require_preferred_label_for_ca_bundle_displays = 0
require_preferred_label_for_ca_editor_uis = 0
require_preferred_label_for_ca_editor_ui_screens = 0
require_preferred_label_for_ca_tours = 0
require_preferred_label_for_ca_tour_stops = 0
#
# Set blank label text placeholder to something other than "BLANK"
# The text will always be enclosed in square brackets. For example,
# if this option is set to "No label" blank preferred labels will be
# automatically set to [No label]
#
# Omit or leave blank this option to use the default placeholder of "BLANK"
#
#blank_label_text = No label
# -----------------------------------
# Require preferred label value be present in a list
# -----------------------------------
# If set to a valid list code then any entered label value must match
# a preferred label for an item in that list.
#
preferred_label_for_ca_objects_must_be_in_list =
preferred_label_for_ca_object_lots_must_be_in_list =
preferred_label_for_ca_entities_must_be_in_list =
preferred_label_for_ca_places_must_be_in_list =
preferred_label_for_ca_collections_must_be_in_list =
preferred_label_for_ca_occurrences_must_be_in_list =
preferred_label_for_ca_storage_locations_must_be_in_list =
preferred_label_for_ca_list_items_must_be_in_list =
preferred_label_for_ca_loans_must_be_in_list =
preferred_label_for_ca_movements_must_be_in_list =
preferred_label_for_ca_object_representations_must_be_in_list =
preferred_label_for_ca_relationship_types_must_be_in_list =
preferred_label_for_ca_set_items_must_be_in_list =
preferred_label_for_ca_search_forms_must_be_in_list =
preferred_label_for_ca_bundle_displays_must_be_in_list =
preferred_label_for_ca_editor_uis_must_be_in_list =
preferred_label_for_ca_editor_ui_screens_must_be_in_list =
preferred_label_for_ca_tours_must_be_in_list =
preferred_label_for_ca_tour_stops_must_be_in_list =
# -----------------------------------
# Allow automated renumbering objects with lot idno + sequence number?
# -----------------------------------
# (when object number don't conform to that format)
#
# If you're managing lots with related object-level records and the lot and
# object numbering get out of sync (because you change the lot number after
# the fact, for example) then this can be useful. But it can also be dangerous in the
# sense that letting cataloguers renumber sets of objects at a click may not be the
# idea. Only enable this if you need it. Keep in mind that the automated renumbering format
# is fixed at lot <lot identifier> + <separator> + <sequential number starting from one>. So if
# your lot number is 2010.10 and your separator is '.', then objects will be numbered 2010.10.1,
# 2010.10.2, 2010.10.3, etc.
#
allow_automated_renumbering_of_objects_in_a_lot = 0
# -----------------------------------
# Label-less objects
# -----------------------------------
# If you don't want to specify preferred labels for objects set this to a non-zero value
# This can be useful for collections where individual items lack working names, such as in
# paleontology.
ca_objects_dont_use_labels = 0
# -----------------------------------
# Label-specific sort
# -----------------------------------
# Set to assume a specific language when generating sortable titles regardless of the locale set for the title. This can be useful when content
# has been entered specific (or accurate) locale settings. The value can be a specific locale (Ex. "en_US") or a language code (Ex. "en")
#
use_locale_for_sortable_titles =
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#
# _____ _
# / ____| | |
# | (___ ___ __ _ _ __ ___| |__
# \___ \ / _ \/ _` | '__/ __| '_ \
# ____) | __/ (_| | | | (__| | | |
# |_____/ \___|\__,_|_| \___|_| |_|
#
#
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
# -----------------------------------
# Search engine configuration
# -----------------------------------
#
search_engine_plugin = SqlSearch
# -----------------------------------
# Browse Panel Styles
# -----------------------------------
# (for best results, choose a number between 1 and 5)
#
browse_row_size = 4
# -----------------------------------
# Quicksearch - order and results ("live" search in search box in header)
# -----------------------------------
#
# What sorts of results does Quicksearch return?
# List table names here to include them in the search, in the order they should appear. This is only the default
# display configuration, which can be overriden by user preferences. Syntax is ca_table/type, i.e ca_objects/video
#
quicksearch_default_results = [ca_objects, ca_entities, ca_places, ca_occurrences, ca_collections, ca_object_lots, ca_storage_locations, ca_loans, ca_movements, ca_tours, ca_tour_stops]
# -----------------------------------
# Quicksearch - break out by type?
# -----------------------------------
#
# What table types are broken out in the result list? Syntax is list within square brackets, i.e [ca_objects, ca_entities]
#
quicksearch_breakout_by_type =
# -----------------------------------
# Restrict facets shown to specific facet groups?
# <table_name>_browse_facet_group limits facets on the main browse landing page
# <table_name>_refine_facet_group limits facets in the "refine" browse on detail pages
# <table_name>_search_refine_facet_group limits facets in the "refine" browse on search results
# -----------------------------------
#
# ca_objects_browse_facet_group = main
# ca_objects_refine_facet_group = refine
# ca_objects_search_refine_facet_group = refine
# -----------------------------------
# One table search
# -----------------------------------
# If set to a controller in the "find" module, will use that for quicksearch rather
# than the regular "Quicksearch" controller. This is useful for having the Quicksearch
# operate on a single table
#
# one_table_search =
# -----------------------------------
# Out of process search indexing
# -----------------------------------
# Switch to disable out of process search indexing
#
disable_out_of_process_search_indexing = 0
# Hostname to use when triggering out of process indexing
# By default the site hostname configured in setup.php is used but you can override it
# here if the hostname resolvable on the server differs from that used for incoming requests
out_of_process_search_indexing_hostname =
# Socket protocol to use when triggering out of process indexing. Maybe set to tcp or tls
# By default tcp is used when the incoming request is http and tls is used when https is employed.
# You can override it here to use a constant protocol.
out_of_process_search_indexing_protocol =
# Port to use when triggering out of process indexing
# By default the port used is 80 when the incoming request is http or 443 when https is used.
# You can override it here to use a constant port.
out_of_process_search_indexing_port =
# -----------------------------------
# Caption formatting for search/browse "thumbnail" results
# -----------------------------------
# Set a display template here to customize display of captions under thumbnails in the thumbnail result view. The
# template will be evaluated relative to each record in the result set.
#
ca_objects_results_thumbnail_caption_template = ^ca_objects.preferred_labels.name%truncate=27&ellipsis=1<br/><l>^ca_objects.idno</l>
ca_occurrences_results_thumbnail_caption_template = ^ca_occurrences.preferred_labels.name%truncate=27&ellipsis=1<br/><l>^ca_occurrences.idno</l>
ca_entities_results_thumbnail_caption_template = ^ca_entities.preferred_labels.name%truncate=27&ellipsis=1<br/><l>^ca_entities.idno</l>
ca_collections_results_thumbnail_caption_template = ^ca_collections.preferred_labels.name%truncate=27&ellipsis=1<br/><l>^ca_collections.idno</l>
# -----------------------------------
# Search/browse result set sorting
# -----------------------------------
# Restrict available sort options to those fields present in the currently selected display.
# If set to zero all sort options are shown, including those for data that may not be currently displayed.
#
restrict_find_result_sort_options_to_current_display = 1
#
# Sorts for specific tables can be configured to show in all cases using <table>_include_result_sorts
# The value is a list of sorts with the sort specification on the left and display name of the sort on the right
#
ca_objects_include_result_sorts = {
# ca_entities.preferred_labels.surname/artist = _(Artist)
}
# -----------------------------------
# Hierarchy browser in storage location and list item search interfaces
# -----------------------------------
# Control whether the last browsed item is used as the initially selected item
# in the hierarchy browser. Set to 0 to remember the last browsed item, 1 to always
# start the hierarchy browser at the top of the hierarchy
#
ca_storage_locations_dont_remember_last_browse_item = 0
ca_list_items_dont_remember_last_browse_item = 0
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#
# ______ _
# | ____| | |
# | |__ ___ __ _| |_ _ _ _ __ ___ ___
# | __/ _ \/ _` | __| | | | '__/ _ \/ __|
# | | | __/ (_| | |_| |_| | | | __/\__ \
# |_| \___|\__,_|\__|\__,_|_| \___||___/
#
# Settings related to various features such as: location tracking, deaccessioning,
# WorldCat, check in/check out and more.
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
# -----------------------------------
# Location tracking options
# (See http://docs.collectiveaccess.org/wiki/Location_tracking for details)
# -----------------------------------
# ---
# Direct object-location reference storage location tracking
# (also set this for movement-based storage location tracking)
# ---
#
object_storage_location_tracking_relationship_type =
# ---
# Movement-based storage location tracking
# ---
#
movement_storage_location_tracking_relationship_type =
movement_object_tracking_relationship_type =
record_movement_information_when_moving_storage_location = 0
movement_storage_location_date_element =
# -----------------------------------
# Deaccession options
# -----------------------------------
deaccession_force_access_private = 1
deaccession_dont_allow_editing = 0
deaccession_use_disposal_date = 1
# -----------------------------------
# Library-style check-out of objects
# -----------------------------------
enable_library_services = 0
enable_object_checkout = 0
# -----------------------------------
# User generated content
# -----------------------------------
enable_user_generated_content = 1
# -----------------------------------
# ResourceSpace import
# -----------------------------------
# The ResourceSpace data importer allows records and media to be imported from a ResourceSpace Installation
# The importer connects using a username and API Key that is unique to that user and can be found in the
# edit user page under the Admin > Manage Users tab in ResourceSapce
#
# Also required is the base URL for your ResourceSpace installation which all API calls are based on
# This should be your root url + /api/
#
resourcespace_apis = {
EXAMPLE_CARE_SYSTEM = {
resourcespace_label = ,
resourcespace_base_api_url = ,
resourcespace_user =
}
}
# -----------------------------------
# WorldCat import
# -----------------------------------
# The data importer can access OCLC WorldCat via either their web service API or Z39.50 service.
# Using the web service API requires that PHP be installed with libCURL support. Using Z39.50
# requires that PHP be built with libyaz support (http://www.indexdata.com/yaz). Many PHP installations
# have libCURL installed by default; most do not have libyaz installed.
#
# The importer will connect ia Z39.50 if a username and password are configured below and libyaz is available, otherwise
# the web service API will be used as a fallback, assuming a valid API key is configured below and libCURL is available.
#
worldcat_api_key = MY_WORLDCAT_API_KEY
worldcat_z39.50_user =
worldcat_z39.50_password =
# Optionally mark WorldCat items already present in system using ISBN
# To enable set "worlcat_isbn_element_code" to the ca_objects metadata element code containing the ISBN code for the book.
worlcat_isbn_element_code =
# Display template used to format "ISBN present" message. Evaluated relative to the existing object.
# You can use standard display template codes (eg. ^ca_objects.idno) to display details about the match.
worlcat_isbn_exists_template = <span class="caWorldCatExistingObjectIcon"><l><i class="fa fa-external-link" aria-hidden="true"></i></span></l>
# Template formatting the "key" displayed below WorldCat query results. Use this to define any icons used in the "worlcat_isbn_exists_template"
worlcat_isbn_exists_key = <div class="caWorldCatExistingObjectKey"><i class="fa fa-external-link" aria-hidden="true"></i> = Previously imported</div>
# -----------------------------------
# Taxonomy web services
# -----------------------------------
# To access the uBio taxonomic name service (http://www.ubio.org)
# via a 'Taxonomy' attribute you must enter your uBio API keycode here
# If you don't care about taxonomy (or even know what is it) then leave this as-is
#
ubio_keycode = enter_your_keycode_here
# -----------------------------------
# Flickr API
# -----------------------------------
# flickr_api_key =
# -----------------------------------
# "Rich text" (aka. wysiwyg) editor options
# -----------------------------------
# You can read more about available text editor options here: http://docs.cksource.com/CKEditor_4.x/Developers_Guide/Toolbar
#
# Defines options available in the toolbar
wysiwyg_editor_toolbar = {
formatting = [Bold, Italic, Underline, Strike, -, Subscript, Superscript, Font, FontSize, TextColor],
lists = [-, NumberedList, BulletedList, Outdent, Indent, Blockquote],
links = [Link, Unlink, Anchor],
misc = [SelectAll, Undo, Redo, -, Source, Maximize, Image, CALink]
}
# Defines options available in the toolbar
wysiwyg_content_editor_toolbar = {
formatting = [Bold, Italic, Underline, Strike, -, Subscript, Superscript, Font, FontSize, TextColor],
lists = [-, NumberedList, BulletedList, Outdent, Indent, Blockquote],
links = [Link, Unlink, Anchor],
misc = [SelectAll, Undo, Redo, -, Source, Maximize, Media, CALink]
}
# -----------------------------------
# Enable dependent field visibility feature
# -----------------------------------
# See here for more information: http://docs.collectiveaccess.org/wiki/Dependent_Field_Visibility
#
enable_dependent_field_visibility = 0
# -----------------------------------
# Global template values (Pawtucket content management)
# -----------------------------------
# Globals are text values that may be set in the Pawtucket web UI and substituted
# into any view template, including headers and footers. Values defined here
# will be editable in the "Global Values Editor" (available to users with the can_edit_theme_global_values priv)
# and usable in templates under their name (Eg. {{{operating_hours}}} in the example below).
#
# Options controlling how the editor displays the value may be set for each global. Width and height control the size
# of the element; usewysiwygeditor enables a "wysiwyg" rich text editor for formatted text.
#
global_template_values = {
#hours_of_operation = {
# name = Hours of operation,
# description = List current operating hours here,
# width = 600px,
# height = 150px,
# usewysiwygeditor = 0
#}
}
# -----------------------------------
# Site page templates (Pawtucket content management)
# -----------------------------------
#
# Allow PHP code in content-managed site pages
#
# By default only value tags in the form {{{tag-name}}} are allowed in Pawtucket site page templates.
# If you need the flexibility and power afforded by direct embedding of PHP code in your templates
# set this option to a non-zero value. Note that enabling this option will allow execution of ANY
# code embedded in the template on EVERY page load. Depending upon your point of view this is either a
# feature or a security hole. It doesn't have to be a problem, but keep it in mind...
#
# Note that this setting only affects page previews in Providence. To allow PHP code execution in Pawtucket
# you must also set this option in your theme.
#
allow_php_in_site_page_templates = 0
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
# _____ _ _
# /\ / ____| | | | |
# / \ ___ ___ ___ ___ ___ | | ___ _ __ | |_ _ __ ___ | |
# / /\ \ / __/ __/ _ \/ __/ __| | | / _ \| '_ \| __| '__/ _ \| |
# / ____ \ (_| (_| __/\__ \__ \ | |___| (_) | | | | |_| | | (_) | |
# /_/ \_\___\___\___||___/___/ \_____\___/|_| |_|\__|_| \___/|_|
#
# Structural mechanisms that control who can see what, and how (optional).
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
# -----------------------------------
# Bundle-level access control
# -----------------------------------
default_bundle_access_level = __CA_BUNDLE_ACCESS_EDIT__
# -----------------------------------
# Type-level access control
# -----------------------------------
perform_type_access_checking = 0
default_type_access_level = __CA_BUNDLE_ACCESS_EDIT__
# -----------------------------------
# Source-level access control
# -----------------------------------
perform_source_access_checking = 0
default_source_access_level = __CA_BUNDLE_ACCESS_EDIT__
# -----------------------------------
# Item-level access control
# -----------------------------------
perform_item_level_access_checking = 0
default_item_access_level = __CA_ACL_EDIT_DELETE_ACCESS__
# You can control item-level access control support
# for each type of item using these directives
ca_objects_dont_do_item_level_access_control = 0
ca_object_lots_dont_do_item_level_access_control = 0
ca_entities_dont_do_item_level_access_control = 0
ca_places_dont_do_item_level_access_control = 0
ca_occurrences_dont_do_item_level_access_control = 0
ca_collections_dont_do_item_level_access_control = 0
ca_lists_dont_do_item_level_access_control = 0
ca_list_items_dont_do_item_level_access_control = 0
ca_loans_dont_do_item_level_access_control = 0
ca_movements_dont_do_item_level_access_control = 0
ca_object_representations_dont_do_item_level_access_control = 0
ca_representation_annotations_dont_do_item_level_access_control = 0
ca_storage_locations_dont_do_item_level_access_control = 0
ca_tours_dont_do_item_level_access_control = 0
ca_tour_stops_dont_do_item_level_access_control = 0
# Defaults for collection-to-object ACL inheritance settings
# Set to 1 to make default to inherit; 0 for default to be no inheritance
ca_collections_acl_inherit_from_parent_default = 0
ca_objects_acl_inherit_from_ca_collections_default = 0
ca_objects_acl_inherit_from_parent_default = 0
# -----------------------------------
# Administrator
# -----------------------------------
# User_id to consider "administrator" - not subject to access control measures.
# By default, user_id=1 is considered administrator for convenience and compatbility with older
# installations. You can make any user_id "administrator" if you want, however, if disable this completely
# by setting it to a blank value.
#
administrator_user_id = 1
# email user when account is activated in Manage > Access control?
email_user_when_account_activated = 0
# -----------------------------------
# Set Access
# -----------------------------------
# If you want all users to see all sets regardless of ownership or access control set this to one
# (Yes, some people apparently want to do this)
#
ca_sets_all_users_see_all_sets = 0
# -----------------------------------
# "Access" inheritance
# -----------------------------------
# Allows child records to receive the "access" field value of their immediate parent. This can be useful when
# you generally want child record access to mirror that of the parent, but with occasional cataloguer-defined exceptions
#
# Currently only supported for ca_objects
ca_objects_allow_access_inheritance = 0
# Default inheritance status for newly created ca_objects records
ca_objects_access_inheritance_default = 1
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#
# _____ _ _ _
# / ____| | | (_)
# | (___ | |_ _ _| |_ _ __ __ _