OpenSlides/server/openslides/core/config_variables.py
Magnus Schieder 27682f3742
Make the style of the project titles customizable (#6409)
allow custom font for h1 and h2 projector title
2022-04-26 09:46:31 +02:00

617 lines
17 KiB
Python

import uuid
from django.core.validators import MaxLengthValidator
from openslides.core.config import ConfigVariable
def get_config_variables():
"""
Generator which yields all config variables of this app.
There are two main groups: 'General' and 'Projector'. The group 'General'
has subgroups. The generator has to be evaluated during app loading
(see apps.py).
"""
yield ConfigVariable(
name="general_event_name",
default_value="OpenSlides",
label="Event name",
weight=110,
subgroup="Event",
validators=(MaxLengthValidator(100),),
)
yield ConfigVariable(
name="general_event_description",
default_value="Presentation and assembly system",
label="Short description of event",
weight=115,
subgroup="Event",
validators=(MaxLengthValidator(100),),
)
yield ConfigVariable(
name="general_event_date",
default_value="",
label="Event date",
weight=120,
subgroup="Event",
)
yield ConfigVariable(
name="general_event_location",
default_value="",
label="Event location",
weight=125,
subgroup="Event",
)
yield ConfigVariable(
name="general_event_legal_notice",
default_value='<a href="http://www.openslides.org">OpenSlides</a> is a '
"free web based presentation and assembly system for "
"visualizing and controlling agenda, motions and "
"elections of an assembly.",
input_type="markupText",
label="Legal notice",
weight=131,
subgroup="Event",
hidden=True,
)
yield ConfigVariable(
name="general_event_privacy_policy",
default_value="",
input_type="markupText",
label="Privacy policy",
weight=132,
subgroup="Event",
hidden=True,
)
yield ConfigVariable(
name="general_event_welcome_title",
default_value="Welcome to OpenSlides",
label="Front page title",
weight=133,
subgroup="Event",
hidden=True,
)
yield ConfigVariable(
name="general_event_welcome_text",
default_value="[Space for your welcome text.]",
input_type="markupText",
label="Front page text",
weight=134,
subgroup="Event",
hidden=True,
)
# Live conference
yield ConfigVariable(
name="general_system_conference_show",
default_value=False,
input_type="boolean",
label="Show live conference window",
help_text="Server settings required to activate Jitsi Meet integration.",
weight=140,
subgroup="Live conference",
)
yield ConfigVariable(
name="general_system_conference_los_restriction",
default_value=False,
input_type="boolean",
label="Allow only current speakers and list of speakers managers to enter the live conference",
help_text="Server settings required to activate Jitsi Meet integration.",
weight=141,
subgroup="Live conference",
)
yield ConfigVariable(
name="general_system_conference_auto_connect",
default_value=False,
input_type="boolean",
label="Connect all users to live conference automatically",
help_text="Server settings required to activate Jitsi Meet integration.",
weight=142,
subgroup="Live conference",
)
yield ConfigVariable(
name="general_system_conference_open_microphone",
default_value=False,
input_type="boolean",
label="Automatically open the microphone for new conference speakers",
help_text="Server settings required to activate Jitsi Meet integration.",
weight=143,
subgroup="Live conference",
)
yield ConfigVariable(
name="general_system_conference_open_video",
default_value=False,
input_type="boolean",
label="Automatically open the web cam for new conference speakers",
help_text="Server settings required to activate Jitsi Meet integration.",
weight=144,
subgroup="Live conference",
)
yield ConfigVariable(
name="general_system_conference_auto_connect_next_speakers",
default_value=0,
input_type="integer",
label="Number of next speakers automatically connecting to the live conference",
help_text="Live conference has to be active. Choose 0 to disable auto connect.",
weight=145,
subgroup="Live conference",
)
yield ConfigVariable(
name="general_system_stream_url",
default_value="",
label="Livestream url",
help_text="Remove URL to deactivate livestream. Check extra group permission to see livestream.",
weight=146,
subgroup="Live conference",
)
yield ConfigVariable(
name="general_system_stream_poster",
default_value="",
label="Livestream poster image url",
help_text="Shows if livestream is not started. Recommended image format: 500x200px, PNG or JPG",
weight=147,
subgroup="Live conference",
)
yield ConfigVariable(
name="general_system_conference_enable_helpdesk",
default_value=False,
input_type="boolean",
label="Enable virtual help desk room",
help_text="""
Shows a button with help icon to connect to an extra Jitsi conference room for technical audio/video tests.
""",
weight=148,
subgroup="Live conference",
)
# Applause
yield ConfigVariable(
name="general_system_applause_enable",
default_value=False,
input_type="boolean",
label="Enable virtual applause",
weight=150,
subgroup="Virtual applause",
)
yield ConfigVariable(
name="general_system_applause_type",
default_value="applause-type-bar",
input_type="choice",
choices=(
{
"value": "applause-type-bar",
"display_name": "Level indicator",
},
{
"value": "applause-type-particles",
"display_name": "Particles",
},
),
label="Applause visualization",
weight=151,
subgroup="Virtual applause",
)
yield ConfigVariable(
name="general_system_applause_show_level",
default_value=False,
input_type="boolean",
label="Show applause amount",
weight=152,
subgroup="Virtual applause",
)
yield ConfigVariable(
name="general_system_applause_min_amount",
default_value=1,
input_type="integer",
label="Lowest applause amount",
help_text="Defines the minimum deflection which is required to recognize applause.",
weight=153,
subgroup="Virtual applause",
)
yield ConfigVariable(
name="general_system_applause_max_amount",
default_value=0,
input_type="integer",
label="Highest applause amount",
help_text="Defines the maximum deflection. Entering zero will use the amount of present participants instead.",
weight=154,
subgroup="Virtual applause",
)
yield ConfigVariable(
name="general_system_stream_applause_timeout",
default_value=5,
input_type="integer",
label="Applause interval in seconds",
help_text="Defines the time in which applause amounts are add up.",
weight=155,
subgroup="Virtual applause",
)
yield ConfigVariable(
name="general_system_applause_particle_image",
default_value="",
label="Applause particle image URL",
help_text="Shows the given image as applause particle. Recommended image format: 24x24px, PNG, JPG or SVG",
weight=156,
subgroup="Virtual applause",
)
# General System
yield ConfigVariable(
name="general_system_enable_anonymous",
default_value=False,
input_type="boolean",
label="Allow access for anonymous guest users",
weight=160,
subgroup="System",
)
yield ConfigVariable(
name="general_login_info_text",
default_value="",
label="Show this text on the login page",
weight=162,
subgroup="System",
)
yield ConfigVariable(
name="openslides_theme",
default_value="openslides-default-light-theme",
input_type="choice",
label="OpenSlides Theme",
choices=(
{
"value": "openslides-default-light-theme",
"display_name": "OpenSlides Default",
},
{
"value": "openslides-default-dark-theme",
"display_name": "OpenSlides Dark",
},
{"value": "openslides-red-light-theme", "display_name": "OpenSlides Red"},
{
"value": "openslides-red-dark-theme",
"display_name": "OpenSlides Red Dark",
},
{
"value": "openslides-green-light-theme",
"display_name": "OpenSlides Green",
},
{
"value": "openslides-green-dark-theme",
"display_name": "OpenSlides Green Dark",
},
{
"value": "openslides-solarized-dark-theme",
"display_name": "OpenSlides Solarized",
},
),
weight=164,
subgroup="System",
)
# General export settings
yield ConfigVariable(
name="general_csv_separator",
default_value=",",
label="Separator used for all csv exports and examples",
weight=170,
subgroup="Export",
)
yield ConfigVariable(
name="general_csv_encoding",
default_value="utf-8",
input_type="choice",
label="Default encoding for all csv exports",
choices=(
{"value": "utf-8", "display_name": "UTF-8"},
{"value": "iso-8859-15", "display_name": "ISO-8859-15"},
),
weight=172,
subgroup="Export",
)
yield ConfigVariable(
name="general_export_pdf_pagenumber_alignment",
default_value="center",
input_type="choice",
label="Page number alignment in PDF",
choices=(
{"value": "left", "display_name": "Left"},
{"value": "center", "display_name": "Center"},
{"value": "right", "display_name": "Right"},
),
weight=174,
subgroup="Export",
)
yield ConfigVariable(
name="general_export_pdf_fontsize",
default_value="10",
input_type="choice",
label="Standard font size in PDF",
choices=(
{"value": "10", "display_name": "10"},
{"value": "11", "display_name": "11"},
{"value": "12", "display_name": "12"},
),
weight=176,
subgroup="Export",
)
yield ConfigVariable(
name="general_export_pdf_pagesize",
default_value="A4",
input_type="choice",
label="Standard page size in PDF",
choices=(
{"value": "A4", "display_name": "DIN A4"},
{"value": "A5", "display_name": "DIN A5"},
),
weight=178,
subgroup="Export",
)
# Logos
yield ConfigVariable(
name="logos_available",
default_value=[
"logo_projector_main",
"logo_projector_header",
"logo_web_header",
"logo_pdf_header_L",
"logo_pdf_header_R",
"logo_pdf_footer_L",
"logo_pdf_footer_R",
"logo_pdf_ballot_paper",
],
weight=300,
group="Logo",
hidden=True,
)
yield ConfigVariable(
name="logo_projector_main",
default_value={"display_name": "Projector logo", "path": ""},
input_type="static",
weight=301,
group="Logo",
hidden=True,
)
yield ConfigVariable(
name="logo_projector_header",
default_value={"display_name": "Projector header image", "path": ""},
input_type="static",
weight=302,
group="Logo",
hidden=True,
)
yield ConfigVariable(
name="logo_web_header",
default_value={"display_name": "Web interface header logo", "path": ""},
input_type="static",
weight=303,
group="Logo",
hidden=True,
)
# PDF logos
yield ConfigVariable(
name="logo_pdf_header_L",
default_value={"display_name": "PDF header logo (left)", "path": ""},
input_type="static",
weight=310,
group="Logo",
hidden=True,
)
yield ConfigVariable(
name="logo_pdf_header_R",
default_value={"display_name": "PDF header logo (right)", "path": ""},
input_type="static",
weight=311,
group="Logo",
hidden=True,
)
yield ConfigVariable(
name="logo_pdf_footer_L",
default_value={"display_name": "PDF footer logo (left)", "path": ""},
input_type="static",
weight=312,
group="Logo",
hidden=True,
)
yield ConfigVariable(
name="logo_pdf_footer_R",
default_value={"display_name": "PDF footer logo (right)", "path": ""},
input_type="static",
weight=313,
group="Logo",
hidden=True,
)
yield ConfigVariable(
name="logo_pdf_ballot_paper",
default_value={"display_name": "PDF ballot paper logo", "path": ""},
input_type="static",
weight=314,
group="Logo",
hidden=True,
)
# Fonts
yield ConfigVariable(
name="fonts_available",
default_value=[
"font_regular",
"font_italic",
"font_bold",
"font_bold_italic",
"font_monospace",
"font_chyron_speaker_name",
"projector_h1",
"projector_h2",
],
weight=320,
group="Font",
hidden=True,
)
yield ConfigVariable(
name="font_regular",
default_value={
"display_name": "Font regular",
"default": "assets/fonts/fira-sans-latin-400.woff",
"path": "",
},
input_type="static",
weight=321,
group="Font",
hidden=True,
)
yield ConfigVariable(
name="font_italic",
default_value={
"display_name": "Font italic",
"default": "assets/fonts/fira-sans-latin-400italic.woff",
"path": "",
},
input_type="static",
weight=321,
group="Font",
hidden=True,
)
yield ConfigVariable(
name="font_bold",
default_value={
"display_name": "Font bold",
"default": "assets/fonts/fira-sans-latin-500.woff",
"path": "",
},
input_type="static",
weight=321,
group="Font",
hidden=True,
)
yield ConfigVariable(
name="font_bold_italic",
default_value={
"display_name": "Font bold italic",
"default": "assets/fonts/fira-sans-latin-500italic.woff",
"path": "",
},
input_type="static",
weight=321,
group="Font",
hidden=True,
)
yield ConfigVariable(
name="font_monospace",
default_value={
"display_name": "Font monospace",
"default": "assets/fonts/roboto-condensed-bold.woff",
"path": "",
},
input_type="static",
weight=321,
group="Font",
hidden=True,
)
yield ConfigVariable(
name="font_chyron_speaker_name",
default_value={
"display_name": "Font for speaker name (chyron)",
"default": "assets/fonts/fira-sans-latin-400.woff",
"path": "",
},
input_type="static",
weight=321,
group="Font",
hidden=True,
)
yield ConfigVariable(
name="projector_h1",
default_value={
"display_name": "Projector h1",
"default": "assets/fonts/fira-sans-latin-400.woff",
"path": "",
},
input_type="static",
group="Font",
hidden=True,
)
yield ConfigVariable(
name="projector_h2",
default_value={
"display_name": "Projector h2",
"default": "assets/fonts/fira-sans-latin-400.woff",
"path": "",
},
input_type="static",
group="Font",
hidden=True,
)
# Custom translations
yield ConfigVariable(
name="translations",
label="Custom translations",
default_value=[],
input_type="translations",
weight=1000,
group="Custom translations",
)
# Config version and DB id
yield ConfigVariable(
name="config_version",
input_type="integer",
default_value=1,
group="Version",
hidden=True,
)
yield ConfigVariable(
name="db_id",
input_type="string",
default_value=uuid.uuid4().hex,
group="Version",
hidden=True,
)