[xwiki-devs] [Proposal] A new javascript service to get XWiki metadata
Hello. Some months ago, I created a topic about switching to HTML5 [1]. One of my concerns was that we currently use custom meta tags to store XWiki metadata, such as the current space, the current page, etc... [2]. These meta tags are not allowed anymore in HTML5 so we need to remove them. In this topic, you suggested some good ideas and I am making this proposal to recap them. 1/ Remove the invalid meta tags from the HTML, so it will pass our HTML validation tools. 2/ Put them back, dynamically, with JavaScript, on the client-side, to ensure retro-compatibility (and before any other script is started), because some extensions can rely on them. Also, they will be deprecated. 3/ Store the meta-data that we need in the <html> tag, via the data-* property that HTML5 allows. The prefix "xwiki" should be used to not collide with other extensions. For example: <html data-xwiki-space="the-current-space" data-xwiki-form-token="the-token" ...> 4/ Create a JS service that looks for this information and return them to other script. So if you change again the way we store the metadata, it won't break the extensions. This service should also be loaded before other scripts, and should be available to all scripts (which use jQuery, Prototype, or something else). For example: XWiki.getMetadata('space') (without the prefix) XWiki.getMetadata('form-token') Or it could be: XWiki.getSpace() XWiki.getFormToken() Actually I don't know how will be the implementation details yet, but I just would like to have your agreement on the principle. WDYT? Thanks, [1] http://markmail.org/message/4yhdlcxswbqdg3wv ([Proposal] Use HTML5 in Flamingo) [2] https://github.com/xwiki/xwiki-platform/blob/22ae6ec5b0ab3125486a0f55ab76ceb... (XWiki metadata) -- Guillaume Delhumeau ([email protected]) Research & Development Engineer at XWiki SAS Committer on the XWiki.org project
+1 Thanks, Marius On Wed, Oct 1, 2014 at 4:31 PM, Guillaume "Louis-Marie" Delhumeau <[email protected]> wrote:
Hello.
Some months ago, I created a topic about switching to HTML5 [1]. One of my concerns was that we currently use custom meta tags to store XWiki metadata, such as the current space, the current page, etc... [2]. These meta tags are not allowed anymore in HTML5 so we need to remove them.
In this topic, you suggested some good ideas and I am making this proposal to recap them.
1/ Remove the invalid meta tags from the HTML, so it will pass our HTML validation tools. 2/ Put them back, dynamically, with JavaScript, on the client-side, to ensure retro-compatibility (and before any other script is started), because some extensions can rely on them. Also, they will be deprecated. 3/ Store the meta-data that we need in the <html> tag, via the data-* property that HTML5 allows. The prefix "xwiki" should be used to not collide with other extensions.
For example: <html data-xwiki-space="the-current-space" data-xwiki-form-token="the-token" ...>
4/ Create a JS service that looks for this information and return them to other script. So if you change again the way we store the metadata, it won't break the extensions. This service should also be loaded before other scripts, and should be available to all scripts (which use jQuery, Prototype, or something else).
For example: XWiki.getMetadata('space') (without the prefix) XWiki.getMetadata('form-token')
Or it could be: XWiki.getSpace() XWiki.getFormToken()
Actually I don't know how will be the implementation details yet, but I just would like to have your agreement on the principle.
WDYT?
Thanks,
[1] http://markmail.org/message/4yhdlcxswbqdg3wv ([Proposal] Use HTML5 in Flamingo) [2] https://github.com/xwiki/xwiki-platform/blob/22ae6ec5b0ab3125486a0f55ab76ceb... (XWiki metadata)
-- Guillaume Delhumeau ([email protected]) Research & Development Engineer at XWiki SAS Committer on the XWiki.org project _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
+1 On Thu, Oct 2, 2014 at 10:50 AM, Marius Dumitru Florea <[email protected]> wrote:
+1
Thanks, Marius
On Wed, Oct 1, 2014 at 4:31 PM, Guillaume "Louis-Marie" Delhumeau <[email protected]> wrote:
Hello.
Some months ago, I created a topic about switching to HTML5 [1]. One of my concerns was that we currently use custom meta tags to store XWiki metadata, such as the current space, the current page, etc... [2]. These meta tags are not allowed anymore in HTML5 so we need to remove them.
In this topic, you suggested some good ideas and I am making this proposal to recap them.
1/ Remove the invalid meta tags from the HTML, so it will pass our HTML validation tools. 2/ Put them back, dynamically, with JavaScript, on the client-side, to ensure retro-compatibility (and before any other script is started), because some extensions can rely on them. Also, they will be deprecated. 3/ Store the meta-data that we need in the <html> tag, via the data-* property that HTML5 allows. The prefix "xwiki" should be used to not collide with other extensions.
For example: <html data-xwiki-space="the-current-space" data-xwiki-form-token="the-token" ...>
4/ Create a JS service that looks for this information and return them to other script. So if you change again the way we store the metadata, it won't break the extensions. This service should also be loaded before other scripts, and should be available to all scripts (which use jQuery, Prototype, or something else).
For example: XWiki.getMetadata('space') (without the prefix) XWiki.getMetadata('form-token')
Or it could be: XWiki.getSpace() XWiki.getFormToken()
Actually I don't know how will be the implementation details yet, but I just would like to have your agreement on the principle.
WDYT?
Thanks,
[1] http://markmail.org/message/4yhdlcxswbqdg3wv ([Proposal] Use HTML5 in Flamingo) [2] https://github.com/xwiki/xwiki-platform/blob/22ae6ec5b0ab3125486a0f55ab76ceb... (XWiki metadata)
-- Guillaume Delhumeau ([email protected]) Research & Development Engineer at XWiki SAS Committer on the XWiki.org project _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Thomas Mortagne
+1 How about: require(['xwiki.meta', function(xm) { console.log(xm['form-token']); }); ? On 10/02/2014 10:58 AM, Thomas Mortagne wrote:
+1
On Thu, Oct 2, 2014 at 10:50 AM, Marius Dumitru Florea <[email protected]> wrote:
+1
Thanks, Marius
On Wed, Oct 1, 2014 at 4:31 PM, Guillaume "Louis-Marie" Delhumeau <[email protected]> wrote:
Hello.
Some months ago, I created a topic about switching to HTML5 [1]. One of my concerns was that we currently use custom meta tags to store XWiki metadata, such as the current space, the current page, etc... [2]. These meta tags are not allowed anymore in HTML5 so we need to remove them.
In this topic, you suggested some good ideas and I am making this proposal to recap them.
1/ Remove the invalid meta tags from the HTML, so it will pass our HTML validation tools. 2/ Put them back, dynamically, with JavaScript, on the client-side, to ensure retro-compatibility (and before any other script is started), because some extensions can rely on them. Also, they will be deprecated. 3/ Store the meta-data that we need in the <html> tag, via the data-* property that HTML5 allows. The prefix "xwiki" should be used to not collide with other extensions.
For example: <html data-xwiki-space="the-current-space" data-xwiki-form-token="the-token" ...>
4/ Create a JS service that looks for this information and return them to other script. So if you change again the way we store the metadata, it won't break the extensions. This service should also be loaded before other scripts, and should be available to all scripts (which use jQuery, Prototype, or something else).
For example: XWiki.getMetadata('space') (without the prefix) XWiki.getMetadata('form-token')
Or it could be: XWiki.getSpace() XWiki.getFormToken()
Actually I don't know how will be the implementation details yet, but I just would like to have your agreement on the principle.
WDYT?
Thanks,
[1] http://markmail.org/message/4yhdlcxswbqdg3wv ([Proposal] Use HTML5 in Flamingo) [2] https://github.com/xwiki/xwiki-platform/blob/22ae6ec5b0ab3125486a0f55ab76ceb... (XWiki metadata)
-- Guillaume Delhumeau ([email protected]) Research & Development Engineer at XWiki SAS Committer on the XWiki.org project _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
Results: We have 3 "+1" (+ my own vote = 4). We have no "-1". The vote is passed. Thanks. 2014-10-02 11:03 GMT+02:00 Caleb James DeLisle <[email protected]>:
+1
How about:
require(['xwiki.meta', function(xm) { console.log(xm['form-token']); });
?
On 10/02/2014 10:58 AM, Thomas Mortagne wrote:
+1
On Thu, Oct 2, 2014 at 10:50 AM, Marius Dumitru Florea <[email protected]> wrote:
+1
Thanks, Marius
On Wed, Oct 1, 2014 at 4:31 PM, Guillaume "Louis-Marie" Delhumeau <[email protected]> wrote:
Hello.
Some months ago, I created a topic about switching to HTML5 [1]. One of my concerns was that we currently use custom meta tags to store XWiki metadata, such as the current space, the current page, etc... [2]. These meta tags are not allowed anymore in HTML5 so we need to remove them.
In this topic, you suggested some good ideas and I am making this proposal to recap them.
1/ Remove the invalid meta tags from the HTML, so it will pass our HTML validation tools. 2/ Put them back, dynamically, with JavaScript, on the client-side, to ensure retro-compatibility (and before any other script is started), because some extensions can rely on them. Also, they will be deprecated. 3/ Store the meta-data that we need in the <html> tag, via the data-* property that HTML5 allows. The prefix "xwiki" should be used to not collide with other extensions.
For example: <html data-xwiki-space="the-current-space" data-xwiki-form-token="the-token" ...>
4/ Create a JS service that looks for this information and return them to other script. So if you change again the way we store the metadata, it won't break the extensions. This service should also be loaded before other scripts, and should be available to all scripts (which use jQuery, Prototype, or something else).
For example: XWiki.getMetadata('space') (without the prefix) XWiki.getMetadata('form-token')
Or it could be: XWiki.getSpace() XWiki.getFormToken()
Actually I don't know how will be the implementation details yet, but I just would like to have your agreement on the principle.
WDYT?
Thanks,
[1] http://markmail.org/message/4yhdlcxswbqdg3wv ([Proposal] Use HTML5 in Flamingo) [2]
https://github.com/xwiki/xwiki-platform/blob/22ae6ec5b0ab3125486a0f55ab76ceb...
(XWiki metadata)
-- Guillaume Delhumeau ([email protected]) Research & Development Engineer at XWiki SAS Committer on the XWiki.org project _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Guillaume Delhumeau ([email protected]) Research & Development Engineer at XWiki SAS Committer on the XWiki.org project
Actually it was a proposal, not a vote. But since nobody have answered "-1", I start the implementation. If you disagree, please answer here quickly ;) Guillaume 2014-10-07 10:59 GMT+02:00 Guillaume "Louis-Marie" Delhumeau < [email protected]>:
Results: We have 3 "+1" (+ my own vote = 4). We have no "-1".
The vote is passed.
Thanks.
2014-10-02 11:03 GMT+02:00 Caleb James DeLisle <[email protected]>:
+1
How about:
require(['xwiki.meta', function(xm) { console.log(xm['form-token']); });
?
On 10/02/2014 10:58 AM, Thomas Mortagne wrote:
+1
On Thu, Oct 2, 2014 at 10:50 AM, Marius Dumitru Florea <[email protected]> wrote:
+1
Thanks, Marius
On Wed, Oct 1, 2014 at 4:31 PM, Guillaume "Louis-Marie" Delhumeau <[email protected]> wrote:
Hello.
Some months ago, I created a topic about switching to HTML5 [1]. One of my concerns was that we currently use custom meta tags to store XWiki metadata, such as the current space, the current page, etc... [2]. These meta tags are not allowed anymore in HTML5 so we need to remove them.
In this topic, you suggested some good ideas and I am making this proposal to recap them.
1/ Remove the invalid meta tags from the HTML, so it will pass our HTML validation tools. 2/ Put them back, dynamically, with JavaScript, on the client-side, to ensure retro-compatibility (and before any other script is started), because some extensions can rely on them. Also, they will be deprecated. 3/ Store the meta-data that we need in the <html> tag, via the data-* property that HTML5 allows. The prefix "xwiki" should be used to not collide with other extensions.
For example: <html data-xwiki-space="the-current-space" data-xwiki-form-token="the-token" ...>
4/ Create a JS service that looks for this information and return them to other script. So if you change again the way we store the metadata, it won't break the extensions. This service should also be loaded before other scripts, and should be available to all scripts (which use jQuery, Prototype, or something else).
For example: XWiki.getMetadata('space') (without the prefix) XWiki.getMetadata('form-token')
Or it could be: XWiki.getSpace() XWiki.getFormToken()
Actually I don't know how will be the implementation details yet, but I just would like to have your agreement on the principle.
WDYT?
Thanks,
[1] http://markmail.org/message/4yhdlcxswbqdg3wv ([Proposal] Use HTML5 in Flamingo) [2]
https://github.com/xwiki/xwiki-platform/blob/22ae6ec5b0ab3125486a0f55ab76ceb...
(XWiki metadata)
-- Guillaume Delhumeau ([email protected]) Research & Development Engineer at XWiki SAS Committer on the XWiki.org project _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Guillaume Delhumeau ([email protected]) Research & Development Engineer at XWiki SAS Committer on the XWiki.org project
-- Guillaume Delhumeau ([email protected]) Research & Development Engineer at XWiki SAS Committer on the XWiki.org project
Hi Guillaume, What about XWiki.currentWiki/Space/page values and even XWiki.currentDocument? You plan to replace the with your JS service? AFAIK extensions already use these values from the DOM and I don`t see why we should change that. Maybe I did not understand well your intent. Thanks, Eduard On Tue, Oct 7, 2014 at 12:00 PM, Guillaume "Louis-Marie" Delhumeau < [email protected]> wrote:
Actually it was a proposal, not a vote. But since nobody have answered "-1", I start the implementation. If you disagree, please answer here quickly ;)
Guillaume
2014-10-07 10:59 GMT+02:00 Guillaume "Louis-Marie" Delhumeau < [email protected]>:
Results: We have 3 "+1" (+ my own vote = 4). We have no "-1".
The vote is passed.
Thanks.
2014-10-02 11:03 GMT+02:00 Caleb James DeLisle <[email protected]>:
+1
How about:
require(['xwiki.meta', function(xm) { console.log(xm['form-token']); });
?
On 10/02/2014 10:58 AM, Thomas Mortagne wrote:
+1
On Thu, Oct 2, 2014 at 10:50 AM, Marius Dumitru Florea <[email protected]> wrote:
+1
Thanks, Marius
On Wed, Oct 1, 2014 at 4:31 PM, Guillaume "Louis-Marie" Delhumeau <[email protected]> wrote:
Hello.
Some months ago, I created a topic about switching to HTML5 [1]. One of my concerns was that we currently use custom meta tags to store XWiki metadata, such as the current space, the current page, etc... [2]. These meta tags are not allowed anymore in HTML5 so we need to remove them.
In this topic, you suggested some good ideas and I am making this proposal to recap them.
1/ Remove the invalid meta tags from the HTML, so it will pass our HTML validation tools. 2/ Put them back, dynamically, with JavaScript, on the client-side, to ensure retro-compatibility (and before any other script is started), because some extensions can rely on them. Also, they will be deprecated. 3/ Store the meta-data that we need in the <html> tag, via the data-* property that HTML5 allows. The prefix "xwiki" should be used to not collide with other extensions.
For example: <html data-xwiki-space="the-current-space" data-xwiki-form-token="the-token" ...>
4/ Create a JS service that looks for this information and return them to other script. So if you change again the way we store the metadata, it won't break the extensions. This service should also be loaded before other scripts, and should be available to all scripts (which use jQuery, Prototype, or something else).
For example: XWiki.getMetadata('space') (without the prefix) XWiki.getMetadata('form-token')
Or it could be: XWiki.getSpace() XWiki.getFormToken()
Actually I don't know how will be the implementation details yet, but I just would like to have your agreement on the principle.
WDYT?
Thanks,
[1] http://markmail.org/message/4yhdlcxswbqdg3wv ([Proposal] Use HTML5 in Flamingo) [2]
https://github.com/xwiki/xwiki-platform/blob/22ae6ec5b0ab3125486a0f55ab76ceb...
(XWiki metadata)
-- Guillaume Delhumeau ([email protected]) Research & Development Engineer at XWiki SAS Committer on the XWiki.org project _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Guillaume Delhumeau ([email protected]) Research & Development Engineer at XWiki SAS Committer on the XWiki.org project
-- Guillaume Delhumeau ([email protected]) Research & Development Engineer at XWiki SAS Committer on the XWiki.org project _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
Hi Eddy 2014-10-07 22:53 GMT+02:00 Eduard Moraru <[email protected]>:
Hi Guillaume,
What about XWiki.currentWiki/Space/page values and even XWiki.currentDocument? You plan to replace the with your JS service?
These values are directly set in the HTML of the page, which is not a good practice, according to Sergiu: http://markmail.org/message/ffriz3sfl2t3xwts I don't plan to remove them from: https://github.com/xwiki/xwiki-platform/blob/master/xwiki-platform-core/xwik... for retro-compatibility but we should add a comment to deprecated them. Actually, we could also add these variables manually in the XWiki object in compatibility.js if we want to clean this situation.
AFAIK extensions already use these values from the DOM and I don`t see why we should change that.
Maybe I did not understand well your intent.
Thanks, Eduard
Thanks, Guillaume
Update: This the final form that I am going to commit: an AMD module called "xwiki-meta" that you can use this way: require(['xwiki-meta'], function(xm) { xm['document']; xm['wiki']; xm['space']; xm['page']; xm['version']; xm['restURL']; xm['form_token']; } In consequence, javascript.vm will be modified this way: require.config({ paths: { // ... 'xwiki-meta': '$stringtool.removeEnd($xwiki.getSkinFile('js/xwiki/meta.js'), '.js')' // ... }, // ... }); If you have any objection, please answer before the release of 6.3 Milestone 2 (on monday). Thanks, Guillaume
On Tue, Oct 21, 2014 at 5:36 PM, Guillaume "Louis-Marie" Delhumeau <[email protected]> wrote:
Update:
This the final form that I am going to commit: an AMD module called "xwiki-meta" that you can use this way:
require(['xwiki-meta'], function(xm) {
xm['document'];
xm.document will work too.
xm['wiki']; xm['space']; xm['page']; xm['version']; xm['restURL']; xm['form_token']; }
In consequence, javascript.vm will be modified this way: require.config({ paths: { // ... 'xwiki-meta': '$stringtool.removeEnd($xwiki.getSkinFile('js/xwiki/meta.js'), '.js')' // ... }, // ... });
If you have any objection, please answer before the release of 6.3 Milestone 2 (on monday).
No objection. Thanks, Marius
Thanks, Guillaume _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
participants (5)
-
Caleb James DeLisle -
Eduard Moraru -
Guillaume "Louis-Marie" Delhumeau -
Marius Dumitru Florea -
Thomas Mortagne