Skip to content

FlorianFehring/SWACdoc

Repository files navigation

Smart WebApplication Components Documentation

This repository contains the documentation of the SWAC. It's pages document the useage and give live working examples for each component.

Development of SWAC begun in 2020 at the HSBI and is maintained by the SolarComputingLab where its original purpose was to create a toolset to make development of new sciencetific data webpages easy and quick. Some documented components are not available in the opensource version, you can find in the SWAC repository. For more informations and access to non open source components contact: [email protected]

Setup

  1. Copy the files contained in this repository to the root level of your server toghether with the contents of the SWAC repository.
  2. Open your servers /SWACdoc directory in a browser

Enjoy the simplest webdevelopment!

Feel free to open tickets under issues in the SWAC repository if you find errors or wish new features.

Changelog

Version 05.12.2022

Fixed:

  • BindPoint:
    • BindPoint creation registers unneccessery eventListeners
    • Solved problem with empty bindpoints
  • Edit:
    • Example 7 code uses wrong datasource for definitions
  • View (all present components):
    • repeatedForAttr s are not created
    • Placeholder filled double times if there are more than one placeholder in one tag
    • More than one placeholder in attributes is not replaced
  • Documentation:
    • Wrong documentation on how to use language entries in templates
  • Wrong calcualted site root in some cases
  • ComponentHandler: Unneccessery options loading when component has error
  • ViewHandler: When id is missing on requestor there is no error message

Changed:

  • completeDefinitionsFromHTML() is now optional, and must be activated by option if wanted
  • Component: getDataDefinitionsForDatasource() no longer returns swac_* attributes
  • UIkit to version 3.15.14
  • Documentation
    • Updated sample component with default deactivated sample plugin

Added:

  • Present: TableSort plugin
  • Present: TableFilter plugin
  • WatchableSet: Automatic garbage collection of dead observers
  • Documentation
    • Documentation how to use components and language entries in plugins
    • Documentation page for Sample plugin
    • ExplainComponents: Support for example values in documentation
    • Support for example values in documentation
    • ExplainComponents: Automatic documentation for plugins
    • Plugins: Documentation for writign plugins extended with info about swac_repeatForPluginNav
    • Plugins: Documentation extendet with info about plugins html templates
  • License and developer documentation to components
  • ExplainComponent: Documenting license and developers
  • License and library information page
  • Sample: Javascript documentation
  • Support for subcomponents in plugins
  • Mediaplayer:
    • Headline to playlist
    • Mark active playing title
    • License info output
    • Updated templates
    • Updated translation
    • Possibility to link to title pages
    • Option to set a base path for media files
    • Display artists info
    • Hide control elements on print