You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2014/03/03 14:02:24 UTC

svn commit: r1573550 - in /isis/site/trunk/content: ./ components/viewers/wicket/ components/viewers/wicket/images/copy-link/

Author: danhaywood
Date: Mon Mar  3 13:02:24 2014
New Revision: 1573550

URL: http://svn.apache.org/r1573550
Log:
copy URL

Added:
    isis/site/trunk/content/components/viewers/wicket/images/copy-link/
    isis/site/trunk/content/components/viewers/wicket/images/copy-link/010-copy-link-button-940.png   (with props)
    isis/site/trunk/content/components/viewers/wicket/images/copy-link/010-copy-link-button.png   (with props)
    isis/site/trunk/content/components/viewers/wicket/images/copy-link/020-copy-link-dialog-940.png   (with props)
    isis/site/trunk/content/components/viewers/wicket/images/copy-link/020-copy-link-dialog.png   (with props)
    isis/site/trunk/content/components/viewers/wicket/images/copy-link/030-hints-940.png   (with props)
    isis/site/trunk/content/components/viewers/wicket/images/copy-link/030-hints.png   (with props)
    isis/site/trunk/content/components/viewers/wicket/images/copy-link/040-copy-link-with-hints-940.png   (with props)
    isis/site/trunk/content/components/viewers/wicket/images/copy-link/040-copy-link-with-hints.png   (with props)
    isis/site/trunk/content/components/viewers/wicket/images/copy-link/050-title-url-940.png   (with props)
    isis/site/trunk/content/components/viewers/wicket/images/copy-link/050-title-url.png   (with props)
Modified:
    isis/site/trunk/content/components/viewers/wicket/hints-and-copy-url.md
    isis/site/trunk/content/documentation.md

Modified: isis/site/trunk/content/components/viewers/wicket/hints-and-copy-url.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/components/viewers/wicket/hints-and-copy-url.md?rev=1573550&r1=1573549&r2=1573550&view=diff
==============================================================================
--- isis/site/trunk/content/components/viewers/wicket/hints-and-copy-url.md (original)
+++ isis/site/trunk/content/components/viewers/wicket/hints-and-copy-url.md Mon Mar  3 13:02:24 2014
@@ -1,10 +1,58 @@
-Title: Hints and Copy URL
+Title: Copy URL and Hints
 
-> this is a stub page
+While the user can often copy the URL of a domain object directly from the browser's address bar, the Wicket viewer also allows the URL of domain objects to be easily copied from a dialog. 
+
+More interestingly, this URL can also contain hints capturing any sorting or page numbering, or hiding/viewing of collections.  End-users can therefore share these URLs as a form of deep linking into a particular view on a domain object. 
+
+The copy URL and hinting is automatic.
 
 ##Screenshots
 
