Settings
========

settings marked as *required* will generate warnings if left empty

General
-------

:flock_name_public:
	the public name of the database (flock) e.g. 'My Example Membership Organisation' *required*
:flock_name_public_short:
	the short public name of the database (flock) e.g. 'Example'
:address_lines:
	list of address lines for the organisation *required*
:charity_number:
	registered charity number
:company_number:
	registered company number
:contact_email:
	contact us email for the organisation e.g. info@example.com *required*
:invoice_email:
	renamed from `invoiceEmail`
	e.g. billing
:email:
	(deprecated) use contact_email
:phone:
	public phone number of the organisation *required*
:postal_code:
	zip or postal code of the organisation *required*
:website:
	URL for the website of the organisation *required*
:facebook:
	social link
:instagram:
	social link
:linkedin:
	social link
:twitter:
	social link
:youtube:
	social link


Brand
-----
:flock_logo:
	logo (png / svg format preferred) *required*
:flock_logo_monochrome:
	monochrome logo (png / svg format preferred) used in the footer
:flock_logo_square:
	square logo (png / svg format preferred) used for email, invoices and receipts
:flock_banner_image:
	banner (long horizontal image) (png / svg format preferred)
:name_in_logo:
	Is the name of the flock in the logo? (if so then the name isn't shown beneath the logo)
:hide_logo:
	Hides the logo

settings within `palette`

:app_colour:
	renamed from `mainColor`. The base colour which sheepApp will use to generate your theme - this actual colour may not actually appear anywhere if the front-end code decides it's too dark/bright *required*
:brand_colour:
	renamed from `brandColor`. the exact value which will be used in your footer *required*
:header_font_treatment:
	renamed from `headerCase`. font treatment e.g. 'uppercase'

Pro Account Fields
^^^^^^^^^^^^^^^^^^

:app_header_font:
	renamed from `headerFont`. font to be used in header *required* [pro accounts only]
:app_font:
	renamed from `mainFont`. body font *required* [pro accounts only]
:customThemeOverride:
	an override palette (see below) [pro accounts only]

settings within `customThemeOverride` (all values must be provided unless otherwise specified.)

:base:
	main theme colour, used for e.g. header text, icons, buttons
:light1:
	approx 10% lighter (when auto generated) - used very sparingly
:light2:
	approx 25% lighter (when auto generated) - not currently used
:light3:
	approx 40% lighter (when auto generated) - background colour used for e.g. top nav, missing images
:light4:
	approx 50% lighter (when auto generated) - disabled elements e.g. unclickable buttons, unavailable venue slots
:dark:
	approx 20% darker (when auto generated) - primarily used for hover elements
:navText:
	the colour used for text in top nav (usually black) [optional]
:footerText:
	the colour used for text in the branded fat-footeer (usually white) [optional]

Deprecated Brand Fields
^^^^^^^^^^^^^^^^^^^^^^^

:newTheme:
	(deprecated) true / false (new by default 2022)
:newFooter:
	(deprecated) true / false (new by default 2022)
:featureColor:
	(deprecated) feature colour
:buttonColor:
	(deprecated) colour to use for buttons
:hoverColor:
	(deprecated) colour to use on hover

Financial
---------

:default_currency:
	default currency *required*
:financial_year_day:
	start of the financial year day of the month e.g. 8 for 8th
:financial_year_month:
	start of the financial year month e.g. 4 for April
:lower_tax_rate:
	lower tax rate (usually VAT) - default 0.05 *required*
:standard_tax_rate:
	standard tax rate (usually VAT) - default 0.20 *required*
:mandate_scope:
	what can the DD mandate be used for: 'all_transactions', 'donations', 'membership', 'tickets'

Misc
----

:connections:
	list of connection roles to show in user interface
:disable_auto_tags:
	turn off auto tagging: true / false
:gift_aid_rate:
	gift Aid rate (for UK based Gift Aid) - default 0.25
:gift_aid_scope:
	what should have gift aid automatically applied (if a gift aid declaration is on file): 'all_transactions', 'donations', 'membership', 'tickets'
:interest_groups:
	the areas of interest that a user can choose from
:locked_tags:
	list of tags which are "locked" and can't be removed by users with lower permission levels
:team_roles:
	the team/group roles supported by your teams





Config
^^^^^^

:availableOptions:
 - consent (privacy, GDPR consent capture)
 - donations (appeals)
 - events
 - giving (gift aid)
 - membership
 - messages (view messsages sent in-app or via email)
 - payments
 - teams (groups / teams)
 - venues (space reservations)


:newVerify:
	on by default
:health:
	true / false
:interests:
	true / false - ask the member to selec their areas of interest
:invoices:
	true / false
:qualifications:
	true / false

App text, label and content customisation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

:hideLogo:
	true / false
:hideLoginCTA:
	true / false
:signupline:
	e.g. 'Become a member today.',
:loginIntroText:
	custom text for login process
:banner_image:
	URL of banner image
:consentCTA:
	markdown text - call to action for section
:donationsCTA:
	markdown text - call to action for section
:eventsCTA:
	markdown text - call to action for section
:givingCTA:
	markdown text - call to action for section
:membershipCTA:
	markdown text - call to action for section
:teamsCTA:
	markdown text - call to action for section
:eventsReturnAddress:
	URL for the website of the organisation used for return to website link (from events)
:websiteReturnAddress:
	URL for the website of the organisation used for return to website link *required*


Membership
----------

:auto_membership_number:
	auto membership: true / false
:membership_grace_period:
	period after a membership lapses when a member can renew - default 1
:membership_renew_window:
	period before a membership lapses when a member can renew
:random_auto_membership_number:
	use random numbers for membership numbering
:initial_membership_number:
	starting membership number when auto_membership_number is turned on


setting within `membership`

:enabled:
	(membership_enabled) true / false
:allowMultiple:
	(membership_allow_multiple) Allow a member to have multiple active memberships
:paymentOptions:
	list of available payment options for memberships ('gocardless_mandate', 'stripe', 'payLater')
:maxPlansToShow:
	(membership_max_plans_to_show) number of membership plans to show on first screen
:onFinishPath:
	(membership_on_finish_path) relative app URL to redirect the user to on completion
:noSignup:
	(membership_enable_new_registrations) true / false
:certificates:
	(membership_certificates) membership certificates: true / false
:certificateTemplate:
	(membership_certificate_template) custom membership certificate
:membershipCards:
	(membership_cards) true / false
:documentsActiveOnly:
	(membership_documents_active_only) true / false
:documentsPaidOnly:
	(membership_documents_paid_only) true / false
:changeOnRenew:
	(membership_change_on_renew) Allow the member to change plans on renewal: true / false
:linkedWord:
	(membership_linked_member_noun) the word to use when referring to linked members

Membership text, label and content customisation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

:membershipIntro:
	(membership_intro_text) e.g. 'Join today in 4 simple steps.',
:signupline:
	(membership_signupline) e.g. 'Become a member'
:confirmIntroText:
	(membership_confirm_intro_text) e.g. 'Please double check the details and then click confirm'
:updateThankText:
	(membership_thank_text_renew) e.g. 'Thank you for renewing, please click on continue to go to your account.',
:thankText:
	(membership_thank_text_new) text to show when done - opportunity to ask the member to complete and additional process
:almostDoneButtonText:
	(membership_almost_done_button_text) override text e.g. 'Skip'
:onFinishName:
	(membership_on_finish_name) header text to show when done
:interestsIntro:
	(membership_interests_intro) intro text to be used when interests are enabled

:questions:
	(membership_questions) list of strings
:questionDescriptions:
	(membership_question_descriptions) list of question descriptions

:steps:
	Four labels to over-ride the default joining steps  'Configure membership',  'Enter your details',  'Review & Confirm',  'Make Payment'
:stepIntroText:
	Four paragraphs to over-ride the default joining step intro text


setting within `payLater`

:linkText:
	override text for pay later / invoices e.g. 'Request an invoice'

setting within `registrationSwitches`

All are true / false settings

:addressRequired:
	defaults false - true / false
:withDOB:
	include DOB in registration form
:includeDOB:
	default - true
:requireDOB:
	default - true
:hideOptionalFields:
	default - false
:hideOccupation:
	default - false
:withTitle:
	default - false - include title in registration form
:includeDOB:
	default - false
:includeEthnicity:
	default - false
:requireEthnicity:
	default - false
:includeEmergencyContact:
	default - false
:requireEmergencyContact:
	default - false
:includeEmergencyContact2:
	default - false
:requireEmergencyContact2:
	default - false
:addressRequired:
	default - false
:excludeAddress:
	default - false
:onlyBasicDataRequired:
	default - true
:withSource:
	default - false
:withBio:
	default - false
:withKnownAs:
	default - false
:withEmployer:
	default - false
:requireSource:
	default - false
:requireBio:
	default - false
:requireEmployer:
	default - fals


Partners
--------

:discourse_usage:
	`on|off|paused` - forum
:dial9_usage:
	`on|off|paused` - VOIP provider
:email_dropbox_usage:
	`on|off|paused` - Sheep system for importing emails from a named IMAP account
:eventbrite_usage:
	`on|off|paused` - box office
:gocardless_usage:
	`on|off|paused` - direct debit payments
:loqate_usage:
	`on|off|paused` - address auto complete
:mailchimp_usage:
	`on|off|paused` - mailing lists
:stripe_usage:
	`on|off|paused` - credit card payments
:xero_usage:
	`on|off|paused` - accounting software

Partner settings
^^^^^^^^^^^^^^^^

:on:
	partner is (or should be) active - notices will be issued for problems or missing config
:off:
	partner is not in use
:paused:
	partner is normally active but has been paused


Privacy
-------

setting within `privacy`

:privacy_policy_url:
	full url to client privacy policy *required*

:include_form:
	include a privacy form: true / false


Forms
-----

setting within `application`

:noun:
	noun to describe the user completing the form e.g. 'Volunteer' or 'Applicant'
:nounPlural:
	plural of noun
:withdrawPara:
	text to show for users withdrawing an application
:thankPara:
	text to show when an application has been submitted
:introPara:
	intro text to show for applications
:consentPara:
	consent text to show for applications