February 2011 - xwiki-devs@xwiki.org

[xwiki-devs] Visual way to display a document reference?
by Vincent Massol 17 Feb '11

17 Feb '11

Hi, We have several places where we need to display a document reference; for ex: - rename page - copy page etc One solution is to not display the reference and break it into discrete parts, for ex: Source wiki: <wiki name> Source space: <space name> Source page: <page name> However there are drawbacks: 1) it takes space 2) when we introduced nested spaces it's going to be even more complex to do so... I was wondering if instead we couldn't go another way which is to have a visual way to display a reference. Two ideas: http://tinycoke.com/_6rGYY9JXqpvD6/screen_shot_2011-02-10_at_12.29.24_pm.png WDYT? Any more ideas? Thanks -Vincent

7 14

[xwiki-devs] [Proposal] New module: xwiki-resources
by Vincent Massol 17 Feb '11

17 Feb '11

Hi devs, While designing the xwiki-action and xwiki-url modules I've realized that we need a general way to represent an xwiki resource and an action on that resource. This will allow every resource in XWiki to be addressable and offer a generic action mechanism. What is an xwiki resource? ===================== Examples: * an Entity (Document, XObject, XProperty, Attachment, etc) * A Page (i.e. an Entity rendered with a skin) * a resource file on the filesystem (image, css, js, icon, etc) * something on which a REST call will operate (which may or may not be an Entity) Note that a resource has a type, a reference and optional generic parameters. It's very much similar to a URI in the JDK but represented differently. What is an action done on a resource? ===================== Examples: * For an Entity: view it in XHTML (or in any other syntax) * For an Entity: view it with the skin applied, in XHTML (or in any other syntax) * Generate a URL for it * Create a link to it * For an Entity: Create it, modify it, delete it Where would it be used: ===================== Examples: * To transform any XWiki URL into a resource object. Any XWiki URL would be transformed internally into a resource. Note: The current XWikiURL class located in the xwiki-url module would disappear * In the Rendering to represent the reference of a link or an image. Ex: [[label>>reference]]. We currently have a ResourceReference class that would be removed and replaced by the new generic resource class. * More generically Resource and Resource Actions will be used at entry points of XWiki and internally XWiki will only manipulate Resources. String representation: ===================== <resource type>:<action>:<resource reference> Examples: ===================== * view a document with skin applied page:view:wiki:space1.space2.page <==> ViewAction * view a document entity:view:wiki:space1.space2.page params: context=new <==> No equiv or {{include document="wiki:space1.space2.page" context="new"/}} ex: link to attachment entity:link:wiki:[email protected] <==> [[attach:wiki:[email protected]]] ex: link to a document entity:link:wiki:space1.space2.page <==> [[doc:wiki:space1.space2.page]] ex: view icon icon:view:accept <==> image:icon:accept ex: view image stored in document entity:view:wiki:[email protected] <==> image:doc:wiki:[email protected] ex: view image located at external URL url:view:http://server/my.png <==> image:url:http://server/my.png API === * ResourceReference * ResourceAction (extends ResourceReference by adding an action field) * ResourceReferenceSerializer * ResourceReferenceResolver * ResourceExecutor(ResourceReference). Hint = <executor type>/<resource type>/<resource action> Example: View "entity:view:wiki:[email protected]" in XHTML Algorithm: - lookup ResourceExecutor (hint = "xhtml/entity/view") - cast ref = ResourceReference.getReference() to EntityReference - if ref.type == ATTACHMENT - get attachment URL => <img src="..../my.png"/> Example: Generate URL for "entity:view:wiki:[email protected]" Algorithm: - lookup ResourceExecutor (hint = "url/entity/view") - cast ref = ResourceReference.getReference() to EntityReference => http://wiki/xwiki/bin/view/space/page/my.png OR simply: ResourceExecutor(ResourceAction). Hint = <executor type> ex: "xhtml", "url", etc. And it's up to the executor to have sub components for the various actions, resource types.... Conclusion =========== The API is not completely finished and I'd need to explore it (ie start implementing it) to refine it. Right now I'd just like to discuss whether you see the idea as interesting and whether I should start spending some time working on it. I'll post refinements as I progress. Thanks -Vincent

2 5

[xwiki-devs] [Discussion] Dashboard default behaviour
by Anca Luca 17 Feb '11

17 Feb '11

Hi devs, I committed XWIKI-5938 but I think we should discuss the default source of the dashboard macro, namely where does it pick the gadget objects to display on the dashboard, e.g. in the case of a dashboard macro call in an included document. It is very easy to add a "source" parameter to the dashboard macro, which would tell the dashboard where should it read the objects from (and render in the context of the current document), but now the question is what should {{dashboard /}} without parameters do? 1/ read the objects from the current document, which means, in the case of an include, it will depend on the context of the include. Note that, if an include is done in a new context, then all the gadgets on that dashboard will be also relative to the included document (e.g. if they use $doc, the $doc will be the included document, not the including doc). 2/ read the objects from the closest MetaData.SOURCE, which means the document from which the content that contains the {{dashboard /}} call comes from. E.g. in the case of an include, the included document. WDYT? There are a lot of possible situations to discuss, I will just present a few usecases below, to be taken into account when analyzing: A. The current Main.Dashboard is included in all the WebHomes by default, but its gadgets refer to the current document (the _including_ document) B. Users want to be able to easily customize their WebHomes, without affecting other people (not change the wiki general dashboard, but only their space dashboard) C. There is a dashboard somewhere on the wiki, Main.CoolDashboard, and users want to be able to include that dashboard as a copy, without having to re-create the dashboard objects on their including page D. User dashboards: at one point we will want each user to have their own dashboard on their profile page, which is rendered by a sheet. Ideally we should have the same user sheet for all users. E. Also, the user dashboard should be include-able on the Main.WebHome of a logged in user (a "Home"). F. Since the include doesn't make too much sense for a dashboard document (since the dashboard document is only a call to a {{dashboard /}} macro), users will replace its usage with {{dashboard /}} macro calls, with a source parameter to pick gadget objects from another document ('reuse' a dashboard definition). If you can think of more cases that could involve include issues, please fill them in. Thanks, Anca

