Wiki source code of Release Notes
Last modified by superadmin on 2026/10/14 18:25
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | The [[Release Notes Application>>doc:extensions:Extension.Release Notes Application.WebHome]] is mostly wiki pages: a handful of XClasses, five wiki macros and one page per rendering layout. {{version since="2.7" product="Release Notes Application"}}Under them sits a Component module holding the change search and the creation of release notes and changes, reachable from Java, from a script and over HTTP.{{/version}} | ||
| 2 | |||
| 3 | That makes each of its parts replaceable from the wiki itself. [[Release Note Structure>>doc:documentation.extensions.dev.release-notes.release-note-structure.WebHome]] describes the pages and xobjects everything else works on. The [[getChanges>>doc:documentation.extensions.dev.release-notes.getchanges-macro.WebHome]] and [[displayChanges>>doc:documentation.extensions.dev.release-notes.displaychanges-macro.WebHome]] macros query and render changes, so you can build views of your own, while [[releasenotechanges>>doc:documentation.extensions.dev.release-notes.releasenotechanges-macro.WebHome]], [[releasenotecontributors>>doc:documentation.extensions.dev.release-notes.releasenotecontributors-macro.WebHome]] and [[html5video>>doc:documentation.extensions.dev.release-notes.html5video-macro.WebHome]] are what a release note itself is made of. [[Create a Release Note Template>>doc:documentation.extensions.dev.release-notes.create-template.WebHome]] changes what a new release note starts from, and [[Create a Change Displayer>>doc:documentation.extensions.dev.release-notes.create-change-displayer.WebHome]] adds a layout of your own. | ||
| 4 | |||
| 5 | Creating release notes and changes is scriptable as well as clickable. The [[REST API>>doc:documentation.extensions.dev.release-notes.rest-api.WebHome]] does it from outside the wiki, for a release script or an agent; the [[Script Service>>doc:documentation.extensions.dev.release-notes.script-service.WebHome]] does it from a wiki page; and the [[Java API>>doc:documentation.extensions.dev.release-notes.java-api.WebHome]] does it from an extension of your own. All three go through the same components, so a note or a change created through one is indistinguishable from one created through another, or by hand. |
