def validParams():
params = MooseObject.validParams()
params.addParam('class', 'The class property for RemarkJS CSS content')
params.addParam('name', 'The name of the slide')
params.addParam('background-image', 'The background image file name')
params.addParam('comments', 'Additional slide comments')
params.addParam(
'show_in_contents', True,
'Toggle if the slide appears in the table-of-contents')
params.addParam('prefix',
'Raw markdown to insert before slide content')
params.addParam('suffix', 'Raw markdown to insert after slide content')
params.addParam(
'auto_title', True,
'Enable/disable automatic addition of (cont.) for slides without a title.'
)
params.addParam('slides', 'A list of slides to include')
params.addParam(
'auto_insert_github_code', True,
'When true links to GitHub code is automatically inserted')
params.addParam(
'insert_github_code_link', 'top',
'When auto linking code place the link at with the code (top | bottom | none)'
)
# Remark properties that should remain in the raw markdown
params.addParamsToGroup('properties',
['name', 'class', 'background-image'])
params.addPrivateParam('title', False)
return params
def validParams():
params = MooseObject.validParams()
params.addParam('caption', 'The image caption')
params.addParam('show_caption', True,
'Toggle the visibility of the caption')
params.addParam('name', 'The image file name')
params.addParam('url', 'The image file url')
params.addParam('download', False, 'Download the image locally')
params.addPrivateParam(
'markdown') # The raw markdown source for this image
params.addParam('div-center', True, 'Wrap html figure in centered div')
params.addParam('align', 'The image horizontal alignment')
params.addParam('width', 'The image width')
params.addParam('height', 'The image height')
params.addParam('style', 'The img style property')
params.addParam('vertical-align',
'The vertical alignment of the image')
params.addParam('text-align', 'Text alignment of image')
params.addParam('caption', 'The caption for the image')
params.addParamsToGroup(
'html',
['align', 'width', 'height', 'vertical-align', 'text-align'])
return params
def validParams():
params = MooseObject.validParams()
params.addParam('class', 'The class property for RemarkJS CSS content')
params.addParam('background-image', 'The background image file name')
params.addParam('comments', 'Additional slide comments')
params.addParam('show_in_contents', True, 'Toggle if the slide appears in the table-of-contents')
params.addParamsToGroup('properties', ['class', 'background-image'])
params.addPrivateParam('title', False)
return params
def validParams():
params = MooseObject.validParams()
params.addParam('class', 'The class property for RemarkJS CSS content')
params.addParam('background-image', 'The background image file name')
params.addParam('comments', 'Additional slide comments')
params.addParam('show_in_contents', True, 'Toggle if the slide appears in the table-of-contents')
params.addParam('prefix', 'Raw markdown to insert before slide content')
params.addParam('suffix', 'Raw markdown to insert after slide content')
params.addParam('auto_title', True, 'Enable/disable automatic addition of (cont.) for slides without a title.')
params.addParamsToGroup('properties', ['class', 'background-image'])
params.addPrivateParam('title', False)
return params
def validParams():
params = MooseObject.validParams()
params.addParam('class', 'The class property for RemarkJS CSS content')
params.addParam('background-image', 'The background image file name')
params.addParam('comments', 'Additional slide comments')
params.addParam('show_in_contents', True, 'Toggle if the slide appears in the table-of-contents')
params.addParam('prefix', 'Raw markdown to insert before slide content')
params.addParam('suffix', 'Raw markdown to insert after slide content')
params.addParam('auto_title', True, 'Enable/disable automatic addition of (cont.) for slides without a title.')
params.addParamsToGroup('properties', ['class', 'background-image'])
params.addPrivateParam('title', False)
return params
def validParams():
params = MooseObject.validParams()
params.addRequiredParam('type', 'The type of slide set to create')
params.addParam('title', 'The title of the slide set, if this exists a title slide will be injected')
params.addParam('slides', 'A list of slide ids to output, if blank all slides are output')
params.addParam('contents', 'Include table of contents slide')
params.addParam('contents_level', 1, 'The heading level to include in the contents')
params.addParam('show_in_contents', True, 'Toggle if the slide set content appears in the table-of-contents')
# Create the common parameters from RemarkSlide 'properties' group
slide_params = RemarkSlide.validParams()
for key in slide_params.groupKeys('properties'):
params.addParam(key, slide_params.getDescription(key))
params.addParamsToGroup('properties', slide_params.groupKeys('properties'))
return params
def validParams():
params = MooseObject.validParams()
params.addParam('caption', 'The image caption')
params.addParam('show_caption', True, 'Toggle the visibility of the caption')
params.addParam('name', 'The image file name')
params.addParam('url', 'The image file url')
params.addParam('download', 'Download the image locally')
params.addParam('align', 'The image horizontal alignment')
params.addParam('width', 'The image width')
params.addParam('height', 'The image height')
params.addParam('style', 'The img style property')
params.addParam('vertical-align', 'The vertical alignment of the image')
params.addParamsToGroup('html', ['align', 'width', 'height', 'vertical-align', 'style'])
return params
def validParams():
params = MooseObject.validParams()
params.addParam('caption', 'The image caption')
params.addParam('show_caption', True, 'Toggle the visibility of the caption')
params.addParam('name', 'The image file name')
params.addParam('url', 'The image file url')
params.addParam('download', False, 'Download the image locally')
params.addParam('align', 'The image horizontal alignment')
params.addParam('width', 'The image width')
params.addParam('height', 'The image height')
params.addParam('style', 'The img style property')
params.addParam('vertical-align', 'The vertical alignment of the image')
params.addParamsToGroup('html', ['align', 'width', 'height', 'vertical-align', 'style'])
return params
def validParams():
params = MooseObject.validParams()
params.addParam('class', 'The class property for RemarkJS CSS content')
params.addParam('background-image', 'The background image file name')
params.addParam('comments', 'Additional slide comments')
params.addParam('show_in_contents', True, 'Toggle if the slide appears in the table-of-contents')
params.addParam('prefix', 'Raw markdown to insert before slide content')
params.addParam('suffix', 'Raw markdown to insert after slide content')
params.addParam('auto_title', True, 'Enable/disable automatic addition of (cont.) for slides without a title.')
params.addParam('slides', 'A list of slides to include')
params.addParam('auto_insert_github_code', True, 'When true links to GitHub code is automatically inserted')
params.addParam('insert_github_code_link', 'top', 'When auto linking code place the link at with the code (top | bottom | none)')
params.addParamsToGroup('properties', ['class', 'background-image'])
params.addPrivateParam('title', False)
return params
def validParams():
params = MooseObject.validParams()
params.addParam('caption', 'The image caption')
params.addParam('show_caption', True, 'Toggle the visibility of the caption')
params.addParam('name', 'The image file name')
params.addParam('url', 'The image file url')
params.addParam('download', False, 'Download the image locally')
params.addPrivateParam('markdown') # The raw markdown source for this image
params.addParam('div-center', True, 'Wrap html figure in centered div')
params.addParam('align', 'The image horizontal alignment')
params.addParam('width', 'The image width')
params.addParam('height', 'The image height')
params.addParam('style', 'The img style property')
params.addParam('vertical-align', 'The vertical alignment of the image')
params.addParam('text-align', 'Text alignment of image')
params.addParam('caption', 'The caption for the image')
params.addParamsToGroup('html', ['align', 'width', 'height', 'vertical-align', 'text-align'])
return params
def validParams():
params = MooseObject.validParams()
params.addRequiredParam('type', 'The type of slide set to create')
params.addParam('title', 'The title of the slide set, if this exists a title slide will be injected')
params.addParam('active', 'A list of ordered slide names to output, if blank all slides are output')
params.addParam('inactive', 'A list of slide names to exclude from output')
params.addParam('contents', False, 'Include table of contents slide')
params.addParam('contents_title', 'The table-of-contents heading for this slide set')
params.addParam('contents_level', 1, 'The heading level to include in the contents')
params.addParam('contents_items_per_slide', 11, 'The number of contents items to include on a page')
params.addParam('show_in_contents', True, 'Toggle if slide set content appears in the table-of-contents')
params.addParam('style', 'The CSS style sheet to utilize for this slide set')
params.addParam('non_ascii_warn', True, 'Produce warning if non-ascii characters are located')
# Create the common parameters from RemarkSlide 'properties' group
slide_params = RemarkSlide.validParams()
for key in slide_params.groupKeys('properties'):
params.addParam(key, slide_params.getDescription(key))
params.addParamsToGroup('properties', slide_params.groupKeys('properties'))
return params
def validParams():
params = MooseObject.validParams()
params.addRequiredParam('type', 'The type of slide set to create')
params.addParam(
'title',
'The title of the slide set, if this exists a title slide will be injected'
)
params.addParam(
'active', [],
'A list of ordered slide names to output, if blank all slides are output'
)
params.addParam('inactive', [],
'A list of slide names to exclude from output')
params.addParam('contents', False, 'Include table of contents slide')
params.addParam('contents_title',
'The table-of-contents heading for this slide set')
params.addParam('contents_level', 1,
'The heading level to include in the contents')
params.addParam('contents_items_per_slide', 15,
'The number of contents items to include on a page')
params.addParam(
'show_in_contents', True,
'Toggle if slide set content appears in the table-of-contents')
params.addParam('style',
'The CSS style sheet to utilize for this slide set')
params.addParam('non_ascii_warn', True,
'Produce warning if non-ascii characters are located')
# Create the common parameters from RemarkSlide 'properties' group
slide_params = RemarkSlide.validParams()
for key in slide_params.groupKeys('properties'):
params.addParam(key, slide_params.getDescription(key))
params.addParamsToGroup('properties',
slide_params.groupKeys('properties'))
return params