+> taken from 1.4.0-snapshot.
+
+#### Copy URL
+
+The following screenshot, taken from the [Estatio](https://github.com/estatio/estatio) application, shows the copy URL button (top right):
+
+<a href="images/copy-link/010-copy-link-button.png"><img src="images/copy-link/010-copy-link-button-940.png"/></a>
+
+Clicking on this button brings up a dialog with the URL preselected:
+
+<a href="images/copy-link/020-copy-link-dialog.png"><img src="images/copy-link/020-copy-link-dialog-940.png"/></a>
+
+The URL in this case is something like:
+
+    http://localhost:8080/wicket/entity/org.estatio.dom.lease.Lease:L_0
+
+The user can copy the link (eg `ctrl+C`) into the clipboard, then hit `OK` or `Esc` to dismiss the dialog.
+
+#### Hints
+
+Using the viewer the user can hide/show collection tables, can sort the tables by header columns:
+
+<a href="images/copy-link/030-hints.png"><img src="images/copy-link/030-hints-940.png"/></a>
+
+Also, if the collection spans multiple pages, then the individual page can be selected.
+
+Once the view has been customised, the URL shown in the copy URL dialog is in an extended form:
+
+<a href="images/copy-link/040-copy-link-with-hints.png"><img src="images/copy-link/040-copy-link-with-hints-940.png"/></a>
+
+The URL in this case is something like:
+    http://localhost:8080/wicket/entity/org.estatio.dom.lease.Lease:L_0?hint-1:collectionContents-view=3&hint-1:collectionContents:collectionContents-3:table-DESCENDING=value&hint-1:collectionContents:collectionContents-3:table-pageNumber=0&hint-2:collectionContents-view=0&hint-2:collectionContents:collectionContents-2:table-pageNumber=0&hint-3:collectionContents-view=2&hint-3:collectionContents:collectionContents-2:table-pageNumber=0&hint-4:collectionContents-view=3&hint-4:collectionContents:collectionContents-3:table-ASCENDING=exerciseDate&hint-4:collectionContents:collectionContents-3:table-pageNumber=0&hint-5:collectionContents-view=0&hint-5:collectionContents:collectionContents-3:table-pageNumber=0
+
+#### Copy URL from title
+    
+When the user invokes an action on the object, the URL (necessarily) changes to indicate that the action was invoked.  This URL is specific to the user's session and cannot be shared with others.
+    
+A quick way to grab the URL is simply by clicking on the object's title:
+
+<a href="images/copy-link/040-050-title-url.png"><img src="images/copy-link/050-title-url-940.png"/></a>
+
+
+##User Experience
 
+The copy URL dialog is typically obtained by clicking on the icon.
 
-##Domain Code
+Alternatively, `alt+]` will also open the dialog.  It can be closed with either `OK` or the `Esc` key.
 

Added: isis/site/trunk/content/components/viewers/wicket/images/copy-link/010-copy-link-button-940.png
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/components/viewers/wicket/images/copy-link/010-copy-link-button-940.png?rev=1573550&view=auto
==============================================================================
Binary file - no diff available.

Propchange: isis/site/trunk/content/components/viewers/wicket/images/copy-link/010-copy-link-button-940.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: isis/site/trunk/content/components/viewers/wicket/images/copy-link/010-copy-link-button.png
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/components/viewers/wicket/images/copy-link/010-copy-link-button.png?rev=1573550&view=auto
==============================================================================
Binary file - no diff available.

Propchange: isis/site/trunk/content/components/viewers/wicket/images/copy-link/010-copy-link-button.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: isis/site/trunk/content/components/viewers/wicket/images/copy-link/020-copy-link-dialog-940.png
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/components/viewers/wicket/images/copy-link/020-copy-link-dialog-940.png?rev=1573550&view=auto
==============================================================================
Binary file - no diff available.

Propchange: isis/site/trunk/content/components/viewers/wicket/images/copy-link/020-copy-link-dialog-940.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: isis/site/trunk/content/components/viewers/wicket/images/copy-link/020-copy-link-dialog.png
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/components/viewers/wicket/images/copy-link/020-copy-link-dialog.png?rev=1573550&view=auto
==============================================================================
Binary file - no diff available.

Propchange: isis/site/trunk/content/components/viewers/wicket/images/copy-link/020-copy-link-dialog.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: isis/site/trunk/content/components/viewers/wicket/images/copy-link/030-hints-940.png
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/components/viewers/wicket/images/copy-link/030-hints-940.png?rev=1573550&view=auto
==============================================================================
Binary file - no diff available.

Propchange: isis/site/trunk/content/components/viewers/wicket/images/copy-link/030-hints-940.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: isis/site/trunk/content/components/viewers/wicket/images/copy-link/030-hints.png
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/components/viewers/wicket/images/copy-link/030-hints.png?rev=1573550&view=auto
==============================================================================
Binary file - no diff available.

Propchange: isis/site/trunk/content/components/viewers/wicket/images/copy-link/030-hints.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: isis/site/trunk/content/components/viewers/wicket/images/copy-link/040-copy-link-with-hints-940.png
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/components/viewers/wicket/images/copy-link/040-copy-link-with-hints-940.png?rev=1573550&view=auto
==============================================================================
Binary file - no diff available.

Propchange: isis/site/trunk/content/components/viewers/wicket/images/copy-link/040-copy-link-with-hints-940.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: isis/site/trunk/content/components/viewers/wicket/images/copy-link/040-copy-link-with-hints.png
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/components/viewers/wicket/images/copy-link/040-copy-link-with-hints.png?rev=1573550&view=auto
==============================================================================
Binary file - no diff available.

Propchange: isis/site/trunk/content/components/viewers/wicket/images/copy-link/040-copy-link-with-hints.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: isis/site/trunk/content/components/viewers/wicket/images/copy-link/050-title-url-940.png
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/components/viewers/wicket/images/copy-link/050-title-url-940.png?rev=1573550&view=auto
==============================================================================
Binary file - no diff available.

Propchange: isis/site/trunk/content/components/viewers/wicket/images/copy-link/050-title-url-940.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: isis/site/trunk/content/components/viewers/wicket/images/copy-link/050-title-url.png
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/components/viewers/wicket/images/copy-link/050-title-url.png?rev=1573550&view=auto
==============================================================================
Binary file - no diff available.

Propchange: isis/site/trunk/content/components/viewers/wicket/images/copy-link/050-title-url.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Modified: isis/site/trunk/content/documentation.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/documentation.md?rev=1573550&r1=1573549&r2=1573550&view=diff
==============================================================================
--- isis/site/trunk/content/documentation.md (original)
+++ isis/site/trunk/content/documentation.md Mon Mar  3 13:02:24 2014
@@ -415,7 +415,7 @@ For both:
 * [File upload/download](components/viewers/wicket/file-upload-download.html)
 * [Bookmarked pages (sliding panel)](components/viewers/wicket/bookmarks.html)
 * [Recent pages (drop down)](components/viewers/wicket/recent-pages.html)
-* [Hints and copy URL](components/viewers/wicket/hints-and-copy-url.html) (stub)
+* [Hints and copy URL](components/viewers/wicket/hints-and-copy-url.html)
 
 }