3 9

Re: [xwiki-devs] [xwiki-notifications] r34718 - platform/core/branches/xwiki-core-2.7/xwiki-core/src/main/java/com/xpn/xwiki/store
by Sergiu Dumitriu 16 Feb '11

16 Feb '11

On 02/16/2011 10:09 AM, tmortagne (SVN) wrote: > Author: tmortagne > Date: 2011-02-16 10:09:31 +0100 (Wed, 16 Feb 2011) > New Revision: 34718 > > Modified: > platform/core/branches/xwiki-core-2.7/xwiki-core/src/main/java/com/xpn/xwiki/store/XWikiHibernateBaseStore.java > platform/core/branches/xwiki-core-2.7/xwiki-core/src/main/java/com/xpn/xwiki/store/XWikiHibernateStore.java > Log: > XWIKI-5976: Cannot create subwiki named "lines" > Better (but a lot less elegant...) fix > > Modified: platform/core/branches/xwiki-core-2.7/xwiki-core/src/main/java/com/xpn/xwiki/store/XWikiHibernateBaseStore.java > =================================================================== > --- platform/core/branches/xwiki-core-2.7/xwiki-core/src/main/java/com/xpn/xwiki/store/XWikiHibernateBaseStore.java 2011-02-16 09:09:21 UTC (rev 34717) > +++ platform/core/branches/xwiki-core-2.7/xwiki-core/src/main/java/com/xpn/xwiki/store/XWikiHibernateBaseStore.java 2011-02-16 09:09:31 UTC (rev 34718) > @@ -504,7 +504,6 @@ > } > } catch (Exception e) { > } > - ; > try { > if (bTransaction) { > endTransaction(context, true); > @@ -600,13 +599,14 @@ > > if (context.getDatabase() != null) { > String schemaName = getSchemaFromWikiName(context); > + String escapedSchemaName = escapeSchema(schemaName, context); > > DatabaseProduct databaseProduct = getDatabaseProductName(context); > if (DatabaseProduct.ORACLE == databaseProduct) { > Statement stmt = null; > try { > stmt = session.connection().createStatement(); > - stmt.execute("alter session set current_schema = " + schemaName); > + stmt.execute("alter session set current_schema = " + escapedSchemaName); > } finally { > try { > if (stmt != null) { > @@ -620,7 +620,7 @@ > Statement stmt = null; > try { > stmt = session.connection().createStatement(); > - stmt.execute("SET SCHEMA " + schemaName); > + stmt.execute("SET SCHEMA " + escapedSchemaName); > } finally { > try { > if (stmt != null) { > @@ -648,6 +648,29 @@ > } > > /** > + * Escape schema name depending of the database engine. > + * > + * @param schema the schema name to escape > + * @param context the XWiki context to get database engine identifier > + * @return the escaped version > + */ > + protected String escapeSchema(String schema, XWikiContext context) > + { > + DatabaseProduct databaseProduct = getDatabaseProductName(context); > + > + String escapedSchema; You should use this instead: escapedSchema = dialect.openQuote() + schema + dialect.closeQuote(); I think nobody wants to use ` or " in the wiki name, so there shouldn't be a need for doubling them. BTW, SQLServer uses [ ] for quoting. > + if (DatabaseProduct.MYSQL == databaseProduct) { > + // MySQL does not use SQL92 escaping syntax by default > + escapedSchema = "`" + schema.replace("`", "``") + "`"; > + } else { > + // Use SQL92 escape syntax > + escapedSchema = "\"" + schema.replace("\"", "\"\"") + "\""; > + } > + > + return escapedSchema; > + } > + > + /** > * Begins a transaction > * > * @param context -- Sergiu Dumitriu http://purl.org/net/sergiu/

2 6

Re: [xwiki-devs] [xwiki-notifications] r34727 - in platform/web/trunk/standard/src/main/webapp/resources/uicomponents/widgets: . gallery
by Jerome Velociter 16 Feb '11

16 Feb '11

On Wed, Feb 16, 2011 at 12:12 PM, mflorea <platform-notifications(a)xwiki.org>wrote: > Author: mflorea > Date: 2011-02-16 12:12:34 +0100 (Wed, 16 Feb 2011) > New Revision: 34727 > > Added: > > platform/web/trunk/standard/src/main/webapp/resources/uicomponents/widgets/gallery/ > > platform/web/trunk/standard/src/main/webapp/resources/uicomponents/widgets/gallery/gallery.css > > platform/web/trunk/standard/src/main/webapp/resources/uicomponents/widgets/gallery/gallery.js > > platform/web/trunk/standard/src/main/webapp/resources/uicomponents/widgets/gallery/loading.gif > > platform/web/trunk/standard/src/main/webapp/resources/uicomponents/widgets/gallery/maximize.gif > > platform/web/trunk/standard/src/main/webapp/resources/uicomponents/widgets/gallery/minimize.gif > Log: > XWIKI-6010: Add a gallery macro to display images using a slide-show view > * Add resources to uicomponents/widgets/gallery > > > Added: > platform/web/trunk/standard/src/main/webapp/resources/uicomponents/widgets/gallery/gallery.css > =================================================================== > --- > platform/web/trunk/standard/src/main/webapp/resources/uicomponents/widgets/gallery/gallery.css > (rev 0) > +++ > platform/web/trunk/standard/src/main/webapp/resources/uicomponents/widgets/gallery/gallery.css > 2011-02-16 11:12:34 UTC (rev 34727) > @@ -0,0 +1,146 @@ > +#macro(ieOpacity $selector $value) > +/* start IE opacity setting */ > +$selector { > + /* We need to quote the property value because the equal sign is not > valid inside a CSS property value. */ > + -ms-filter: "progid:DXImageTransform.Microsoft.Alpha(Opacity=$value)"; > +} > + > +#foreach($item in $selector.split('\s*,\s*')) > +*+html $item, ## > +#end { > + /* This is for IE7, which doesn't accept the quoted value but > fortunately understands the escape syntax. */ > + filter: alpha(opacity\=$value); > + /* Unicode escape works too. */ > + /*filter: alpha(opacity\003d $value);*/ > +} > + > +#foreach($item in $selector.split('\s*,\s*')) > +* html $item, ## > +#end { > + /* This is for IE6, which doesn't understand the escaped equal sign (not > even the unicode escape) but fortunately accepts the quoted value. */ > + filter: "progid:DXImageTransform.Microsoft.Alpha(Opacity=$value)"; > +} > +/* end IE opacity setting */ > +#end > + > +#set($imageMaxWidth = 492) > +#set($imageMaxHeight = 369) > + > +.xGallery { > + background-color: black; > + padding: 10px; > + position: relative; > + width: ${mathtool.add($imageMaxWidth, 128)}px; > +} > + > +.xGallery.maximized { > + left: 0; > + position: absolute; > + top: 0; > + z-index: 1001; > +} > + > +.xGallery .currentImageWrapper { > + height: ${imageMaxHeight}px; > + line-height: ${imageMaxHeight}px; > + text-align: center; > + width: 100%; > +} > + > +.xGallery .currentImage { > + max-height: ${imageMaxHeight}px; > + max-width: ${imageMaxWidth}px; > + vertical-align: middle; > +} > + > +.xGallery .navigation { > + left: 0; > + margin-top: -64px; > + position: absolute; > + top: 50%; > + width: 100%; > +} > + > +.xGallery .previous, .xGallery .next { > + color: #A0A0A0; > + cursor: pointer; > + font-family: courier,monospace; > + font-size: 32px; > + font-weight: 100; > + height: 124px; > + line-height: 124px; > + text-align: center; > + width: 32px; > +} > + > +.xGallery .previous:hover, .xGallery .next:hover { > + color: white; > +} > + > +.xGallery .previous { > + float: left; > +} > + > +.xGallery .next { > + float: right; > +} > + > +.xGallery .index { > + bottom: 10px; > + color: #C0C0C0; > + font-family: sans-serif; > + font-size: smaller; > + left: 10px; > + position: absolute; > +} > + > +.xGallery .loading { > + background-image: url('loading.gif') !important; > +} > + > +.xGallery .focusCatcher { > + background-color: black; > + border: 0 none; > + color: black; > + height: 1px; > + left: 0; > + overflow: hidden; > + position: absolute; > + top: 0; > + width: 1px; > + z-index: -1; > +} > + > +.xGallery .maximize, .xGallery .minimize { > + cursor: pointer; > + height: 16px; > + opacity: .5; > + position: absolute; > + right: 10px; > + top: 10px; > + width: 16px; > +} > + > +.xGallery .maximize:hover, .xGallery .minimize:hover { > + opacity: 1; > +} > + > +#ieOpacity('.xGallery .maximize, .xGallery .minimize' 50) > + > +#ieOpacity('.xGallery .maximize:hover, .xGallery .minimize:hover' 100) > + > +.xGallery .maximize { > + background: transparent url('maximize.gif') no-repeat scroll center; > +} > + > +.xGallery .minimize { > + background: transparent url('minimize.gif') no-repeat scroll center; > +} > + > +html.maximized, html.maximized body { > + height: 100% !important; > + margin: 0 !important; > + overflow: hidden !important; > + padding: 0 !important; > + width: 100% !important; > +} > > > Property changes on: > platform/web/trunk/standard/src/main/webapp/resources/uicomponents/widgets/gallery/gallery.css > ___________________________________________________________________ > Added: svn:keywords > + Author Id Revision HeadURL > Added: svn:eol-style > + native > > Added: > platform/web/trunk/standard/src/main/webapp/resources/uicomponents/widgets/gallery/gallery.js > =================================================================== > --- > platform/web/trunk/standard/src/main/webapp/resources/uicomponents/widgets/gallery/gallery.js > (rev 0) > +++ > platform/web/trunk/standard/src/main/webapp/resources/uicomponents/widgets/gallery/gallery.js > 2011-02-16 11:12:34 UTC (rev 34727) > @@ -0,0 +1,139 @@ > +var XWiki = (function (XWiki) { > +// Start XWiki augmentation. > +XWiki.Gallery = Class.create({ > + initialize : function(container) { > + this.images = this._collectImages(container); > + > + this.container = container.update('<input type="text" tabindex="-1" > class="focusCatcher"/><div class="currentImageWrapper"><img > class="currentImage" alt="Current image"/></div><div class="navigation"><div > class="previous" title="Show previous image"><</div><div class="next" > title="Show next image">></div><div style="clear:both"></div></div><div > class="index">0 / 0</div><div class="maximize" title="Maximize"></div>'); > Titles will not be localized here + this.container.addClassName('xGallery'); > + > + this.focusCatcher = this.container.down('.focusCatcher'); > + this.focusCatcher.observe('keydown', > this._onKeyDown.bindAsEventListener(this)); > + this.container.observe('click', function() { > + this.focusCatcher.focus(); > + }.bind(this)); > + > + this.container.down('.previous').observe('click', > this._onPreviousImage.bind(this)); > + this.container.down('.next').observe('click', > this._onNextImage.bind(this)); > + > + this.currentImage = this.container.down('.currentImage'); > + this.currentImage.observe('load', this._onLoadImage.bind(this)); > + this.currentImage.observe('error', this._onErrorImage.bind(this)); > + this.currentImage.observe('abort', this._onAbortImage.bind(this)); > + > + this.indexDisplay = this.container.down('.index'); > + > + this.maximizeToggle = this.container.down('.maximize'); > + this.maximizeToggle.observe('click', > this._onToggleMaximize.bind(this)); > + > + this.show(0); > + }, > + _collectImages : function(container) { > + var images = []; > + var imageElements = container.getElementsByTagName('img'); > Why not use container.select('img') ? > + for(var i = 0; i < imageElements.length; i++) { > + var imageElement = imageElements[i]; > + images.push({url: imageElement.getAttribute('src'), title: > imageElement.title}); > + imageElement.removeAttribute('src'); > + } > + return images; > + }, > + _onPreviousImage : function() { > + this.show(this.index > 0 ? this.index - 1 : this.images.length - 1); > + }, > + _onNextImage : function() { > + this.show(this.index < this.images.length - 1 ? this.index + 1 : 0); > + }, > + _onLoadImage : function() { > + Element.removeClassName(this.currentImage.parentNode, 'loading'); > + this.currentImage.style.visibility = 'visible'; > + }, > + _onErrorImage: function() { > + }, > + _onAbortImage: function() { > + }, > + _onKeyDown : function(event) { > + var stop = true; > + switch(event.keyCode) { > + case Event.KEY_LEFT: > + this._onPreviousImage(); > + break; > + case Event.KEY_RIGHT: > + this._onNextImage(); > + break; > + case Event.KEY_HOME: > + this.show(0); > + break; > + case Event.KEY_END: > + this.show(this.images.length - 1); > + break; > + case Event.KEY_ESC: > + if (this.container.hasClassName('maximized')) { > + this._onToggleMaximize(); > + } > + break; > + case 70: /* F */ > + this._onToggleMaximize(); > + break; > + defualt: > + stop = false; > + break; > + } > + if (stop) { > + Event.stop(event); > + } > + }, > + _onToggleMaximize : function() { > + this.maximizeToggle.toggleClassName('maximize'); > + this.maximizeToggle.toggleClassName('minimize'); > + this.maximizeToggle.title = > this.maximizeToggle.hasClassName('maximize') ? 'Maximize' : 'Minimize'; > + this.container.toggleClassName('maximized'); > + $(document.documentElement).toggleClassName('maximized'); > + if (this.container.hasClassName('maximized')) { > + this._updateSize(); > + } else { > + this._resetSize(); > + } > + }, > + _updateSize : function() { > + var dimensions = document.viewport.getDimensions(); > + // Remove container padding; > + var width = dimensions.width - 20; > + var height = dimensions.height - 20; > + this.container.style.width = width + 'px'; > + this.container.style.height = height + 'px'; > + this.currentImage.parentNode.style.height = height + 'px'; > + this.currentImage.parentNode.style.lineHeight = height + 'px'; > I think as a best practice we should prefer prototype.js accessors versus. a mix of prototype helpers and native DOM properties. It's more consistent and more bug-proof in my opinion. I tend to always assume elements have been extended by prototype, but when the code mixes prototype.js and native accessors, you have greater chances to introduce non-extended elements as variables / members of your class that another developer will maybe miss. Here you would do this.currentImage.up().setStyle({ lineHeight: height + 'px' }) > + this.currentImage.style.maxHeight = height + 'px'; > + // Remove width reserved for the navigation arrows. > + this.currentImage.style.maxWidth = (width - 128) + 'px'; > + }, > + _resetSize : function() { > + this.container.style.cssText = ''; > + this.container.removeAttribute('style'); > + this.currentImage.parentNode.style.cssText = ''; > + this.currentImage.parentNode.removeAttribute('style'); > + this.currentImage.style.cssText = ''; > + this.currentImage.removeAttribute('style'); > + }, > + show : function(index) { > + if (index < 0 || index >= this.images.length || index == this.index) { > + return; > + } > + this.currentImage.style.visibility = 'hidden'; > + Element.addClassName(this.currentImage.parentNode, 'loading'); > + this.currentImage.title = this.images[index].title; > + this.currentImage.src = this.images[index].url; > + this.index = index; > + this.indexDisplay.firstChild.nodeValue = (index + 1) + ' / ' + > this.images.length; > Same for firstChild.nodeValue, I would prefer .down().update() > + } > +}); > +// End XWiki augmentation. > +return XWiki; > +}(XWiki || {})); > + > +Element.observe(document, "dom:loaded", function() { > + $$('.gallery').each(function(gallery) { > Same remark as for the dashboard macro, IMO this is too greedy and $mainContentArea.select('.gallery') would perform better. The problem is not really each such selector taken individually, but if we continue adding more and more, it will make the loading after DOM is loaded clumsy. Jerome. > + new XWiki.Gallery(gallery); > + }); > +}); > > > Property changes on: > platform/web/trunk/standard/src/main/webapp/resources/uicomponents/widgets/gallery/gallery.js > ___________________________________________________________________ > Added: svn:keywords > + Author Id Revision HeadURL > Added: svn:eol-style > + native > > Added: > platform/web/trunk/standard/src/main/webapp/resources/uicomponents/widgets/gallery/loading.gif > =================================================================== > (Binary files differ) > > > Property changes on: > platform/web/trunk/standard/src/main/webapp/resources/uicomponents/widgets/gallery/loading.gif > ___________________________________________________________________ > Added: svn:mime-type > + image/gif > > Added: > platform/web/trunk/standard/src/main/webapp/resources/uicomponents/widgets/gallery/maximize.gif > =================================================================== > (Binary files differ) > > > Property changes on: > platform/web/trunk/standard/src/main/webapp/resources/uicomponents/widgets/gallery/maximize.gif > ___________________________________________________________________ > Added: svn:mime-type > + image/gif > > Added: > platform/web/trunk/standard/src/main/webapp/resources/uicomponents/widgets/gallery/minimize.gif > =================================================================== > (Binary files differ) > > > Property changes on: > platform/web/trunk/standard/src/main/webapp/resources/uicomponents/widgets/gallery/minimize.gif > ___________________________________________________________________ > Added: svn:mime-type > + image/gif > > _______________________________________________ > notifications mailing list > notifications(a)xwiki.org > http://lists.xwiki.org/mailman/listinfo/notifications >

3 7

[xwiki-devs] [VOTE] Make Block navigation API a bit more generic
by Thomas Mortagne 16 Feb '11

16 Feb '11

Here is a proposal to reduce all get...Block to 2 methods which support matching any Block. interface Block { enum TraversalStrategy { /** Search in parents **/ PARENT, /** Search in children **/ CHILD, /** Search recursively in children (and children of children etc...) **/ CHILDRECURSE, /** Search in previous siblings **/ PREVIOUS, /** Search recursively in previous siblings (and parent previous sibling etc...) **/ PREVIOUSRECURSE, /** Search in next siblings**/ NEXT, /** Search recursively in next siblings (and children etc...)**/ NEXTRECURSE } [...] List<Block> getBlocks(BlockMatcher matcher, TraversalStrategy traversalStrategy, boolean recurse); Block getFirstBlock(BlockMatcher matcher, TraversalStrategy traversalStrategy, boolean recurse); } interface BlockMatcher { boolean match(Block block); } et on refactor tous les autres get*Block basé sur ceux la avec des BlockMatcher prédéfinis (ClassBlockMatcher, MetaDataBlockMatcher, etc...). Note: the main use case for this change is to support MetaData search. WDYT (especially on the vocabulary like "TraversalStrategy") ? -- Thomas Mortagne

6 11

Re: [xwiki-devs] [xwiki-notifications] r34685 - in platform: core/trunk/xwiki-core/src/main/resources core/trunk/xwiki-rendering/xwiki-rendering-macros/xwiki-rendering-macro-dashboard/src/main/java/org/xwiki/rendering/internal/macro/dashboard core/trunk/xwiki-ren
by Jerome Velociter 16 Feb '11

16 Feb '11

On Tue, Feb 15, 2011 at 2:55 PM, lucaa <platform-notifications(a)xwiki.org>wrote: > Author: lucaa > Date: 2011-02-15 14:55:47 +0100 (Tue, 15 Feb 2011) > New Revision: 34685 > > Added: > > platform/web/trunk/standard/src/main/webapp/resources/uicomponents/dashboard/dashboard.js > Modified: > > platform/core/trunk/xwiki-core/src/main/resources/ApplicationResources.properties > > platform/core/trunk/xwiki-rendering/xwiki-rendering-macros/xwiki-rendering-macro-dashboard/src/main/java/org/xwiki/rendering/internal/macro/dashboard/ColumnsDashboardRenderer.java > > platform/core/trunk/xwiki-rendering/xwiki-rendering-macros/xwiki-rendering-macro-dashboard/src/main/java/org/xwiki/rendering/internal/macro/dashboard/DashboardMacro.java > > platform/core/trunk/xwiki-rendering/xwiki-rendering-macros/xwiki-rendering-macro-dashboard/src/test/java/org/xwiki/rendering/RenderingTests.java > > platform/core/trunk/xwiki-rendering/xwiki-rendering-macros/xwiki-rendering-macro-dashboard/src/test/resources/macrodashboard1.test > > platform/web/trunk/standard/src/main/webapp/resources/uicomponents/container/columns.css > > platform/web/trunk/standard/src/main/webapp/resources/uicomponents/dashboard/dashboard.css > Log: > XWIKI-5939: Allow to edit the positions of gadgets on a dashboard with drag > & drop > XWIKI-5941: Allow to remove a gadget from a dashboard > * Added dashboard visual editor in edit inline mode, with drag & drop for > gadgets positions and remove button > Fixed the columns layout to use columns spacing on both sides of columns > (instead of only the right side), and to handle empty columns > > > > [snip] > Added: > platform/web/trunk/standard/src/main/webapp/resources/uicomponents/dashboard/dashboard.js > =================================================================== > --- > platform/web/trunk/standard/src/main/webapp/resources/uicomponents/dashboard/dashboard.js > (rev 0) > +++ > platform/web/trunk/standard/src/main/webapp/resources/uicomponents/dashboard/dashboard.js > 2011-02-15 13:55:47 UTC (rev 34685) > @@ -0,0 +1,280 @@ > +var XWiki = (function (XWiki) { > +// Start XWiki augmentation. > +XWiki.Dashboard = Class.create( { > + initialize : function(element) { > + //the class of the gadget objects > + this.gadgetsClass = "XWiki.GadgetClass"; > + // the source of the dashboard, the document where the objects are > stored and which needs to be updated > + // TODO: put me here, but it's a bit tough because we don't know if as > URL or as fullname or space, page, wiki vars > + // flag to know if the dashboard was edited or not, to know if > requests should be sent on save or not > + this.edited = false; > + // the list of removed gadgets, to really remove when the inline form > is submitted > + this.removed = new Array(); > + this.element = element; > + // add an extra class to this element, to know that it's editing, for > css that needs to be special on edit > + this.element.addClassName("dashboard-edit"); > + // find out all the gadget-containers in element and add them ids > + this.containers = element.select(".gadget-container"); > + this.createDragAndDrops(); > + this.addGadgetsHandlers(); > + > + // add save listener, to save the dashboard before submit of the form > + document.observe("xwiki:actions:save", > this.saveChanges.bindAsEventListener(this)); > + }, > + > + /** > + * @param container the container to get the id of > + * @return the original container id, parsed from the HTML id of this > container. > + * This is used to be able to have unique ids of containers in > the HTML, and at the same time be able to match > + * containers ids to the model. > + * FIXME: this will cause issues with multiple dashboards, add the name > of the dashboard to the ids > + */ > + _getContainerId : function (container) { > + // the gadget container id is of the form > gadgetcontainer_<containerId>, so parse it back > + return container.readAttribute('id').substring(16); > + }, > + > + /** > + * @param gadget the gadget to get the id of > + * @return the original gadget id, parsed from the HTML id of this > gadget. > + * This is used to be able to have unique ids of gadgets in the > HTML, and at the same time be able to match > + * gadgets ids to the model. > + * FIXME: this will cause issues with multiple dashboards, add the name > of the dashboard to the ids > + */ > + _getGadgetId : function(gadget) { > + // gadget ids are of the form gadget_<id> > + return gadget.readAttribute('id').substring(7); > + }, > + > + /* > + * Drag & drop decorators functions, to display nice placeholders when > dragging & dropping. > + */ > + _insertPlaceholder: function (container) { > + if ( container.down('.gadget') || > container.down('.gadget-placeholder')) { > + return; > + } > + var placeholder = new Element('div', {'class' : 'gadget-placeholder'}) > + .update('$msg.get("dashboard.gadget.actions.drop")'); > + container.insert(placeholder); > + }, > + > + _removePlaceholder: function (container) { > + var placeholders = container.select('.gadget-placeholder'); > + placeholders.each(function (el) { > + el.remove(); > + }); > + }, > + > + _doOnStartDrag: function() { > + this.containers.each(this._insertPlaceholder); > + }, > + _doOnEndDrag: function() { > + this.containers.each(this._removePlaceholder); > + }, > + > + /** > + * Creates drag and drops for the gadgets inside the gadget containers. > + */ > + createDragAndDrops : function() { > + // put all the container ids in a list, to be able to pass it to the > sortables > + var containerIds = new Array(); > + this.containers.each(function(container) { > + containerIds.push(container.readAttribute('id')); > + }); > + > + // create a sortable for each gadget container > + containerIds.each(function(containerId) { > + Sortable.create(containerId, { > + tag:'div', > + only:'gadget', > + handle:'gadget-title', > + overlap: 'vertical', > + scroll: window, > + containment: containerIds, > + dropOnEmpty: true, > + constraint: false, > + ghosting:false, > + hoverclass: 'gadget-container-hover-highlight', > + onUpdate: this.onMoveGadget.bind(this) > + }); > + }.bind(this)); > + }, > + > + /** > + * Adds handlers to the gadgets on the dashboard, the remove. > + */ > + addGadgetsHandlers : function() { > + // iterate through all the gadgets and add settings handlers > + this.element.select('.gadget').each(function(gadget){ > + // create a settings menu button and add it to the gadget-title > + var itemMenu = new Element('div', {'class' : 'settings', 'title' : > '$msg.get("dashboard.gadget.actions.tooltip")'}); > + var gadgetTitle = gadget.down('.gadget-title'); > + if (!gadgetTitle) { > + return; > + } > + // create a remove button in the settings menu > + var removeLink = new Element('div', {'class' : 'remove', 'title' : > '$msg.get("dashboard.gadget.action.delete.tooltip")'}); > + removeLink.observe('click', > this.onRemoveGadget.bindAsEventListener(this)); > + var actionsContainer = new Element('div', {'class' : > 'settings-menu'}) > + actionsContainer.hide(); > + actionsContainer.insert(removeLink); > + itemMenu.hide(); > + gadgetTitle.insert(itemMenu); > + gadgetTitle.insert(actionsContainer); > + // and listen to the click to open the menu > + itemMenu.observe('click', function(event){ > + // toggle actions container > + actionsContainer.toggle(); > + // and add a class to the item menu, to be able to color it > properly > + itemMenu.toggleClassName('settings-open'); > + }); > + > + // display the link remove link only when the gadget is hovered > + gadget.observe('mouseover', function() { > + itemMenu.show(); > + }); > + gadget.observe('mouseout', function(event) { > + var relatedTarget = event.relatedTarget || event.toElement; > + if ((event.element() == gadget || event.element().up('.gadget')) > && (relatedTarget == null || relatedTarget.up('.gadget') == null)) { > + // enough propagation > + event.stop(); > + itemMenu.hide(); > + actionsContainer.hide(); > + itemMenu.removeClassName('settings-open'); > + } > + }); > + }.bind(this)); > + > + // add the decorators to the gadgets on drag & drop > + var doOnStartDrag = this._doOnStartDrag.bind(this); > + var doOnEndDrag = this._doOnEndDrag.bind(this); > + Draggables.addObserver({ > + onStart: doOnStartDrag, > + onEnd: doOnEndDrag > + }); > + }, > + > + /** > + * Removes the gadget passed by its id. > + * > + * @param event the click event on the remove button for a gadget > + */ > + onRemoveGadget : function(event) { > + // get the clicked button > + var item = event.element(); > + // get the gadget to remove > + var gadget = item.up(".gadget"); > + if (!gadget) { > + return; > + } > + var gadgetId = this._getGadgetId(gadget); > + this.removed.push(gadgetId); > + // send a request to the REST url to remove the object corresponding > to this gadget > + // TODO: this should be the URI to the dashboard source, not to the > current page > + var gadgetObjectURL = XWiki.contextPath + '/rest/wikis/' + > encodeURIComponent(XWiki.currentWiki) + '/spaces/' + > + encodeURIComponent(XWiki.currentSpace) + > '/pages/' + encodeURIComponent(XWiki.currentPage) + > + '/objects/' + > encodeURIComponent(this.gadgetsClass) + '/' + gadgetId + > '?media=json&method=DELETE'; > Why not use XWiki.currentDocument.getRestUrl ? > + new XWiki.widgets.ConfirmedAjaxRequest( > + gadgetObjectURL, > + { > + onCreate : function() { > + // Disable the button, to avoid a cascade of clicks from > impatient users > + item.disabled = true; > + }, > + onSuccess : function(response) { > + // remove the gadget from the page > + gadget.remove(); > + }.bind(this) > + }, > + /* Interaction parameters */ > + { > + confirmationText: > "$msg.get('dashboard.gadget.action.delete.confirm')", > + progressMessageText : > "$msg.get('dashboard.gadget.action.delete.inProgress')", > + successMessageText : > "$msg.get('dashboard.gadget.action.delete.done')", > + failureMessageText : > "$msg.get('dashboard.gadget.action.delete.failed')" > + } > + ); > + }, > + > + /** > + * Function called when a gadget has been moved from a container to > another. > + * > + * @param container the source and target container for the move, > depending on the particular call of this function > + */ > + onMoveGadget : function(container) { > + // just flag that the dashboard was edited, actual changes were > performed when the save button will be clicked > + this.edited = true; > + }, > + > + /** > + * Saves the changes on the dashboard in this document: perform all > removes and injects the object edit fields in the > + * inline edit form. > + */ > + saveChanges : function(event) { > + if (!this.edited) { > + return; > + } > + > + var editFields = this.prepareEditParameters(); > + // get the edit form > + var editForm = event.memo.form; > + // put the fields in a dashboard layout fieldset, to be able to update > them on subsequent saves > + // (in case of save & continue) > + // FIXME: add the name of the dashboard in here, will cause issues > when there are multiple dashboards > + var dashboardFieldSet = editForm.down('.dashboard-layout-fieldset'); > + if (dashboardFieldSet) { > + // empty the dashboard field set, to fill in with the new fields > after > + dashboardFieldSet.update(''); > + } else { > + // create the dashboard field set, to fill in with the new fields > + dashboardFieldSet = new Element('fieldset', {'class' : > 'dashboard-layout-fieldset'}); > + editForm.insert(dashboardFieldSet); > + } > + editFields.each(function(editField) { > + // create a hidden input for the update of the position of the > gadget object and append it to the form > + var fieldInput = new Element('input', {'name' : editField.key, > 'value' : editField.value, 'type' : 'hidden'}); > + dashboardFieldSet.insert(fieldInput); > + }.bind(this)); > + }, > + > + /** > + * Prepares a hashmap of parameters that would update the positions of > the gadget fields. > + * @return the hash of parameters to submit to the object edit URL, to > update the gadget object positions in this > + * dashboard > + */ > + prepareEditParameters : function() { > + var parameters = new Hash(); > + // for each gadget in the containers, put it in the map, along with > its new position > + this.element.select('.gadget-container').each(function(container) { > + // get the id of the container > + var containerId = this._getContainerId(container); > + // foreach of its gadget children, get the position and compose the > position update field > + container.select('.gadget').each(function(gadget, index) { > + // get the id of the current gadget -> object number, actually > + var gadgetId = this._getGadgetId(gadget); > + // the position field name as in the inline form edit > XWiki.GadgetClass_0_position > + var positionFieldName = this.gadgetsClass + '_' + gadgetId + '_' + > 'position'; > + // compose the position field value as container, index (1 based, > though) > + var positionFieldValue = containerId + ', ' + (index + 1); > + // and put these in the prepared hash > + parameters.set(positionFieldName, positionFieldValue); > + }, this); > + }, this); > + > + return parameters; > + } > +}); > +//End XWiki augmentation. > +return XWiki; > +}(XWiki || {})); > + > +document.observe('xwiki:dom:loaded', function(event) { > + // editable dashboard only in inline mode > + if (XWiki.contextaction == 'inline') { > + // edit first dashboard FIXME: to create a dashboard editor for all > dashboards > + var dashboardRootElt = $$('.dashboard')[0]; > You can use $('mainContentArea').down('.dashboard') which should be less greedy Jerome. > + if (dashboardRootElt) { > + var dashboard = new XWiki.Dashboard(dashboardRootElt); > + } > + } > +}); > \ No newline at end of file > > > Property changes on: > platform/web/trunk/standard/src/main/webapp/resources/uicomponents/dashboard/dashboard.js > ___________________________________________________________________ > Added: svn:keywords > + Author Id Revision HeadURL > Added: svn:eol-style > + native > > _______________________________________________ > notifications mailing list > notifications(a)xwiki.org > http://lists.xwiki.org/mailman/listinfo/notifications >

1 0

[xwiki-devs] How to instruct a wiki parser to render my custom macro ?
by Bogdan Flueras 15 Feb '11

15 Feb '11

Hello devs, I'm working on some project outside XWiki which uses your rendering API. Managed to wire everything and to define my custom macro, wrote some unit tests but when I use another wiki dialect except XWIKI_2_0 (for instance Creole) in the Converter, my macro is not recognized. See sample code below: // Initialize Rendering components and allow getting instances ecm = new EmbeddableComponentManager(); ecm.initialize(this.getClass().getClassLoader()); Converter converter = ecm.lookup(Converter.class); //Register my special custom macros ComponentAnnotationLoader loader = new ComponentAnnotationLoader(); List<ComponentDescriptor> compDescriptors = loader.getComponentsDescriptors(MySpecialMacro.class); ecm.registerComponent(compDescriptors.get(0)); Converter converter = ecm.lookup(Converter.class); WikiPrinter printer = new DefaultWikiPrinter(); // HERE IS THE PROBLEM WITH MY CUSTOM MACRO converter.convert(new StringReader("{{link path='foo'}}"), Syntax.CREOLE_1_0, Syntax.XHTML_1_0, printer); So my problem is that I'd like to instruct the Creole parser or any other parser except XWIKI_2 to correctly parse my custom macro. I might be wrong, but I guess I'll have to implement some new parser to suit my needs. In respect to that I've dug into the Converter class, saw it's instantiation strategy, then followed the story until I've encountered IWikiParser and all its subclasses (XWikiParser, CreoleParser etc ) which I'm unable to find on the repository. Could you please point me in the right direction? Thank you -- ing. Bogdan Flueras

2 2

[xwiki-devs] How to instruct a wiki parser to render my custom macro ?
by Bogdan Flueras 15 Feb '11

15 Feb '11

Hello devs, I'm working on some project outside XWiki which uses your rendering API. Managed to wire everything and to define my custom macro, wrote some unit tests but when I use another wiki dialect except XWIKI_2_0 (for instance Creole) in the Converter, my macro is not recognized. See sample code below: // Initialize Rendering components and allow getting instances ecm = new EmbeddableComponentManager(); ecm.initialize(this.getClass().getClassLoader()); Converter converter = ecm.lookup(Converter.class); //Register my special custom macros ComponentAnnotationLoader loader = new ComponentAnnotationLoader(); List<ComponentDescriptor> compDescriptors = loader.getComponentsDescriptors(MySpecialMacro.class); ecm.registerComponent(compDescriptors.get(0)); Converter converter = ecm.lookup(Converter.class); WikiPrinter printer = new DefaultWikiPrinter(); // HERE IS THE PROBLEM WITH MY CUSTOM MACRO converter.convert(new StringReader("{{link path='foo'}}"), Syntax.CREOLE_1_0, Syntax.XHTML_1_0, printer); So my problem is that I'd like to instruct the Creole parser or any other parser except XWIKI_2 to correctly parse my custom macro. How can I do that? I might be wrong, but I guess I'll have to implement some new parser to suit my needs. In respect to that I've dug into the Converter class, saw it's instantiation strategy, then followed the story until I've encountered IWikiParser and all its subclasses (XWikiParser, CreoleParser etc ) which I'm unable to find thier sources on the repository. Could you please point me in the right direction? Thank you! -- View this message in context: http://xwiki.475771.n2.nabble.com/How-to-instruct-a-wiki-parser-to-render-m… Sent from the XWiki- Dev mailing list archive at Nabble.com.

1 0

[xwiki-devs] HTML Purifier or Filter in XWiki
by Bey Youcef 14 Feb '11

14 Feb '11

Hello all, I would like to know whether XWiki is using any HTML filter for purifying generated HTML. JTidy seems old and not maintained... Best regards YB DEV

4 5