24 Nov
2016
24 Nov
'16
2:23 p.m.
Hello,
I am new to xwiki (though like it a lot already...), I have installed the
release notes extension (1.3.1) but I have a problem with the
{{releasenotechanges}} macro. I may not use it properly, but I can't get my
changes appear in the release note page. I changed the default macro to use
the {{changes...}} macro instead, and it works better (but i need to
manually enter the product, version etc...) which is less convenient.
Once again I think I may not be using the extension correctly, but if
someone could point me to the documentation that could help me understand
how it works it would be much appreciated. (of course i have read this page
http://extensions.xwiki.org/xwiki/bin/view/Extension/Release+Notes+Applicat…
)
Also is there a way to change the default template of the RN to adapt it to
different context (for instance different languages)?
Regards,
Yann
25 Nov
25 Nov
9:59 a.m.
New subject: [xwiki-users] Extension Release notes 1.3.1 : releasenotechanges macro
Hi Yann,
On 24 Nov 2016, at 14:23, Yann
<yann.roques(a)gmail.com> wrote:
Hello,
I am new to xwiki (though like it a lot already...), I have installed the
release notes extension (1.3.1) but I have a problem with the
{{releasenotechanges}} macro. I may not use it properly, but I can't get my
changes appear in the release note page. I changed the default macro to use
the {{changes...}} macro instead, and it works better (but i need to
manually enter the product, version etc...) which is less convenient.
Yep that’s why I introduced that {{releasenotechanges}} indeed :)
Once again I think I may not be using the extension
correctly, but if
someone could point me to the documentation that could help me understand
how it works it would be much appreciated. (of course i have read this page
http://extensions.xwiki.org/xwiki/bin/view/Extension/Release+Notes+Applicat…
)
It’s probably not very clear but at
http://extensions.xwiki.org/xwiki/bin/view/Extension/Release+Notes+Applicat…
there’s an explanation about how to install a Demo application using the Release Notes
app.
Could you try installing it and see if it helps?
Also is there a way to change the default template of
the RN to adapt it to
different context (for instance different languages)?
Good point. I haven’t implemented support for multilanguage release notes. You could open
a jira at http://jira.xwiki.org/browse/RN (and provide a pull request if you know how to
do that :)).
The template can be configured (see
http://extensions.xwiki.org/xwiki/bin/view/Extension/Release+Notes+Applicat…)
but this won’t work to dynamically decide what template to use based on various
parameters.
ATM of you want to do this, you’ll need to modify a page:
ReleaseNotes.Code.HomeExistingReleaseNotes and modify the following lines:
#set ($configDoc = $xwiki.getDocument("${topSpace}.Code.ReleaseNotesConfig"))
#set ($defaultProduct = $configDoc.getValue('product'))
#set ($defaultTemplateReferenceString = $configDoc.getValue('template'))
If you compute the reference to the doc you wish to use as template in the variable
$defaultTemplateReferenceString the rest should work fine.
Thanks
-Vincent
Regards,
Yann
3:39 p.m.
New subject: [xwiki-users] Extension Release notes 1.3.1 : releasenotechanges macro
Hi Vincent,
Thanks a lot for your answer. I was able to install the demo (through
mvnrepository.com not through the extension manager but that was not a
problem) and it works fine.
The problem with my own RNs is that the {{releasenotechanges}} macro does
not detect the changes or can't make the link between the changes I created
and the release note, so I guess (I was convinced actually) that the macro
works fine but that I do something wrong.
In fact I don't understand what parameters the macro uses to link changes /
RN.
Playing with the demo Xwiki RNs, I was able to add changes that were
immediatly displayed on the corresponding RN, but I noticed something weird
when I displayed the object page for the RN and the changes : the version
parameter is not the same...
For the changes version = 8.3-rc-1
For the RN version = 8.3RC1
(I thought the link was made on the product + version parameters.)
If I configure the version parameter for the change to 8.3RC1, the change
won't show up in the RN (8.3RC1). If I revert back to 8.3-rc-1 it appears
again. I think I am pretty close to the solution just need to know the
right parameters for the link.
Regarding multilanguage support, I am going to open a jira as soon as I can.
For the last part I need to learn a little bit more about Xwiki but will
definetely try it when I feel more confortable.
Thanks again for your help,
Yann
On Fri, Nov 25, 2016 at 9:59 AM, Vincent Massol <vincent(a)massol.net> wrote:
Hi Yann,
On 24 Nov 2016, at 14:23, Yann
<yann.roques(a)gmail.com> wrote:
Hello,
I am new to xwiki (though like it a lot already...), I have installed the
release notes extension (1.3.1) but I have a problem with the
{{releasenotechanges}} macro. I may not use it properly, but I can't get
my
changes appear in the release note page. I
changed the default macro to
use
the {{changes...}} macro instead, and it works
better (but i need to
manually enter the product, version etc...) which is less convenient.
Yep that’s why I introduced that {{releasenotechanges}} indeed :)
Once again I think I may not be using the
extension correctly, but if
someone could point me to the documentation that could help me understand
how it works it would be much appreciated. (of course i have read this
page
Release+Notes+Application/
)
It’s probably not very clear but at http://extensions.xwiki.org/
xwiki/bin/view/Extension/Release+Notes+Application/#
HPrerequisites26InstallationInstructions there’s an explanation about how
to install a Demo application using the Release Notes app.
Could you try installing it and see if it helps?
Also is there a way to change the default
template of the RN to adapt it
to
different context (for instance different
languages)?
Good point. I haven’t implemented support for multilanguage release notes.
You could open a jira at http://jira.xwiki.org/browse/RN (and provide a
pull request if you know how to do that :)).
The template can be configured (see http://extensions.xwiki.org/
xwiki/bin/view/Extension/Release+Notes+Application/#HConfiguration) but
this won’t work to dynamically decide what template to use based on various
parameters.
ATM of you want to do this, you’ll need to modify a page:
ReleaseNotes.Code.HomeExistingReleaseNotes and modify the following lines:
#set ($configDoc = $xwiki.getDocument("${topSpace}.Code.
ReleaseNotesConfig"))
#set ($defaultProduct = $configDoc.getValue('product'))
#set ($defaultTemplateReferenceString = $configDoc.getValue('template'))
If you compute the reference to the doc you wish to use as template in the
variable $defaultTemplateReferenceString the rest should work fine.
Thanks
-Vincent
Regards,
Yann
6 Dec
6 Dec
1:55 p.m.
New subject: [xwiki-users] Extension Release notes 1.3.1 : releasenotechanges macro
Hello Vincent,
Here is a quick update to inform you that I was able to make the RN
extension work the way I wished.
What I did :
- modified the ReleaseNotes.Code.ReleaseNotesChangesMacro :
{{changes displayer="simple" displayEditLink="true"
products="$product"
versions="$versionsParameter" audience="user"
containsScreenshots="true"/}}
instead of ->
{{changes displayer="simple" displayEditLink="true"
products="XWiki"
versions="$versionsParameter" audience="user"
containsScreenshots="true"/}}
and I also translated everything I needed inside the macro.
Now I can manage different products within the app and everything works
fine. Maybe I was doing a few things wrong, but your email and the demo app
helped me understand the logic behind the extension after a few try.
Thanks again for your help,
Yann
On Fri, Nov 25, 2016 at 3:39 PM, Yann <yann.roques(a)gmail.com> wrote:
Hi Vincent,
Thanks a lot for your answer. I was able to install the demo (through
mvnrepository.com not through the extension manager but that was not a
problem) and it works fine.
The problem with my own RNs is that the {{releasenotechanges}} macro does
not detect the changes or can't make the link between the changes I created
and the release note, so I guess (I was convinced actually) that the macro
works fine but that I do something wrong.
In fact I don't understand what parameters the macro uses to link changes
/ RN.
Playing with the demo Xwiki RNs, I was able to add changes that were
immediatly displayed on the corresponding RN, but I noticed something weird
when I displayed the object page for the RN and the changes : the version
parameter is not the same...
For the changes version = 8.3-rc-1
For the RN version = 8.3RC1
(I thought the link was made on the product + version parameters.)
If I configure the version parameter for the change to 8.3RC1, the change
won't show up in the RN (8.3RC1). If I revert back to 8.3-rc-1 it appears
again. I think I am pretty close to the solution just need to know the
right parameters for the link.
Regarding multilanguage support, I am going to open a jira as soon as I
can.
For the last part I need to learn a little bit more about Xwiki but will
definetely try it when I feel more confortable.
Thanks again for your help,
Yann
On Fri, Nov 25, 2016 at 9:59 AM, Vincent Massol <vincent(a)massol.net>
wrote:
Hi Yann,
On 24 Nov 2016, at 14:23, Yann
<yann.roques(a)gmail.com> wrote:
Hello,
I am new to xwiki (though like it a lot already...), I have installed
the
release notes extension (1.3.1) but I have a
problem with the
{{releasenotechanges}} macro. I may not use it properly, but I can't
get my
changes appear in the release note page. I
changed the default macro to
use
the {{changes...}} macro instead, and it works
better (but i need to
manually enter the product, version etc...) which is less convenient.
Yep that’s why I introduced that {{releasenotechanges}} indeed :)
Once again I think I may not be using the
extension correctly, but if
someone could point me to the documentation that could help me
understand
how it works it would be much appreciated. (of
course i have read this
page
+Notes+Application/
)
It’s probably not very clear but at http://extensions.xwiki.org/xw
iki/bin/view/Extension/Release+Notes+Application/#HPrerequis
ites26InstallationInstructions there’s an explanation about how to
install a Demo application using the Release Notes app.
Could you try installing it and see if it helps?
Also is there a way to change the default
template of the RN to adapt
it to
different context (for instance different
languages)?
Good point. I haven’t implemented support for multilanguage release
notes. You could open a jira at http://jira.xwiki.org/browse/RN (and
provide a pull request if you know how to do that :)).
The template can be configured (see http://extensions.xwiki.org/xw
iki/bin/view/Extension/Release+Notes+Application/#HConfiguration) but
this won’t work to dynamically decide what template to use based on various
parameters.
ATM of you want to do this, you’ll need to modify a page:
ReleaseNotes.Code.HomeExistingReleaseNotes and modify the following
lines:
#set ($configDoc = $xwiki.getDocument("${topSpace
}.Code.ReleaseNotesConfig"))
#set ($defaultProduct = $configDoc.getValue('product'))
#set ($defaultTemplateReferenceString = $configDoc.getValue('template'))
If you compute the reference to the doc you wish to use as template in
the variable $defaultTemplateReferenceString the rest should work fine.
Thanks
-Vincent
Regards,
Yann
7 Dec
7 Dec
6:24 p.m.
New subject: [xwiki-users] Extension Release notes 1.3.1 : releasenotechanges macro
Hi Yann,
Thanks for this update. I've raised and fixed
http://jira.xwiki.org/browse/RN-26. I've also released version 1.3.2!
Feel free to report issues or ideas by creating jira issues.
Thanks
-Vincent
--
View this message in context:
http://xwiki.475771.n2.nabble.com/Extension-Release-notes-1-3-1-releasenote…
Sent from the XWiki- Users mailing list archive at Nabble.com.
2893
days inactive
2906
days old
4 comments
3 participants
participants (3)
-
Vincent Massol -
vmassol
-
Yann