Yseop template generator
Why
Yseop is a well-known NLG software vendor.
While RosaeNLG is a production grade NLG software, some users may prefer to switch to commercial software like Yseop for various reasons like:
-
Support
-
Consulting / Professionnal Services
-
Additionnal features
-
Friendly UI (called "Yseop Business Studio" at Yseop)
-
Additionnal languages (Spanish, Dutch, Japanese etc.)
RosaeNLG has the ability to generate Yseop templates. This feature should be used to migrate existing RosaeNLG templates to Yseop. This migration feature is aimed at users who started creating RosaeNLG templates and wish to switch their existing templates to Yseop.
Pug/RosaeNLG is based on Javascript while Yseop uses a proprietary language. The Javascript snippets in RosaeNLG will not be migrated automatically to Yseop YML language. |
Usage
First add yseop:true
as an option when using compileFile
.
To first debug and test, use also string:true
to generate a plain string containing all templates:
const rosaenlgPug = require('rosaenlg');
var yseopTemplates = rosaenlgPug.renderFile(`template.pug`, {yseop:true, string:true});
console.log(yseopTemplates);
To generate files (one per Yseop TextFunction), provide a path with the yseopPath
option:
const rosaenlgPug = require('rosaenlg');
const fs = require('fs');
rosaenlgPug.renderFile(`template.pug`, {
yseop:true,
yseopPath:'./output'
});
What is supported
RosaeNLG | Yseop |
---|---|
|
|
other html tags |
|
plain text (using ` |
`) |
plain text |
JavaScript inline code, single line or multi line (using |
commented code to be migrated in YML |
single line or multiple lines comments |
RosaeNLG | Yseop |
---|---|
|
|
standard Pug |
|
standard Pug |
|
|
|
|
|
|
|
mixin definition, with or without arguments |
|
mixin call, with or without arguments |
|
direct inclusion of pug files |
inline included code |
RosaeNLG | Yseop |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|