HELP COMPONEN SYSTEMWinCC OA @ CERN 2015

SUBJECTS - GENERATE HTML COMPONENT FILES

- FULL COMPONENTS FRAMEWORK HELP

- CENTRAL HELP REPOSITORY

- ACCESIBLE LOCALLY

- INCLUDE ALL CONSTANTS WEB PAGE

- INCLUDE WINCC OA CHM HELP

- POWERFULL SEARCH ENGINE

GENERATE HTML COMPONENT FILES

- FEATURES:

- Separate FORMAT FROM DATA- Include help from panels, libraries, defined constants, ...- Possibility to include pictures, media,...- Reduce as much as possible new mark languages- Automatic and easy tool to generate HTML files from code- Compatible Linux and Windows

- TWO APPROACHES

- Jekyll- ASCIIDOC

FULL COMPONENT FRAMEWORK HELP

- ALL FRAMEWORK COMPONENTS AVAILABLE FROM EACH HELP PAGE

SEARCH ENGINEOPTIONS

• Component A• Panels

• xxx• Libraries

• yyy• Constants

• zzz• Component B• Component C• Component D• Component E

GENERATED HTML PAGE

CENTRAL HELP REPOSITORY

IS REALLY NEEDED ????

- Display webpage will dynamically search for content to present- Performance issue?- Delays?

- One central help repository is distributed with each framework version.- How this will work with new component releases?

HELP ACCESS LOCALLY

- All used technologies to display help content should be use common technologies available on OS.

- If new technology is used should be distributed and installed with framework. - Maybe problems in production environment with machines

administrators

INCLUDE ALL CONSTANTS WEBPAGE

- Display webpage could show all defined constants in the framework in one page, with filtering options.

- This webpage could be created at:- Generation time, completely static- Runtime, dynamically by display webpage.

- Display webpage for constants will include a filter engine and will show constants in a table with following columns: COMPONENT, NAME, TYPE, VALUE and DESCRIPTION.

INCLUDE WINCC OA CHM HELP

- Un-compile WinCC OA .chm file to be included in the help system.

- Use display search engine to get the right place.

- Use classified pages to access content.

- Copyright issue ???

POWERFULL SEARCH ENGINE

- Usefulness of this help system could reside on:

- The way information is classified and presented.

- Search engine could:- Resolve / match properly.- Use wildcards.- Filter in which subject do you want to search.- Filter in which content: panels, functions, constants,

general help...- Delay between search command and result

presentation.

QUESTIONS ???