http://localhost/ticket/2204 <p> This is a reworking of the existing apps extension. </p> <p> Initial proposal at <a class="ext-link" href="http://wiki.ckan.org/Proposals#Apps_in_CKAN"><span class="icon">​</span>http://wiki.ckan.org/Proposals#Apps_in_CKAN</a> and <a class="ext-link" href="http://wiki.ckan.org/Proposals#References.2FLinks_in_CKAN"><span class="icon">​</span>http://wiki.ckan.org/Proposals#References.2FLinks_in_CKAN</a> </p> <h2 id="Naming">Naming</h2> <p> What do we call this extension? </p> <ul><li>related <ul><li>RP best IMO but perhaps too close to separate relationships concept? </li></ul></li><li>relatedstuff </li><li>links </li><li>references </li></ul><h2 id="Proposal">Proposal</h2> <p> "Related Stuff": Apps as in an application (website/service/tool) that uses this dataset (as in Apps and Ideas extension) </p> <ul><li>This case seems a general example of wanting to link some external thing to a dataset (e.g. this policy paper refs this dataset, this application uses this dataset, this visualization is built on this dataset cf <a class="ext-link" href="http://lists.okfn.org/pipermail/ckan-discuss/2011-August/001607.html"><span class="icon">​</span>http://lists.okfn.org/pipermail/ckan-discuss/2011-August/001607.html</a>) </li></ul><h2 id="Implementation">Implementation</h2> <p> New table named Related with following structure </p> <pre class="wiki">|| id (int) || type || title || description (markdown) || image_url || owner_id || url || created (timestamp) </pre><ul><li>type = Idea | App | API | Visualization | Post | Paper | News Article <ul><li>Suggest we make this a ckan.ini config option (comma separated ...?) <ul><li>Do we want the possibility of different templates for different types of Related objects? </li></ul></li></ul></li></ul><ul><li>image: ?? Depends where we store images. Simplest option would be to change to image_url and leave it to users to have already uploaded an image somewhere. If not we need to support image uploading and storage. See <a class="closed ticket" href="http://localhost/ticket/1692" title="enhancement: Add image attribute to Dataset and Group (closed: wontfix)">#1692</a> (add image attribute to datasets and groups) for more discussion, once implemented the URL here can be an internal url. </li></ul><ul><li>owner_id = user_id or creating user (see authorization below) </li></ul><p> Related2Dataset (note that related_id, dataset_id tuple should be unique). This allows for m2m connections. If a given related item is only with one dataset this could be simplified. May contain status so dataset owner can turn this on/off. </p> <pre class="wiki">|| id || dataset_id || related_id || status </pre><p> status should be used to allow for a dataset owner (for dataset_id) to de-activate the relationship between the dataset and the related. </p> <h3 id="Url">Url</h3> <ul><li>/dataset/{dataset-name}/related/{related-item-id}/{related-item-title-stringified} <ul><li>If a reference item could exist in its own right (and perhaps refer to multiple datasets then it should get its own url at e.g. /related/{id} </li></ul></li><li>/dataset/{dataset-name}/related/add =&gt; Modal dialog on related tab so we can use API to create them. </li></ul><p> /dataset/{id}/related &lt;- list </p> <ul><li>use image_url for small icon etc, title description (shortened?) </li><li>Click through to full related item (optional) </li><li>dataset owner is shown show / hide button ... (or on /dataset/{id}/related/{id} ) </li><li>related owner sees an edit button / icon (pops up modal) </li></ul><p> /dataset/{id}/related/{id} (optional) </p> <p> /dataset/{id} will have a Related tab (with bubble with count). </p> <ul><li>Drop down with Add Related -&gt; Pop-up modal and save via API </li></ul><blockquote> <blockquote> <p> (Not used: /related/add with dataset prefilled ... ) </p> </blockquote> </blockquote> <p> /related/{id}/edit </p> <h3 id="Authorization">Authorization</h3> <p> Addition of related item be considered orthogonal to datasets (and hence with separate authorization i.e. i can add the info that site X uses dataset Y without needing permission to edit dataset Y). </p> <p> Thus any logged in user could add a Related item. We set the owner of the related item to creating user and going forward only that user or a sysadmin can update or delete. </p> <p> NB: we could have a system where datasets owners have to approve related items before they show up next to their dataset. This would add substantial complexity so I propose we leave out of phase 1. </p> <h3 id="Tasksandestimates7.5d">Tasks and estimates {7.5d}</h3> <p> [x] Model + Migration for Related table. {0.75d} </p> <p> [x] Controller for Related (or relevant sections in Package controller). {0.75d} </p> <p> [x] Routing setup. {0.25d} </p> <p> [x] Schema for related. {0.5d} </p> <p> [x] Logic layer actions. {1.0d} </p> <p> [x] Auth (default + publisher). {0.5d} </p> <p> [x] Templates + Dataset changes (new tab etc). {1.0d} </p> <p> [x] JS Application for adding Related objects in a modal. {1.0d} </p> <p> [x] Testing. {0.75d} </p> <p> [x] Dataset owner disabling of Related (via M2M table). {0.5d} </p> <ul><li>Updated to allow author of related to delete as well </li></ul><p> [ ] Documentation. {0.25d} </p> en-us http://assets.okfn.org/p/ckan/img/ckan_logo_shortname.png http://localhost/ticket/2204 Trac 0.12.3 rgrp Fri, 09 Mar 2012 16:07:58 GMT http://localhost/ticket/2204#comment:1 http://localhost/ticket/2204#comment:1 <ul> <li><strong>description</strong> modified (<a href="/ticket/2204?action=diff&amp;version=1">diff</a>) </li> </ul> Ticket rgrp Mon, 19 Mar 2012 12:16:03 GMT http://localhost/ticket/2204#comment:2 http://localhost/ticket/2204#comment:2 <ul> <li><strong>description</strong> modified (<a href="/ticket/2204?action=diff&amp;version=2">diff</a>) </li> </ul> Ticket rgrp Wed, 21 Mar 2012 12:32:20 GMT http://localhost/ticket/2204#comment:3 http://localhost/ticket/2204#comment:3 <ul> <li><strong>owner</strong> changed from <em>amercader</em> to <em>toby</em> </li> <li><strong>status</strong> changed from <em>new</em> to <em>assigned</em> </li> <li><strong>milestone</strong> changed from <em>ckan-v1.7</em> to <em>current-ckan-sprint-2012-04-02</em> </li> </ul> Ticket toby Wed, 21 Mar 2012 14:44:04 GMT http://localhost/ticket/2204#comment:4 http://localhost/ticket/2204#comment:4 <p> needs discussion - planned for 23-3-2012 </p> Ticket toby Wed, 21 Mar 2012 14:44:40 GMT http://localhost/ticket/2204#comment:5 http://localhost/ticket/2204#comment:5 <p> <a class="ext-link" href="http://ckan.okfnpad.org/feature-2204-related-stuff"><span class="icon">​</span>http://ckan.okfnpad.org/feature-2204-related-stuff</a> </p> Ticket toby Tue, 27 Mar 2012 10:13:52 GMT http://localhost/ticket/2204#comment:6 http://localhost/ticket/2204#comment:6 <p> still awaiting discussion </p> Ticket ross Mon, 02 Apr 2012 13:46:47 GMT http://localhost/ticket/2204#comment:7 http://localhost/ticket/2204#comment:7 <ul> <li><strong>owner</strong> changed from <em>toby</em> to <em>ross</em> </li> </ul> Ticket ross Mon, 02 Apr 2012 13:47:26 GMT http://localhost/ticket/2204#comment:8 http://localhost/ticket/2204#comment:8 <ul> <li><strong>keywords</strong> <em>[?d]</em> added </li> <li><strong>milestone</strong> changed from <em>ckan-sprint-2012-04-02</em> to <em>current-ckan-sprint-2012-04-16</em> </li> </ul> Ticket ross Mon, 02 Apr 2012 14:07:57 GMT http://localhost/ticket/2204#comment:9 http://localhost/ticket/2204#comment:9 <ul> <li><strong>description</strong> modified (<a href="/ticket/2204?action=diff&amp;version=9">diff</a>) </li> </ul> Ticket ross Mon, 02 Apr 2012 14:11:10 GMT http://localhost/ticket/2204#comment:10 http://localhost/ticket/2204#comment:10 <ul> <li><strong>description</strong> modified (<a href="/ticket/2204?action=diff&amp;version=10">diff</a>) </li> </ul> Ticket ross Mon, 02 Apr 2012 14:46:26 GMT http://localhost/ticket/2204#comment:11 http://localhost/ticket/2204#comment:11 <ul> <li><strong>description</strong> modified (<a href="/ticket/2204?action=diff&amp;version=11">diff</a>) </li> </ul> Ticket ross Mon, 02 Apr 2012 15:16:39 GMT http://localhost/ticket/2204#comment:12 http://localhost/ticket/2204#comment:12 <ul> <li><strong>description</strong> modified (<a href="/ticket/2204?action=diff&amp;version=12">diff</a>) </li> </ul> Ticket ross Mon, 02 Apr 2012 15:32:57 GMT http://localhost/ticket/2204#comment:13 http://localhost/ticket/2204#comment:13 <ul> <li><strong>keywords</strong> <em>[7.5d]</em> added; <em>[?d]</em> removed </li> <li><strong>description</strong> modified (<a href="/ticket/2204?action=diff&amp;version=13">diff</a>) </li> </ul> Ticket ross Wed, 04 Apr 2012 10:16:22 GMT http://localhost/ticket/2204#comment:14 http://localhost/ticket/2204#comment:14 <ul> <li><strong>description</strong> modified (<a href="/ticket/2204?action=diff&amp;version=14">diff</a>) </li> </ul> Ticket rgrp Tue, 10 Apr 2012 17:12:16 GMT http://localhost/ticket/2204#comment:15 http://localhost/ticket/2204#comment:15 <p> Important comment: not sure how much we have thought through using this for storing queries / views / visualizations coming from our data viewer. In particular, wonder if this necessitates some kind of support for arbitrary json data ... </p> <p> Also (@icmurray): does this interact with our desire to do embedding? </p> Ticket ross Thu, 12 Apr 2012 08:18:55 GMT http://localhost/ticket/2204#comment:16 http://localhost/ticket/2204#comment:16 <p> I'd be happier adding this to another ticket rather than moving the target for this ticket half way through so have created <a class="assigned ticket" href="http://localhost/ticket/2284" title="enhancement: Local queries/views/viz in Related stuff. (assigned)">#2284</a> Should only be a short ticket in the next sprint. </p> Ticket ross Mon, 16 Apr 2012 08:44:44 GMT http://localhost/ticket/2204#comment:17 http://localhost/ticket/2204#comment:17 <ul> <li><strong>description</strong> modified (<a href="/ticket/2204?action=diff&amp;version=17">diff</a>) </li> </ul> Ticket ross Mon, 16 Apr 2012 11:37:23 GMT http://localhost/ticket/2204#comment:18 http://localhost/ticket/2204#comment:18 <ul> <li><strong>keywords</strong> <em>[7.5d][r:3d]</em> added; <em>[7.5d]</em> removed </li> </ul> Ticket ross Mon, 16 Apr 2012 13:11:30 GMT http://localhost/ticket/2204#comment:19 http://localhost/ticket/2204#comment:19 <ul> <li><strong>milestone</strong> changed from <em>ckan-sprint-2012-04-16</em> to <em>current-ckan-sprint-2012-04-30</em> </li> </ul> Ticket ross Thu, 19 Apr 2012 14:01:31 GMT http://localhost/ticket/2204#comment:20 http://localhost/ticket/2204#comment:20 <ul> <li><strong>description</strong> modified (<a href="/ticket/2204?action=diff&amp;version=20">diff</a>) </li> </ul> Ticket aron.carroll Tue, 24 Apr 2012 17:13:56 GMT http://localhost/ticket/2204#comment:21 http://localhost/ticket/2204#comment:21 <p> Making some notes of front-end changes that I think need to be implemented sooooon. </p> <pre class="wiki">Implement better truncation (the expanded text should pop out on hover rather than expand the entire row) Show the type of related item (an icon would be good here) Test in IE Make the form work without JavaScript by accepting x-www-form-urlencoded. Add classes to first item in a row to clear the row (currently uses :nth-child CSS) Touch gestures and re-ordering (David's request) </pre> Ticket ross Fri, 27 Apr 2012 08:48:08 GMT http://localhost/ticket/2204#comment:22 http://localhost/ticket/2204#comment:22 <ul> <li><strong>description</strong> modified (<a href="/ticket/2204?action=diff&amp;version=22">diff</a>) </li> </ul> Ticket ross Mon, 30 Apr 2012 14:21:05 GMT http://localhost/ticket/2204#comment:23 http://localhost/ticket/2204#comment:23 <ul> <li><strong>owner</strong> changed from <em>ross</em> to <em>aron.carroll</em> </li> </ul> <p> Giving this ticket to Aron to fix the front end </p> Ticket rgrp Mon, 21 May 2012 06:47:23 GMT http://localhost/ticket/2204#comment:24 http://localhost/ticket/2204#comment:24 <ul> <li><strong>owner</strong> changed from <em>aron.carroll</em> to <em>rossjones</em> </li> </ul> <p> Surely this ticket was closed 3w ago? </p> <p> @Ross: can you close ... </p> Ticket rgrp Mon, 21 May 2012 07:01:34 GMT http://localhost/ticket/2204#comment:25 http://localhost/ticket/2204#comment:25 <ul> <li><strong>owner</strong> changed from <em>rossjones</em> to <em>ross</em> </li> <li><strong>priority</strong> changed from <em>awaiting triage</em> to <em>critical</em> </li> </ul> Ticket ross Mon, 21 May 2012 10:05:23 GMT http://localhost/ticket/2204#comment:26 http://localhost/ticket/2204#comment:26 <ul> <li><strong>status</strong> changed from <em>assigned</em> to <em>closed</em> </li> <li><strong>resolution</strong> set to <em>fixed</em> </li> <li><strong>description</strong> modified (<a href="/ticket/2204?action=diff&amp;version=26">diff</a>) </li> </ul> <p> Was waiting for documentation, can close now. </p> Ticket