Swad for Dokiel

For who?⚓

SWAD is intended for Scenari modelers who adapt an open source editorial chain or design their own editorial and documentary solution with SCENARIbuilder.

For what?⚓

SWAD allows you to create presentation and/or documentation pages for Scenari editorial chains. These pages are then integrated as home pages in the desktop application or document model created with SCENARIbuilder.

  • To write the help site, displayed when opening a workspace in a web browser

    Example of Dokiel's help site - web editor

  • To create the home site of a desktop application or a server.

    The home site describes the key features and the licence of the application.
    Example of the home site of Dokiel's application

How does it work?⚓

The addon SWAD (for Scenari Workspace and Application Documentation) adds 4 types of items to Dokiel:

  • Application presentation publication: to build the application presentation sites.

  • Model presentation publication: to build the model presentation sites.

  • Application presentation section: to structure, write, or even reuse a fragment of content in application presentations.

  • Model presentation section: to structure, write, or even reuse a fragment of content in model presentations.

You formalize the information that your users need to know: license, authors, key operating points, etc. Then from the Publication item, after generation, you obtain websites that you will be able to use in SCENARIbuilder.

In SCENARIbuilder⚓

  • Create Website items and import the previously obtained website

  • Attach the help site obtained to the .packmake item.

  • If you also built a client application, attach to the .appMake item the help site.

The sites created with SWAD will be included during the next compilations of your applications.