Project Docs Github
Log in
ittf site docs concepts t wizzimetaplugins introduction.html.ittf Edit
  • /ittf/site/docs/concepts/t/wizzimetaplugins/introduction.html.ittf
  • /ittf/site/docs/concepts/t/section.html.ittf
  • /ittf/site/docs/t/to-plugin.html.ittf
  • /ittf/site/docs/t/to-docs.html.ittf
  • /ittf/site/docs/t/high-code.html.ittf

/ittf/site/docs/concepts/t/wizzimetaplugins/introduction.html.ittf (primary)

edit
                                            
1 $group
2 $
3 var sect = {
4 title: 'Wizzi Plugins'
5 };
6 section( §)
7 p Wizzi is a generation framework
8 \b implemented by plugins.
9 p Kernel modules themself have a
10 \b pluggable architecture. The ${}
11 to-plugin( wizzi-mtree )
12 span ${} package is a plugin
13 \b that implements an api for building ${}
14 to-docs( tree structures )
15 span ${} from ${}
16 to-docs( ITTF documents)
17 span .
18 \b The ${}
19 to-plugin( wizzi-repo )
20 span ${} package is a plugin that implements
21 \b an api for locating and retrieving ITTF documents.
22 p A Wizzi Plugin exposes to the Wizzi factory the methods for retrieving its:
23 ul
24 li Wizzi Schema definitions
25 li Wizzi Models and their factories
26 li Wizzi Model transformers
27 li Artifact generators
28 p A plugin package must export the
29 high-code( createFactoryPlugin )
30 span method in its
31 high-code( index.js )
32 span file. The
33 high-code( FactoryPlugin )
34 span class instance returned to the caller
35 \b must implement the
36 high-code( wizzi-plugin.factoryPlugin )
37 span ${} API (see below).
38 ittf-panel
39 title ITTF pseudo-code implementation of the createFactoryPlugin method
40 ittf
41 set module.exports
42 {
43 ...
44 @ createFactoryPlugin
45 function
46 { wizziPackage
47 { options
48 [ items
49 string pluginNameOrFile
50 string pluginsBaseFolder
51 default process.cwd()
52 callback
53 ...
54 return
55 _ callback
56 @ null
57 { factoryPlugin
58 api-ref wizzi-plugin.factoryPlugin
59 p A Wizzi Plugin should have a standard folder structure so that
60 \b modules can be located given the short public name of
61 \b the required item.
62 ittf-panel
63 title Wizzi Plugin standard folder structure
64 ittf
65 ...
66 {package-name}
67 package.json
68 ...
69 lib
70 artifacts
71 {schema-name}
72 {artifact-name}
73 gen
74 main.js
75 ...
76 {transformer-name}
77 trans
78 main.js
79 ...
80 ...
81 utils
82 ...
83 wizzi
84 models
85 {schema-name}-model.g.js
86 {schema-name}-factory.g.js
87 {schema-name}-schema.g.json
88 ...
89 index.js

/ittf/site/docs/concepts/t/section.html.ittf

edit
                                            
1 $group
2 $params §
3 article
4 . doc-title
5 id ${sect.id}
6 + ${sect.title}
7 . doc-summary
8 $hook

/ittf/site/docs/t/to-plugin.html.ittf

edit
                                            
1 $group
2 $params name, kind|@@null
3 $
4 // var xname = kind != 'nospace' ? ' ' + name + ' ' : name
5 $if kind != 'nospace'
6 span ${} ${}
7 code
8 class highlight-code
9 a ${name}
10 href https://github.com/stfnbssl/wizzi.plugins/tree/main/packages/wizzi.plugin.${name}
11 target _blank
12 $if kind != 'nospace'
13 span ${} ${}

/ittf/site/docs/t/to-docs.html.ittf

edit
                                            
1 a
2 $params name
3 $if name.toLowerCase() === 'mtree' || name.toLowerCase() === 'mtrees'
4 a ${name}
5 href ${wzCtx.Params.baseUrl}/docs/mtrees.html
6 $elif name.toLowerCase() === 'ITTF Document' || name.toLowerCase() === 'ITTF Documents'
7 a ${name}
8 href ${wzCtx.Params.baseUrl}/docs/ittfdocuments.html
9 $elif name === 'Template engine'
10 a ${name}
11 href ${wzCtx.Params.baseUrl}/docs/templateengine.html
12 $elif name.toLowerCase() === 'jswizzi'
13 a ${name}
14 href ${wzCtx.Params.baseUrl}/docs/jswizzi.html
15 $elif name.toLowerCase() === 'wizzi model' || name.toLowerCase() === 'wizzi models'
16 a ${name}
17 href ${wzCtx.Params.baseUrl}/docs/wizzimodels.html
18 $elif name.toLowerCase() === 'wizzi schema' || name.toLowerCase() === 'wizzi schemas'
19 a ${name}
20 href ${wzCtx.Params.baseUrl}/docs/wizzischemas.html
21 $elif name.toLowerCase() === 'wizzi model dom' || name.toLowerCase() === 'wizzi model doms'
22 a ${name}
23 href ${wzCtx.Params.baseUrl}/docs/wizzimodeldoms.html
24 $elif name.toLowerCase() === 'model transformers'
25 a ${name}
26 href ${wzCtx.Params.baseUrl}/docs/modeltransformers.html
27 $elif name.toLowerCase() === 'artifact generations'
28 a ${name}
29 href ${wzCtx.Params.baseUrl}/docs/artifacts.html
30 $elif name.toLowerCase() === 'wizzi api' || name.toLowerCase() === 'wizzi.wizzifactory'
31 a ${name}
32 href ${wzCtx.Params.baseUrl}/docs/wizziapi.html
33 $else
34 h1 ERROR to-docs unknown ${name}

/ittf/site/docs/t/high-code.html.ittf

edit
                                            
1 $group
2 $params text, kind|@@null
3 $if kind != 'nospace'
4 span ${} ${}
5 code
6 class highlight-code
7 + ${text}
8 $if kind != 'nospace'
9 span ${} ${}
Save
Save & Refresh
Cancel