!!! Version: 5.0 Sherlock (Release 2012-04-30)

d3web is an extensible Java API for running knowledge-based systems. The Semantic Wiki KnowWE builds on the engine d3web and offers the web-based and distributed development of knowledge bases.

This distribution comes with the following files:

| Release Notes.pdf       | This document.
| Licenses.pdf            | License information of the d3web and KnowWE systems and all external libraries.\\Please find the license texts in the directory {{license_texts}}.
| d3web Quickstart.pdf    | A first steps installation readme for using the d3web libraries
| KnowWE Quickstart.pdf   | A first steps manual for installing and starting KnowWE
| ''d3web''               | Folder containing the binaries (libraries), the sources, and the JavaDoc information of d3web 
| ''KnowWE''              | Folder containing an installation archive (zip) as binary, the sources, and the JavaDoc information of KnowWE
| ''Quality Report''      | Folder containing all files of the quality assessment report for this release. It contains the test protocols of the system tests (based on Fitnesse and the manual system tests), a summary of the integration tests, and a detailed analysis of the unit tests and the static code analysis. 

!!! System Requirements
Installation of d3web/KnowWE requires the Java Platform, Standard Edition JDK 6 or higher. For operating systems, the distribution runs with MS-Windows XP, Windows 7 and Mac OS 10.6 or higher. Linux is not officially supported.
We officially support Firefox 7 or better and Google Chrome 14 or better. Please note, that we do not officially support Internet Explorer at the moment.


!!! What's New
The release includes the following notable features: 

!! d3web

* Solution are now usable in formulas.
* Improved choice support in formulas.
* Added default purge behavior for time database.
* Added known function for formulas.

!! KnowWE

* Added markups for test cases of various formats.
* Added player allowing to execute test cases and check their conditions.
* Terminology objects in formulas are now fully integrated (e.g. highlighting, renaming, case-warnings, ...)
* Markups provide help pages in menu.
* Added various documentation pages.
* Easier packaging for knowledge bases.
* Instant edit for tables and test cases.
* Trail/bread crumps cleaned up.
* Added new functions to todo plugin (e.g. closing and moving of finished todos).
* Significantly shortened KnowWE startup time.

!!! Fixed Issues

