Skip to content

Theme

theme.models#

FooterConfig #

Bases: Model

A model defining the configuration of the footer

Attributes:

Name Type Description
theme ThemeConfig

Linked theme configuration
logos SponsorImage

Linked sponsor images
Source code in theme/models.py 
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
class FooterConfig(models.Model):
    """A model defining the configuration of the footer

    Attributes:
        theme (ThemeConfig): Linked theme configuration
        logos (SponsorImage): Linked sponsor images
    """
    theme = models.OneToOneField(
        'ThemeConfig', on_delete=models.CASCADE, related_name='footer')
    logos = models.ManyToManyField(
        to='image.Image',
        through='SponsorImage',
        related_name='footer_configs',
        blank=True,
        help_text='Add references to Image objects; make sure these have sufficient contrast with the background (image).'
    )

    def __str__(self):
        return f"Footer for {self.theme.name}"

HeaderConfig #

Bases: Model

A model defing the header configuration

Attributes:

Name Type Description
theme ThemeConfig

Linked theme configuration
show_score bool

Should the score be shown in the header?
Source code in theme/models.py 
77
78
79
80
81
82
83
84
85
86
class HeaderConfig(models.Model):
    """A model defing the header configuration

    Attributes:
        theme (ThemeConfig): Linked theme configuration
        show_score (bool): Should the score be shown in the header?
    """
    theme = models.OneToOneField(
        ThemeConfig, on_delete=models.CASCADE, related_name='header')
    show_score = models.BooleanField(default=False)

SponsorImage #

Bases: Model

A model to define sponsor images for the footer configuration

Attributes:

Name Type Description
footer_config FooterConfig

Linked footer configuration
image Image

Linked image to be used as sponsor image
index int

Order in which the image should be displayed
Source code in theme/models.py 
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
class SponsorImage(models.Model):
    """A model to define sponsor images for the footer configuration

    Attributes:
        footer_config (FooterConfig): Linked footer configuration
        image (image.models.Image): Linked image to be used as sponsor image
        index (int): Order in which the image should be displayed
    """
    footer_config = models.ForeignKey('FooterConfig', on_delete=models.CASCADE, related_name='sponsor_images')
    image = models.ForeignKey('image.Image', on_delete=models.CASCADE)
    index = models.PositiveIntegerField()

    class Meta:
        ordering = ['index']
        unique_together = [['footer_config', 'image']]

    def __str__(self):
        return f"{self.image.title} (Sponsor {self.index + 1})"

ThemeConfig #

Bases: Model

A model defining the theme of an experiment or block

Attributes:

Name Type Description
name str

The name of this theme configuration
description str

The description of this theme config
heading_font_url str

Url of the heading font
body_font_url str

Url of the body font
logo_image Image

Linked image to be used as logo
background_image Image

Linked image to be used as background
Source code in theme/models.py 
 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
class ThemeConfig(models.Model):
    """A model defining the theme of an experiment or block

    Attributes:
        name (str): The name of this theme configuration
        description (str): The description of this theme config
        heading_font_url (str): Url of the heading font
        body_font_url (str): Url of the body font
        logo_image (image.models.Image): Linked image to be used as logo
        background_image (image.models.Image): Linked image to be used as background
    """
    name = models.CharField(max_length=255, unique=True, default='Default')
    description = models.TextField(blank=True, default='')
    heading_font_url = models.CharField(blank=True, max_length=255, default='')
    body_font_url = models.CharField(blank=True, max_length=255, default='')
    logo_image = models.ForeignKey(
        'image.Image',
        blank=True,
        null=True,
        on_delete=models.SET_NULL,
        related_name='theme_logo')
    background_image = models.ForeignKey(
        'image.Image',
        blank=True,
        null=True,
        on_delete=models.SET_NULL,
        related_name='theme_background')

    def __str__(self):
        return self.name