Changes for page Release Notes Application

Last modified by Vincent Massol on 2024/03/25 00:11

<
From version < 8.2 >
edited by Vincent Massol
on 2016/09/30 22:16
To version < 9.1 >
edited by Vincent Massol
on 2016/09/30 22:35
>
Change comment: There is no comment for this version

Summary

Details

ExtensionCode.ExtensionClass[0]
Description
... ... @@ -1,1 +1,69 @@
1 -Manages Release Notes for software products (creation, reports)
1 +== Accessing the application ==
2 +
3 +The Application can be accessed from the Application Index or from the Applications Panel.
4 +
5 +== Home Page ==
6 +
7 +From the home page of the application, you can:
8 +* see existing release notes
9 +* create a new release notes
10 +* generate custom reports
11 +
12 +{{image reference="homepage.png"/}}
13 +
14 +Example of a generated Release Note:
15 +
16 +{{image reference="releasenotes-example.png"/}}
17 +
18 +In addition the release notes application is [[installed on xwiki.org>>xwiki:ReleaseNotes.WebHome]].
19 +
20 +== Adding Changes ==
21 +
22 +Right now you need to navigate to ##ReleaseNotes.Data.WebHome##. In the future you'll be able to add changes directly from the Release Note pages.
23 +
24 +{{image reference="change-home.png"/}}
25 +
26 +Example of viewing a given change:
27 +
28 +{{image reference="change.png"/}}
29 +
30 +== Custom Reports ==
31 +
32 +The application home page (and the Changes home page) offer the ability for users to generate their own custom Release Note change report.
33 +
34 +{{image reference="report.png"/}}
35 +
36 +The form allows to choose the displayer to use. Currently we provide the following displayers:
37 +* Grid Displayer(((
38 +{{image reference="displayer-grid.png"/}}
39 +)))
40 +* Flow Displayer(((
41 +{{image reference="displayer-flow.png"/}}
42 +)))
43 +* Simple Displayer(((
44 +{{image reference="displayer-simple.png"/}}
45 +)))
46 +* List Displayer(((
47 +{{image reference="displayer-list.png"/}}
48 +)))
49 +
50 +== Macros ==
51 +
52 +The following macros are made available:
53 +* {{code}}{{changes products="..." versions="..." audience="..." importance="..." displayer="..." categories="..." containsScreenshots="true|false" columns="..." displayEditLink="true|false"/}}{{/code}}
54 +* {{code}}{{releasenotechanges/}}{{/code}}
55 +
56 +== Configuration ==
57 +
58 +When adding a new release notes, the template used is the one defined in the ##ReleaseNotes.Code.ReleaseNotesConfig## page's xobject which allows to configure:
59 +* the default product name (used on the home page to pre-fill the form to add a new release note)
60 +* the reference to the template to use.
61 +
62 +{{image reference="config.png"/}}
63 +
64 +== Creating a template ==
65 +
66 +When creating a release notes template, two velocity bindings are available to the template content:
67 +* ##product##: the name of the product
68 +* ##version##: the short version
69 +
Show installed count
... ... @@ -1,0 +1,1 @@
1 +Yes

Get Connected