The IDs of the listed issues correspond to the ticket tracking system available at [https://tickets.denkbares.com].

||ID ||Product|| Short description || Resolution
| 21 | d3web | Unify the case of the XML tags used in the jared persistence files | WONTFIX
| 38 | d3web | [[TimeDB] Gradient calculation shows strong deviation for outlier values | WONTFIX
| 164 | d3web | Export textbundle property file with knowledge base | FIXED
| 203 | d3web | S42.NG Memory Leak | INVALID
| 230 | d3web | Java Heapspace exceeded | INVALID
| 311 | d3web | Define TimeDB purges for whole knowledge base | FIXED
| 312 | d3web | Evauate condtion also with "Yes" | FIXED
| 60 | KnowWE | Remove KnowWETestWikiConnector Hack | FIXED
| 132 | KnowWE | KnowWE / d3web session identifies the users by their IP adresses | FIXED
| 146 | KnowWE | [[Chrome] Arrows/guards layout issues in DiaFlux after reload | FIXED
| 222 | KnowWE | TestPersistence does not handle all  types of answers | FIXED
| 241 | KnowWE | resolved TODO issues shall be removed | FIXED
| 280 | KnowWE | [[ObjectInfoPage] Renaming in ObjectInfoPage needs a loader-gif. | FIXED
| 281 | KnowWE | [[Property] Allow to set a property for all answers with a given text at once | FIXED
| 289 | KnowWE | Refactoring of parameter names | DUPLICATE
| 291 | KnowWE | Mobile-Application: Can't load KBs from a folder | INVALID
| 294 | KnowWE | It is possible to download the knowledge base without any permissions (logged out) when using the right url | FIXED
| 295 | KnowWE | [[InstantEdit] InstantEdit can be activated, viewing an old version of an article | FIXED
| 298 | KnowWE | No case sensitive check for timeDB conditions. | FIXED
| 299 | KnowWE | Define CI Test to detect lazy DiaFlux models | FIXED
| 301 | KnowWE | [[DiaFlux] Flowcharts do not recognize questions not inserted in Questionnaire | FIXED
| 305 | KnowWE | rename snapshot | WONTFIX
| 313 | KnowWE | Rename works only once | FIXED
| 315 | KnowWE | Visual Trace of DiaFlux is not reseted with QuickI | FIXED
| 316 | KnowWE | Update problems of DiaFlux diagram | DUPLICATE
| 317 | KnowWE | Strange scrolling behaviour on short wiki pages | FIXED
| 318 | KnowWE | Solutions nodes are possibly wrong in diaflux | FIXED
| 320 | KnowWE | config.xml not updated correctly in knowledgebase.d3web | FIXED
| 321 | KnowWE | Trail of visited pages below the title is verbose and confusing | FIXED
| 322 | KnowWE | d3web knowledge bases without package compile | FIXED
| 323 | KnowWE | Start up of KnowWE much longer than necessary | FIXED
| 324 | KnowWE | SessionDebugStatus gets lost on page change | FIXED
| 325 | KnowWE | TableEdit: Column insertion before first column malicous | FIXED
| 327 | KnowWE | Most markups do not allow quotes in already quoted terms | FIXED
| 328 | KnowWE | [[DiaFlux] Moving the mouse over a DiaFlux model causes the rest of the page to drop a few pixels | FIXED
| 329 | KnowWE | Using "%" in an Annotation doesn't work | FIXED
| 330 | KnowWE | [[CI] Changing the name of a CI-Dashboard leads to exception while triggering onsave | FIXED
| 331 | KnowWE | Exception occurred during editing wiki page | WORKSFORME
| 333 | KnowWE | TestCasePlayer ignores identical TestCaseTable lines | FIXED
| 335 | KnowWE | [[CI] CIDaemon shows green if no dashboard is found for specified dashboard name | FIXED
| 336 | KnowWE | [[Tagging] Tags are not removed correctly if deleted | FIXED
| 337 | KnowWE | [[CI] CI4KE-Persistence does not release the save files after writing | FIXED
| 303 | Knowledge Base Book | OTS approval missing on release dvd | FIXED
| 306 | Knowledge Base Book | 2nd page shall be empty | FIXED
| 307 | Knowledge Base Book | File information shall not be contained in the footer. | FIXED


!!! Known Issues

The IDs of the listed issues correspond to the ticket tracking system available at [https://tickets.denkbares.com].

|| ID || Product || Severity || Title || Release Comment
| 104 | KnowWE | Average problem | Malicious HTML code in wiki pages/requests | For relevant KnowWE applications we recommend to secure the wiki server by htaccess controls and to provide user authentication.
| 117 | KnowWE | Lightweight problem | URIDecoding of request parameters is done twice: once by Tomcat and once in KnowWEParameterMap | For the currently deployed plugins this issue is resolved by workarounds. In further releases this problem should be fixed in a fundamental manner.
| 138 | KnowWE | trivial | [[Internet Explorer] Rendering output lacks a lot of line breaks | Currently we do not officially support the Internet Explorer in KnowWE.
| 212 | KnowWE | trivial | [[DiaFlux] Start and Exit nodes do not allow certain special characters | Workaround: Please try to avoid special characters for names of Start/Exit nodes  until the bugfix.
| 213 | KnowWE | trivial | [[Internet Explorer] DiaFlux edit panel does not work with IE9 | Currently we do not officially support the Internet Explorer in KnowWE.
| 223 | KnowWE | Lightweight problem | [[MobileApplication] Language Selection doesn't work | The mobile application is not part of the current distribution.
| 300 | KnowWE | minor | Arrows draw with false direction during edit | So far, we were not able to reproduce this error.
As a workaround, saving and reopening seems to fix this.
This bug only effects the rendering, but not the knowledge itself.

\\
\\
!!! Delivered Open-Source Projects

||Project Name || Contents || QA || State
| d3web-EmpiricalTesting | Validation of knowledge bases using test cases |  | release
| d3web-GlobalTests | A summarizing project for integration tests combining different projects and components, respectively. |   | release
| d3web-Kernel | Knowledge representation, basic problem-solvers, session management, default dialog control | X | release
| d3web-Persistence | XML knowledge base storage (archived as Jar) | X | release
| d3web-Plugin-BasicProperties | Definition of properties for terminology objects using the plugin.xml file | X | release
| d3web-Plugin-CostBenefit | Implementation of a dialog strategy (indication of questions) based on a cost-benefit principle. |   | release
| d3web-Plugin-DiaFlux | Reasoning problem-solver for the DiaFlux language. | X | release
| d3web-Plugin-Kernel-ExtensionPoints | The extension possibilities of the d3web kernel defined in the plugin.xml file. | X | release
| d3web-PluginManager | Manages plugins for d3web and KnowWE. | X | release
| d3web-Plugin-Persistence-Basic | see ''d3web-Persistence'' | X | release
| d3web-Plugin-Persistence-ExtensionPoints | see ''d3web-Persistence'' | X | release
| d3web-Plugin-SessionPersistence-Basic | see ''d3web-SessionPersistence'' | X |release
| d3web-Plugin-SessionPersistence-ExtensionPoints | see ''d3web-SessionPersistence'' | X |release
| d3web-Plugin-XCL | The set-covering model reasoning engine implemented as problem-solver plugin for the d3web Kernel. |   | release
| d3web-SessionPersistence | IO components for loading and saving standard cases (i.e. sessions) |X | release
| d3web-TestCase | Components for executing test cases on a d3web knowledge base | X | release
| KnowWE-App | Framework app of KnowWE | X | release
| KnowWE-core | Basic engines for parsing and the management of wiki content | X | release
| KnowWE-GlobalTestUtils | Small set of classes for testing the KnowWE implementation |  | beta
| KnowWE-KDOMParseUtils | Utils for internal data structure of KnowWE |  | release
| KnowWE-Plugin-CI4KE | Plugin for implementing the continuous integration dashboard and engine of KnowWE |  | release
| KnowWE-Plugin-CITestModules-d3web | Continuous integration tests for d3web knowledge bases in KnowWE |  | beta
| KnowWE-Plugin-Core | Core plugins and handlers of KnowWE | X | release
| KnowWE-Plugin-d3web-basic | The fundamental components to integrate the d3web engine into KnowWE | X | release
| KnowWE-Plugin-d3web-MarkupSet | Standard markup components used by some KnowWE/d3web plugins | X | release
| KnowWE-Plugin-DiaFlux | Authoring plugin for KnowWE of the DiaFlux language | X | release
| KnowWE-Plugin-ExtensionPoints | All extension possibilities for plugging KnowWE | X | release
| KnowWE-Plugin-InstantEdit | Plugin to allow fast and easy editing of KnowWE articles |   | release
| KnowWE-Plugin-JSPWiki-Connector | The connector between the parent wiki engine JSPWiki and the extension KnowWE | X | release
| KnowWE-Plugin-KBRenderer | Plugin for easy rendering of the knowledge base content inside KnowWE articles |  | beta
| KnowWE-Plugin-QuickInterview | A plugin to quickly enter a problem-solving session | X | release
| KnowWE-Plugin-Tagging | Tagging plugin of KnowWE | X | release
| KnowWE-Plugin-TestCase | Markups for entering test cases in KnowWE | X | release
| KnowWE-Plugin-TestCases | Executing test cases in KnowWE | X | release
| KnowWE-Resources | Template files for the KnowWE server engine | X | release

__Legend:__

||Project Name | Corresponds to the name of the Maven project, i.e., the name of the source code project. For simplicity, plugin postfixes are omitted (e.g., *jpf-plugin)
||Contents | A further description of the contents of this module
||QA    | Under regulation of the project contract. All contracted projects are certainly subject of the quality management system. Non-contracted modules may be subject to changes in the proposed release plan.
||State | Quality assessment of the project:\\__no__: Not officially included, experimental demo\\__alpha__: Basic functions included, API to be considered as "unstable" documentation partly available/not available mostly untested\\__beta__: All functions are included documentation available functionality tested on unit level\\__release__: All functions are included documentation available functionality tested on system level (integration tests) internal processes fully applied (issue management, development process)


!!! Resources and Links
* A wiki for developers: Start using the APIs of d3web and KnowWE:\\ [http://d3webwiki.informatik.uni-wuerzburg.de|http://d3webwiki.informatik.uni-wuerzburg.de]
* The official SourceForge website of d3web: \\[http://d3web.sourceforge.net|http://d3web.sourceforge.net]
* The official SourceForge website of KnowWE: \\[http://knowwe.sourceforge.net|http://knowwe.sourceforge.net]

%%Tags release_notes sherlock