Description Usage Arguments Details Value Information Classification Author(s) See Also Examples
Environment class ProcessingContext. Defines and eases processing context management.
1 | ProcessingContext(extraneous_l = list(), postProcessing_l = list())
|
extraneous_l |
An unconstrained named list. Each entry will be turned into a R documentation section. |
postProcessing_l |
An unconstrained named list. Each entry will trigger a post processing for the related R documentation section. |
If a post processing function returns NULL
, related section will be
removed from generated content. See examples below.
Post processing aims to put in action simple transformations, as changing
letter cases, or applying simple beautifying technics. See beautify
.
An object instance of class ProcessingContext
.
extraneous_l list
◆ postProcessing_l list
◆ self environment
verifyExtraneous
■ verifyPostProcessing
Class name compliance is TRUE
.
Class owns no function return type instrumentation.
Class owns no test case definitions.
STRATUM ▶ CORE
PHASING ▶ BUILD
INTENT ▶ CONTENT_GENERATION
Fabien Gelineau <neonira@gmail.com>
Maintainer: Fabien Gelineau <neonira@gmail.com>
Class InputContext
, class GenerationContext
and class ManualPageBuilder
.
1 2 3 4 5 6 7 8 9 10 11 12 13 | pc <- ProcessingContext(
extraneous_l = list(
'my section' = "a special dedicace to neonira",
keyword = 'documentation',
concept = 'documentation generation'
),
postProcessing_l = list(
'my section' = function(content_s) {
gsub('neonira', 'NEONIRA', content_s, fixed = TRUE)
},
author = function(content_s) { NULL } # destroy section
)
)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.