Defined Type: mediawiki::errorpage

Defined in:
modules/mediawiki/manifests/errorpage.pp

Overview

Define: mediawiki::errorpage

Creates a file based on the error page template.

Usage

mediawiki::errorpage { '/tmp/error-example.html':

content => '<p>Example</p>'

}

Parameters

filepath

The file path for File resource. (Required)

favicon

URL for favicon. (Use undefined to disable)

Default: undef

doctitle

HTML Document title.

Default: 'Wikimedia Error'

pagetitle

Page heading.

Default: 'Error'

content

Main HTML content, after logo and first heading. (Required)

Default: ''

logo_link

URL for anchor link around logo. (Use undef to omit link.)

Default: 'www.wikimedia.org'

logo_src

URL for logo image.

Default: ''

logo_srcset

HTML srcset attribute value for logo image.

Default: ' 2x'

logo_width

Width attribute for logo image.

Default: 135

logo_height

Height attribute for logo image.

Default: 101

logo_alt

Alternate text for logo image.

Default: 'Wikimedia'

footer

Optional HTML content for the footer. (Use undefined to disable)

Default: undef

Parameters:

  • ensure (Wmflib::Ensure) (defaults to: present)
  • filepath (Stdlib::Unixpath) (defaults to: $name)
  • owner (String) (defaults to: 'root')
  • group (String) (defaults to: 'root')
  • mode (Stdlib::Filemode) (defaults to: '0444')
  • favicon (Optional[String]) (defaults to: undef)
  • doctitle (String) (defaults to: 'Wikimedia Error')
  • pagetitle (String) (defaults to: 'Error')
  • logo_link (Stdlib::Httpurl) (defaults to: 'https://www.wikimedia.org')
  • logo_src (String) (defaults to: 'https://www.wikimedia.org/static/images/wmf-logo.png')
  • logo_srcset (String) (defaults to: 'https://www.wikimedia.org/static/images/wmf-logo-2x.png 2x')
  • logo_width (Integer) (defaults to: 135)
  • logo_height (Integer) (defaults to: 101)
  • logo_alt (String) (defaults to: 'Wikimedia')
  • content (Optional[String]) (defaults to: undef)
  • footer (Optional[String]) (defaults to: undef)
  • margin (Optional[String]) (defaults to: undef)
  • margin_top (Optional[String]) (defaults to: undef) 


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
 
# File 'modules/mediawiki/manifests/errorpage.pp', line 70

define mediawiki::errorpage(
    Wmflib::Ensure $ensure = present,
    Stdlib::Unixpath $filepath = $name,
    String $owner = 'root',
    String $group = 'root',
    Stdlib::Filemode $mode = '0444',
    Optional[String] $favicon = undef,
    String $doctitle = 'Wikimedia Error',
    String $pagetitle = 'Error',
    Stdlib::Httpurl $logo_link = 'https://www.wikimedia.org',
    String $logo_src = 'https://www.wikimedia.org/static/images/wmf-logo.png',
    String $logo_srcset = 'https://www.wikimedia.org/static/images/wmf-logo-2x.png 2x',
    Integer $logo_width = 135,
    Integer $logo_height = 101,
    String $logo_alt = 'Wikimedia',
    Optional[String] $content = undef,
    Optional[String] $footer = undef,
    Optional[String] $margin = undef,
    Optional[String] $margin_top = undef,
) {
    $errorpage = {
        favicon     => $favicon,
        title       => $doctitle,
        pagetitle   => $pagetitle,
        logo_link   => $logo_link,
        logo_src    => $logo_src,
        logo_srcset => $logo_srcset,
        logo_width  => $logo_width,
        logo_height => $logo_height,
        logo_alt    => $logo_alt,
        content     => $content,
        footer      => $footer,
        margin      => $margin,
        margin_top  => $margin_top,
    }
    file { $filepath:
        ensure  => stdlib::ensure($ensure, 'file'),
        owner   => $owner,
        group   => $group,
        mode    => $mode,
        content => mediawiki::errorpage_content($errorpage),
    }
}