';
+ var _templated = $.mustache(_template, tmplData);
+ _templated = $(_templated).appendTo($('.data-explorer .alert-messages'));
+ if (!options.persist) {
+ setTimeout(function() {
+ $(_templated).remove();
+ }, 3000);
+ }
+ }
+
+ function formatMetadata(data) {
+ out = '
';
+ $.each(data, function(key, val) {
+ if (typeof(val) == 'string' && key[0] != '_') {
+ out = out + '
' + key + '
' + val;
+ } else if (typeof(val) == 'object' && key != "geometry" && val != null) {
+ if (key == 'properties') {
+ $.each(val, function(attr, value){
+ out = out + '
' + attr + '
' + value;
+ })
+ } else {
+ out = out + '
' + key + '
' + val.join(', ');
+ }
+ }
+ });
+ out = out + '
';
+ return out;
+ }
+
+ function getBaseURL(url) {
+ var baseURL = "";
+ if ( inURL(url, '_design') ) {
+ if (inURL(url, '_rewrite')) {
+ var path = url.split("#")[0];
+ if (path[path.length - 1] === "/") {
+ baseURL = "";
+ } else {
+ baseURL = '_rewrite/';
+ }
+ } else {
+ baseURL = '_rewrite/';
+ }
+ }
+ return baseURL;
+ }
+
+ var persist = {
+ restore: function() {
+ $('.persist').each(function(i, el) {
+ var inputId = $(el).attr('id');
+ if(localStorage.getItem(inputId)) $('#' + inputId).val(localStorage.getItem(inputId));
+ })
+ },
+ save: function(id) {
+ localStorage.setItem(id, $('#' + id).val());
+ },
+ clear: function() {
+ $('.persist').each(function(i, el) {
+ localStorage.removeItem($(el).attr('id'));
+ })
+ }
+ }
+
+ // simple debounce adapted from underscore.js
+ function delay(func, wait) {
+ return function() {
+ var context = this, args = arguments;
+ var throttler = function() {
+ delete app.timeout;
+ func.apply(context, args);
+ };
+ if (!app.timeout) app.timeout = setTimeout(throttler, wait);
+ };
+ };
+
+ function resetForm(form) {
+ $(':input', form)
+ .not(':button, :submit, :reset, :hidden')
+ .val('')
+ .removeAttr('checked')
+ .removeAttr('selected');
+ }
+
+ function largestWidth(selector, min) {
+ var min_width = min || 0;
+ $(selector).each(function(i, n){
+ var this_width = $(n).width();
+ if (this_width > min_width) {
+ min_width = this_width;
+ }
+ });
+ return min_width;
+ }
+
+ function getType(obj) {
+ if (obj === null) {
+ return 'null';
+ }
+ if (typeof obj === 'object') {
+ if (obj.constructor.toString().indexOf("Array") !== -1) {
+ return 'array';
+ } else {
+ return 'object';
+ }
+ } else {
+ return typeof obj;
+ }
+ }
+
+ function lookupPath(path) {
+ var docs = app.apiDocs;
+ try {
+ _.each(path, function(node) {
+ docs = docs[node];
+ })
+ } catch(e) {
+ util.notify("Error selecting documents" + e);
+ docs = [];
+ }
+ return docs;
+ }
+
+ function nodePath(docField) {
+ if (docField.children('.object-key').length > 0) return docField.children('.object-key').text();
+ if (docField.children('.array-key').length > 0) return docField.children('.array-key').text();
+ if (docField.children('.doc-key').length > 0) return docField.children('.doc-key').text();
+ return "";
+ }
+
+ function selectedTreePath() {
+ var nodes = []
+ , parent = $('.chosen');
+ while (parent.length > 0) {
+ nodes.push(nodePath(parent));
+ parent = parent.parents('.doc-field:first');
+ }
+ return _.compact(nodes).reverse();
+ }
+
+ // TODO refactor handlers so that they dont stack up as the tree gets bigger
+ function handleTreeClick(e) {
+ var clicked = $(e.target);
+ if(clicked.hasClass('expand')) return;
+ if (clicked.children('.array').length > 0) {
+ var field = clicked;
+ } else if (clicked.siblings('.array').length > 0) {
+ var field = clicked.parents('.doc-field:first');
+ } else {
+ var field = clicked.parents('.array').parents('.doc-field:first');
+ }
+ $('.chosen').removeClass('chosen');
+ field.addClass('chosen');
+ return false;
+ }
+
+ var createTreeNode = {
+ "string": function (obj, key) {
+ var val = $('');
+ if (obj[key].length > 45) {
+ val.append($('')
+ .text(obj[key].slice(0, 45)))
+ .append(
+ $('...')
+ .click(function () {
+ val.html('')
+ .append($('')
+ .text(obj[key].length ? obj[key] : " ")
+ )
+ })
+ )
+ }
+ else {
+ var val = $('');
+ val.append(
+ $('')
+ .text(obj[key].length ? obj[key] : " ")
+ )
+ }
+ return val;
+ }
+ , "number": function (obj, key) {
+ var val = $('')
+ val.append($('' + obj[key] + ''))
+ return val;
+ }
+ , "null": function (obj, key) {
+ var val = $('')
+ val.append($('' + obj[key] + ''))
+ return val;
+ }
+ , "boolean": function (obj, key) {
+ var val = $('')
+ val.append($('' + obj[key] + ''))
+ return val;
+ }
+ , "array": function (obj, key, indent) {
+ if (!indent) indent = 1;
+ var val = $('')
+ $('[...]')
+ .click(function (e) {
+ var n = $(this).parent();
+ var cls = 'sub-'+key+'-'+indent
+ n.html('')
+ n.append('[')
+ for (i in obj[key]) {
+ var field = $('').click(handleTreeClick);
+ n.append(
+ field
+ .append('
'+i+'
')
+ .append(createTreeNode[getType(obj[key][i])](obj[key], i, indent + 1))
+ )
+ }
+ n.append(']')
+ $('div.'+cls).width(largestWidth('div.'+cls))
+ })
+ .appendTo($('').appendTo(val))
+ return val;
+ }
+ , "object": function (obj, key, indent) {
+ if (!indent) indent = 1;
+ var val = $('')
+ $('{...}')
+ .click(function (e) {
+ var n = $(this).parent();
+ n.html('')
+ n.append('{')
+ for (i in obj[key]) {
+ var field = $('').click(handleTreeClick);
+ var p = $('');
+ var di = $('
'+i+'
')
+ field.append(p)
+ .append(di)
+ .append(createTreeNode[getType(obj[key][i])](obj[key], i, indent + 1))
+ n.append(field)
+ }
+
+ n.append('}')
+ di.width(largestWidth('div.object-key'))
+ })
+ .appendTo($('').appendTo(val))
+ return val;
+ }
+ }
+
+ function renderTree(doc) {
+ var d = $('div#document-editor');
+ for (i in doc) {
+ var field = $('').click(handleTreeClick);
+ $('').appendTo(field);
+ field.append('
'+i+'
')
+ field.append(createTreeNode[getType(doc[i])](doc, i));
+ d.append(field);
+ }
+
+ $('div.doc-key-base').width(largestWidth('div.doc-key-base'))
+ }
+
+
+ return {
+ inURL: inURL,
+ registerEmitter: registerEmitter,
+ listenFor: listenFor,
+ show: show,
+ hide: hide,
+ position: position,
+ render: render,
+ notify: notify,
+ observeExit: observeExit,
+ formatMetadata:formatMetadata,
+ getBaseURL:getBaseURL,
+ resetForm: resetForm,
+ delay: delay,
+ persist: persist,
+ lookupPath: lookupPath,
+ selectedTreePath: selectedTreePath,
+ renderTree: renderTree
+ };
+}();
+this.recline = this.recline || {};
+
+// Views module following classic module pattern
+recline.View = function($) {
+
+var my = {};
+
+// Parse a URL query string (?xyz=abc...) into a dictionary.
+function parseQueryString(q) {
+ var urlParams = {},
+ e, d = function (s) {
+ return unescape(s.replace(/\+/g, " "));
+ },
+ r = /([^&=]+)=?([^&]*)/g;
+
+ if (q && q.length && q[0] === '?') {
+ q = q.slice(1);
+ }
+ while (e = r.exec(q)) {
+ // TODO: have values be array as query string allow repetition of keys
+ urlParams[d(e[1])] = d(e[2]);
+ }
+ return urlParams;
+}
+
+// The primary view for the entire application.
+//
+// It should be initialized with a recline.Model.Dataset object and an existing
+// dom element to attach to (the existing DOM element is important for
+// rendering of FlotGraph subview).
+//
+// To pass in configuration options use the config key in initialization hash
+// e.g.
+//
+// var explorer = new DataExplorer({
+// config: {...}
+// })
+//
+// Config options:
+//
+// * displayCount: how many documents to display initially (default: 10)
+// * readOnly: true/false (default: false) value indicating whether to
+// operate in read-only mode (hiding all editing options).
+//
+// All other views as contained in this one.
+my.DataExplorer = Backbone.View.extend({
+ template: ' \
+
');
+ self.el.find('tbody').append(tr);
+ var newView = new my.DataTableRow({
+ model: doc,
+ el: tr,
+ headers: self.model.get('headers')
+ });
+ newView.render();
+ });
+ return this;
+ }
+});
+
+// DataTableRow View for rendering an individual document.
+//
+// Since we want this to update in place it is up to creator to provider the element to attach to.
+// In addition you must pass in a headers in the constructor options. This should be list of headers for the DataTable.
+my.DataTableRow = Backbone.View.extend({
+ initialize: function(options) {
+ _.bindAll(this, 'render');
+ this._headers = options.headers;
+ this.el = $(this.el);
+ this.model.bind('change', this.render);
+ },
+ template: ' \
+
\
+ \
+ ',
+
+ events: {
+ 'click .okButton': 'onSubmit'
+ , 'keydown .expression-preview-code': 'onEditorKeydown'
+ },
+
+ initialize: function() {
+ this.el = $(this.el);
+ },
+
+ render: function() {
+ var htmls = $.mustache(this.template,
+ {name: this.state.currentColumn}
+ )
+ this.el.html(htmls);
+ // Put in the basic (identity) transform script
+ // TODO: put this into the template?
+ var editor = this.el.find('.expression-preview-code');
+ editor.val("function(doc) {\n doc['"+ this.state.currentColumn+"'] = doc['"+ this.state.currentColumn+"'];\n return doc;\n}");
+ editor.focus().get(0).setSelectionRange(18, 18);
+ editor.keydown();
+ },
+
+ onSubmit: function(e) {
+ var self = this;
+ var funcText = this.el.find('.expression-preview-code').val();
+ var editFunc = costco.evalFunction(funcText);
+ if (editFunc.errorMessage) {
+ util.notify("Error with function! " + editFunc.errorMessage);
+ return;
+ }
+ util.hide('dialog');
+ util.notify("Updating all visible docs. This could take a while...", {persist: true, loader: true});
+ var docs = self.model.currentDocuments.map(function(doc) {
+ return doc.toJSON();
+ });
+ // TODO: notify about failed docs?
+ var toUpdate = costco.mapDocs(docs, editFunc).edited;
+ var totalToUpdate = toUpdate.length;
+ function onCompletedUpdate() {
+ totalToUpdate += -1;
+ if (totalToUpdate === 0) {
+ util.notify(toUpdate.length + " documents updated successfully");
+ alert('WARNING: We have only updated the docs in this view. (Updating of all docs not yet implemented!)');
+ self.remove();
+ }
+ }
+ // TODO: Very inefficient as we search through all docs every time!
+ _.each(toUpdate, function(editedDoc) {
+ var realDoc = self.model.currentDocuments.get(editedDoc.id);
+ realDoc.set(editedDoc);
+ realDoc.save().then(onCompletedUpdate).fail(onCompletedUpdate)
+ });
+ },
+
+ onEditorKeydown: function(e) {
+ var self = this;
+ // if you don't setTimeout it won't grab the latest character if you call e.target.value
+ window.setTimeout( function() {
+ var errors = self.el.find('.expression-preview-parsing-status');
+ var editFunc = costco.evalFunction(e.target.value);
+ if (!editFunc.errorMessage) {
+ errors.text('No syntax error.');
+ var docs = self.model.currentDocuments.map(function(doc) {
+ return doc.toJSON();
+ });
+ var previewData = costco.previewTransform(docs, editFunc, self.state.currentColumn);
+ util.render('editPreview', 'expression-preview-container', {rows: previewData});
+ } else {
+ errors.text(editFunc.errorMessage);
+ }
+ }, 1, true);
+ }
+});
+
+// View (Dialog) for doing data transformations on whole dataset.
+my.DataTransform = Backbone.View.extend({
+ className: 'transform-view',
+ template: ' \
+
\
+ Recursive transform on all rows \
+
\
+
\
+
\
+
Traverse and transform objects by visiting every node on a recursive walk using js-traverse.
\
+
\
+ \
+
\
+
\
+
\
+
\
+ \
+
\
+
\
+ Expression \
+
\
+
\
+
\
+
\
+
\
+ \
+
\
+
\
+
\
+ No syntax error. \
+
\
+
\
+
\
+
\
+
\
+ Preview \
+
\
+
\
+
\
+
\
+
\
+
\
+
\
+ \
+
\
+
\
+
\
+
\
+ \
+
\
+
\
+
\
+ \
+ ',
+
+ initialize: function() {
+ this.el = $(this.el);
+ },
+
+ render: function() {
+ this.el.html(this.template);
+ }
+});
+
+
+// Graph view for a Dataset using Flot graphing library.
+//
+// Initialization arguments:
+//
+// * model: recline.Model.Dataset
+// * config: (optional) graph configuration hash of form:
+//
+// {
+// group: {column name for x-axis},
+// series: [{column name for series A}, {column name series B}, ... ],
+// graphType: 'line'
+// }
+//
+// NB: should *not* provide an el argument to the view but must let the view
+// generate the element itself (you can then append view.el to the DOM.
+my.FlotGraph = Backbone.View.extend({
+
+ tagName: "div",
+ className: "data-graph-container",
+
+ template: ' \
+
\
+
\
+
Help »
\
+
To create a chart select a column (group) to use as the x-axis \
+ then another column (Series A) to plot against it.
\
+
You can add add \
+ additional series by clicking the "Add series" button
\
+
\
+ \
+
\
+ \
+ \
+',
+
+ events: {
+ 'change form select': 'onEditorSubmit'
+ , 'click .editor-add': 'addSeries'
+ , 'click .action-remove-series': 'removeSeries'
+ , 'click .action-toggle-help': 'toggleHelp'
+ },
+
+ initialize: function(options, config) {
+ var self = this;
+ this.el = $(this.el);
+ _.bindAll(this, 'render', 'redraw');
+ // we need the model.headers to render properly
+ this.model.bind('change', this.render);
+ this.model.currentDocuments.bind('add', this.redraw);
+ this.model.currentDocuments.bind('reset', this.redraw);
+ this.chartConfig = _.extend({
+ group: null,
+ series: [],
+ graphType: 'line'
+ },
+ config)
+ this.render();
+ },
+
+ toTemplateJSON: function() {
+ return this.model.toJSON();
+ },
+
+ render: function() {
+ htmls = $.mustache(this.template, this.toTemplateJSON());
+ $(this.el).html(htmls);
+ // now set a load of stuff up
+ this.$graph = this.el.find('.panel.graph');
+ // for use later when adding additional series
+ // could be simpler just to have a common template!
+ this.$seriesClone = this.el.find('.editor-series').clone();
+ this._updateSeries();
+ return this;
+ },
+
+ onEditorSubmit: function(e) {
+ var select = this.el.find('.editor-group select');
+ this._getEditorData();
+ // update navigation
+ // TODO: make this less invasive (e.g. preserve other keys in query string)
+ window.location.hash = window.location.hash.split('?')[0] +
+ '?graph=' + JSON.stringify(this.chartConfig);
+ this.redraw();
+ },
+
+ redraw: function() {
+ // There appear to be issues generating a Flot graph if either:
+
+ // * The relevant div that graph attaches to his hidden at the moment of creating the plot -- Flot will complain with
+ //
+ // Uncaught Invalid dimensions for plot, width = 0, height = 0
+ // * There is no data for the plot -- either same error or may have issues later with errors like 'non-existent node-value'
+ var areWeVisible = !jQuery.expr.filters.hidden(this.el[0]);
+ if (!this.plot && (!areWeVisible || this.model.currentDocuments.length == 0)) {
+ return
+ }
+ // create this.plot and cache it
+ if (!this.plot) {
+ // only lines for the present
+ options = {
+ id: 'line',
+ name: 'Line Chart'
+ };
+ this.plot = $.plot(this.$graph, this.createSeries(), options);
+ }
+ this.plot.setData(this.createSeries());
+ this.plot.resize();
+ this.plot.setupGrid();
+ this.plot.draw();
+ },
+
+ _getEditorData: function() {
+ $editor = this
+ var series = this.$series.map(function () {
+ return $(this).val();
+ });
+ this.chartConfig.series = $.makeArray(series)
+ this.chartConfig.group = this.el.find('.editor-group select').val();
+ },
+
+ createSeries: function () {
+ var self = this;
+ var series = [];
+ if (this.chartConfig) {
+ $.each(this.chartConfig.series, function (seriesIndex, field) {
+ var points = [];
+ $.each(self.model.currentDocuments.models, function (index, doc) {
+ var x = doc.get(self.chartConfig.group);
+ var y = doc.get(field);
+ if (typeof x === 'string') {
+ x = index;
+ }
+ points.push([x, y]);
+ });
+ series.push({data: points, label: field});
+ });
+ }
+ return series;
+ },
+
+ // Public: Adds a new empty series select box to the editor.
+ //
+ // All but the first select box will have a remove button that allows them
+ // to be removed.
+ //
+ // Returns itself.
+ addSeries: function (e) {
+ e.preventDefault();
+ var element = this.$seriesClone.clone(),
+ label = element.find('label'),
+ index = this.$series.length;
+
+ this.el.find('.editor-series-group').append(element);
+ this._updateSeries();
+ label.append(' [Remove]');
+ label.find('span').text(String.fromCharCode(this.$series.length + 64));
+ return this;
+ },
+
+ // Public: Removes a series list item from the editor.
+ //
+ // Also updates the labels of the remaining series elements.
+ removeSeries: function (e) {
+ e.preventDefault();
+ var $el = $(e.target);
+ $el.parent().parent().remove();
+ this._updateSeries();
+ this.$series.each(function (index) {
+ if (index > 0) {
+ var labelSpan = $(this).prev().find('span');
+ labelSpan.text(String.fromCharCode(index + 65));
+ }
+ });
+ this.onEditorSubmit();
+ },
+
+ toggleHelp: function() {
+ this.el.find('.editor-info').toggleClass('editor-hide-info');
+ },
+
+ // Private: Resets the series property to reference the select elements.
+ //
+ // Returns itself.
+ _updateSeries: function () {
+ this.$series = this.el.find('.editor-series select');
+ }
+});
+
+return my;
+
+}(jQuery);
+
diff --git a/ckan/templates/_util.html b/ckan/templates/_util.html
index 7107b8a06a2..2d517727200 100644
--- a/ckan/templates/_util.html
+++ b/ckan/templates/_util.html
@@ -183,7 +183,7 @@
diff --git a/ckan/templates/package/facets.html b/ckan/templates/facets.html
similarity index 94%
rename from ckan/templates/package/facets.html
rename to ckan/templates/facets.html
index 4d5fcaf469d..0ffe47bbd91 100644
--- a/ckan/templates/package/facets.html
+++ b/ckan/templates/facets.html
@@ -5,9 +5,9 @@
py:strip=""
>
-
+
diff --git a/doc/api.rst b/doc/api.rst
index e53985553bc..4e9edbf1883 100644
--- a/doc/api.rst
+++ b/doc/api.rst
@@ -199,6 +199,8 @@ Here are the methods of the Model API.
+-------------------------------+--------+------------------+-------------------+
| Dataset Relationship Entity | GET | | Pkg-Relationship |
+-------------------------------+--------+------------------+-------------------+
+| Dataset Relationships Register| POST | Pkg-Relationship | |
++-------------------------------+--------+------------------+-------------------+
| Dataset Relationship Entity | PUT | Pkg-Relationship | |
+-------------------------------+--------+------------------+-------------------+
| Dataset\'s Revisions Entity | GET | | Pkg-Revisions |
@@ -210,29 +212,82 @@ Here are the methods of the Model API.
| License List | GET | | License-List |
+-------------------------------+--------+------------------+-------------------+
-* POSTing data to a register resource will create a new entity.
-
-* PUT/POSTing data to an entity resource will update an existing entity.
-
-* PUT operations may instead use the HTTP POST method.
-
-Model Formats
-`````````````
-
-Here are the data formats for the Model API.
+In general:
-.. |format-dataset-ref| replace:: Dataset-Ref
+* GET to a register resource will *list* the entities of that type.
-.. |format-dataset-register| replace:: [ |format-dataset-ref|, |format-dataset-ref|, |format-dataset-ref|, ... ]
+* GET of an entity resource will *show* the entity's properties.
-.. |format-dataset-entity| replace:: { id: Uuid, name: Name-String, title: String, version: String, url: String, resources: [ Resource, Resource, ...], author: String, author_email: String, maintainer: String, maintainer_email: String, license_id: String, tags: Tag-List, notes: String, extras: { Name-String: String, ... } }
+* POST of entity data to a register resource will *create* the new entity.
-.. |format-group-ref| replace:: Group-Ref
+* PUT of entity data to an existing entity resource will *update* it.
-.. |format-group-register| replace:: [ |format-group-ref|, |format-group-ref|, |format-group-ref|, ... ]
+It is usually clear whether you are trying to create or update, so in these cases, HTTP POST and PUT methods are accepted by CKAN interchangeably.
-.. |format-group-entity| replace:: { name: Name-String, title: String, description: String, datasets: Dataset-List }
+Model Formats
+`````````````
+Here are the data formats for the Model API:
+
++--------------------+------------------------------------------------------------+
+| Name | Format |
++====================+============================================================+
+| Dataset-Ref | Dataset-Name-String (API v1) OR Dataset-Id-Uuid (API v2) |
++--------------------+------------------------------------------------------------+
+| Dataset-List | [ Dataset-Ref, Dataset-Ref, Dataset-Ref, ... ] |
++--------------------+------------------------------------------------------------+
+| Dataset | { id: Uuid, name: Name-String, title: String, version: |
+| | String, url: String, resources: [ Resource, Resource, ...],|
+| | author: String, author_email: String, maintainer: String, |
+| | maintainer_email: String, license_id: String, |
+| | tags: Tag-List, notes: String, extras: { Name-String: |
+| | String, ... } } |
+| | See note below on additional fields upon GET of a dataset. |
++--------------------+------------------------------------------------------------+
+| Group-Ref | Group-Name-String (API v1) OR Group-Id-Uuid (API v2) |
++--------------------+------------------------------------------------------------+
+| Group-List | [ Group-Ref, Group-Ref, Group-Ref, ... ] |
++--------------------+------------------------------------------------------------+
+| Group | { name: Group-Name-String, title: String, |
+| | description: String, datasets: Dataset-List } |
++--------------------+------------------------------------------------------------+
+| Tag-List | [ Name-String, Name-String, Name-String, ... ] |
++--------------------+------------------------------------------------------------+
+| Tag | { name: Name-String } |
++--------------------+------------------------------------------------------------+
+| Resource | { url: String, format: String, description: String, |
+| | hash: String } |
++--------------------+------------------------------------------------------------+
+| Rating | { dataset: Name-String, rating: int } |
++--------------------+------------------------------------------------------------+
+| Pkg-Relationships | [ Pkg-Relationship, Pkg-Relationship, ... ] |
++--------------------+------------------------------------------------------------+
+| Pkg-Relationship | { subject: Dataset-Name-String, |
+| | object: Dataset-Name-String, type: Relationship-Type, |
+| | comment: String } |
++--------------------+------------------------------------------------------------+
+| Pkg-Revisions | [ Pkg-Revision, Pkg-Revision, Pkg-Revision, ... ] |
++--------------------+------------------------------------------------------------+
+| Pkg-Revision | { id: Uuid, message: String, author: String, |
+| | timestamp: Date-Time } |
++--------------------+------------------------------------------------------------+
+|Relationship-Type | One of: 'depends_on', 'dependency_of', |
+| | 'derives_from', 'has_derivation', |
+| | 'child_of', 'parent_of', |
+| | 'links_to', 'linked_from'. |
++--------------------+------------------------------------------------------------+
+| Revision-List | [ revision_id, revision_id, revision_id, ... ] |
++--------------------+------------------------------------------------------------+
+| Revision | { id: Uuid, message: String, author: String, |
+| | timestamp: Date-Time, datasets: Dataset-List } |
++--------------------+------------------------------------------------------------+
+| License-List | [ License, License, License, ... ] |
++--------------------+------------------------------------------------------------+
+| License | { id: Name-String, title: String, is_okd_compliant: |
+| | Boolean, is_osi_compliant: Boolean, tags: Tag-List, |
+| | family: String, url: String, maintainer: String, |
+| | date_created: Date-Time, status: String } |
++--------------------+------------------------------------------------------------+
To send request data, create the JSON-format string (encode in UTF8) put it in the request body and send it using PUT or POST.
@@ -244,7 +299,25 @@ Notes:
* To delete an 'extra' key-value pair, supply the key with JSON value: ``null``
- * When you read a dataset then some additional information is supplied that cannot current be adjusted throught the CKAN API. This includes info on Dataset Relationship ('relationships'), Group membership ('groups'), ratings ('ratings_average' and 'ratings_count'), full URL of the dataset in CKAN ('ckan_url') and Dataset ID ('id'). This is purely a convenience for clients, and only forms part of the Dataset on GET.
+ * When you read a dataset, some additional information is supplied that you cannot modify and POST back to the CKAN API. These 'read-only' fields are provided only on the Dataset GET. This is a convenience to clients, to save further requests. This applies to the following fields:
+
+===================== ================================
+Key Description
+===================== ================================
+id Unique Uuid for the Dataset
+revision_id Latest revision ID for the core Package data (but is not affected by changes to tags, groups, extras, relationships etc)
+metadata_created Date the Dataset (record) was created
+metadata_modified Date the Dataset (record) was last modified
+relationships info on Dataset Relationships
+ratings_average
+ratings_count
+ckan_url full URL of the Dataset
+download_url (API v1) URL of the first Resource
+isopen boolean indication of whether dataset is open according to Open Knowledge Definition, based on other fields
+notes_rendered HTML rendered version of the Notes field (which may contain Markdown)
+===================== ================================
+
+
Search API
~~~~~~~~~~
diff --git a/doc/common-error-messages.rst b/doc/common-error-messages.rst
index e453daddca4..468bfcea488 100644
--- a/doc/common-error-messages.rst
+++ b/doc/common-error-messages.rst
@@ -105,12 +105,12 @@ This occurs when trying to ``import migrate.exceptions`` and is due to the versi
``ckan.plugins.core.PluginNotFoundException: stats``
====================================================
-After the CKAN 1.5.1 release, the Stats extension was merged into the core CKAN code, and the ckanext namespace needs registering before the tests will run::
+After the CKAN 1.5.1 release, the Stats and Storage extensions were merged into the core CKAN code, and the ckanext namespace needs registering before the tests will run::
cd pyenv/src/ckan
python setup.py develop
-Otherwise, this problem may be to enabling an extension which is not installed. See: :doc:`extensions`_.
+Otherwise, this problem may be because of specifying an extension in the CKAN config but having not installed it. See: :doc:`extensions`.
``AssertionError: There is no script for 46 version``
=====================================================
diff --git a/doc/configuration.rst b/doc/configuration.rst
index 63c2d93084f..7396b4a38bc 100644
--- a/doc/configuration.rst
+++ b/doc/configuration.rst
@@ -493,14 +493,28 @@ solr_url
Example::
- solr_url = http://solr.okfn.org:8983/solr
+ solr_url = http://solr.okfn.org:8983/solr/ckan-schema-1.3
+
+Default value: ``http://solr.okfn.org:8983/solr``
-This configures the Solr server used for search. The SOLR schema must be one of the ones in ``ckan/config/solr`` (generally the last one).
+This configures the Solr server used for search. The Solr schema found at that URL must be one of the ones in ``ckan/config/solr`` (generally the most recent one). A check of the schema version number occurs when CKAN starts.
-Optionally, ``solr_user`` and ``solr_password`` can also be passed along to specify HTTP Basic authentication details for all Solr requests.
+Optionally, ``solr_user`` and ``solr_password`` can also be configured to specify HTTP Basic authentication details for all Solr requests.
Note, if you change this value, you need to rebuild the search index.
+simple_search
+^^^^^^^^^^^^^
+
+Example::
+
+ ckan.simple_search = true
+
+Default value: ``false``
+
+Switching this on tells CKAN search functionality to just query the database, (rather than using Solr). In this setup, search is crude and limited, e.g. no full-text search, no faceting, etc. However, this might be very useful for getting up and running quickly with CKAN.
+
+
Site Settings
-------------
@@ -593,7 +607,7 @@ plugins
Example::
- ckan.plugins = disqus synchronous_search datapreview googleanalytics stats storage follower
+ ckan.plugins = disqus datapreview googleanalytics follower
Specify which CKAN extensions are to be enabled.
diff --git a/doc/file-upload.rst b/doc/file-upload.rst
index f093b1f2bbc..eb294ded888 100644
--- a/doc/file-upload.rst
+++ b/doc/file-upload.rst
@@ -11,9 +11,10 @@ The important settings for the CKAN .ini file are
ckan.storage.bucket = ckan
ckan.storage.directory = /data/uploads/
+(See :doc:`configuration`)
+
The directory where files will be stored should exist or be created before the system is used.
It is also possible to have uploaded CSV and Excel files stored in the Webstore which provides a structured data store built on a relational database backend. The configuration of this process is described at `the CKAN wiki `_.
-Storing data in the webstore allows for the direct retrieval of the data in a tabular format. It is possible to fetch a single row of the data, all of the data and have it returned in HTML, CSV or JSON format. More information and the API documentation for the webstore is available at `read the docs
-`_.
\ No newline at end of file
+Storing data in the webstore allows for the direct retrieval of the data in a tabular format. It is possible to fetch a single row of the data, all of the data and have it returned in HTML, CSV or JSON format. More information and the API documentation for the webstore is available in the `Webstore Documentation `_.
\ No newline at end of file
diff --git a/doc/index.rst b/doc/index.rst
index 57669fece51..481947dd850 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -29,7 +29,6 @@ Contents:
forms
form-integration
database_dumps
- upgrade
i18n
file-upload
configuration
diff --git a/doc/paster.rst b/doc/paster.rst
index 1281dcf7465..8d6f4f024a3 100644
--- a/doc/paster.rst
+++ b/doc/paster.rst
@@ -233,4 +233,4 @@ For example, to create a new user called 'admin'::
To delete the 'admin' user::
- paster --plugin=ckan user delete admin --config=/etc/ckan/std/std.ini
+ paster --plugin=ckan user remove admin --config=/etc/ckan/std/std.ini
diff --git a/doc/solr-setup.rst b/doc/solr-setup.rst
index 45472cc26cf..6066771ade7 100644
--- a/doc/solr-setup.rst
+++ b/doc/solr-setup.rst
@@ -73,7 +73,12 @@ supported by the CKAN version you are installing (it will generally be the highe
sudo mv /etc/solr/conf/schema.xml /etc/solr/conf/schema.xml.bak
sudo ln -s ~/ckan/ckan/config/solr/schema-1.3.xml /etc/solr/conf/schema.xml
-Restart jetty and check that Solr is still working.
+Now restart jetty::
+
+ sudo /etc/init.d/jetty stop
+ sudo /etc/init.d/jetty start
+
+And check that Solr is running by browsing http://localhost:8983/solr/ which should offer the Administration link.
.. _solr-multi-core:
@@ -87,7 +92,7 @@ or different CKAN versions to use the same Solr instance. The different cores
will have different paths in the Solr server URL::
http://localhost:8983/solr/ckan-schema-1.2 # Used by CKAN up to 1.5
- http://localhost:8983/solr/ckan-schema-1.3 # Used by CKAN 1.5.1 and upwards
+ http://localhost:8983/solr/ckan-schema-1.3 # Used by CKAN 1.5.1
http://localhost:8983/solr/some-other-site # Used by another site
To set up a multicore Solr instance, repeat the steps on the previous section
@@ -99,33 +104,39 @@ This is how cores are defined::
-
+
-
+
-Note that each core has its own data directory. This is really important to
-prevent conflicts between cores. Create them like this::
+Adjust the names to match the CKAN schema versions you want to run.
+
+Note that each core is configured with its own data directory. This is really important to prevent conflicts between cores. Now create them like this::
- sudo mkdir /var/lib/solr/data/core0
- sudo mkdir /var/lib/solr/data/core1
+ sudo -u jetty mkdir /var/lib/solr/data/core0
+ sudo -u jetty mkdir /var/lib/solr/data/core1
-For each core, we will create a folder with its name in `/usr/share/solr`,
+For each core, we will create a folder in `/usr/share/solr`,
with a symbolic link to a specific configuration folder in `/etc/solr/`.
Copy the existing conf directory to the core directory and link it from
the home dir like this::
-
sudo mkdir /etc/solr/core0
sudo mv /etc/solr/conf /etc/solr/core0/
sudo mkdir /usr/share/solr/core0
sudo ln -s /etc/solr/core0/conf /usr/share/solr/core0/conf
+Now configure the core to use the data directory you have created. Edit `/etc/solr/core0/conf/solrconfig.xml` and change the `` to this variable::
+
+ ${dataDir}
+
+This will ensure the core uses the data directory specified earlier in `solr.xml`.
+
Once you have your first core configured, to create new ones, you just need to
add them to the `solr.xml` file and copy the existing configuration dir::
@@ -135,18 +146,19 @@ add them to the `solr.xml` file and copy the existing configuration dir::
sudo mkdir /usr/share/solr/core1
sudo ln -s /etc/solr/core1/conf /usr/share/solr/core1/conf
-After configuring the cores, restart Jetty and visit::
+Remember to ensure each core points to the correct CKAN schema. To change core1 to be ckan-schema-1.3::
- http://localhost:8983/solr
+ sudo rm sudo rm /etc/solr/core1/conf/schema.xml
+ sudo ln -s /schema-1.3.xml /etc/solr/core1/conf/schema.xml
-You should see a list of links to the admin sites for the different Solr cores.
+(where ```` is the full path to the schema file on your machine)
-**Note**: You should check that the `` directive in the `solrconfig.xml`
-file (located in the config dir) points to the correct location. The best thing
-to do is use the `dataDir` variable that we defined in `solr.xml` to ensure
-that cores are using the right data directory::
+Now restart jetty::
- ${dataDir}
+ sudo /etc/init.d/jetty stop
+ sudo /etc/init.d/jetty start
+
+And check that Solr is listing all the cores when browsing http://localhost:8983/solr/
Troubleshooting
---------------
diff --git a/doc/theming.rst b/doc/theming.rst
index bae36cd8ac7..ba38297397a 100644
--- a/doc/theming.rst
+++ b/doc/theming.rst
@@ -116,7 +116,7 @@ Next, copy the ``layout.html`` template and add a reference to the new CSS file.
py:strip="">
${select('*')}
-
+
\
+ {{/loader}} \
+  else 'grey'}.png "License: ${package.license.title if hasattr(package.license, 'title') else '?'}"){kind=icon}
diff --git a/ckan/templates/package/facets.html b/ckan/templates/facets.html
similarity index 94%
rename from ckan/templates/package/facets.html
rename to ckan/templates/facets.html
index 4d5fcaf469d..0ffe47bbd91 100644
--- a/ckan/templates/package/facets.html
+++ b/ckan/templates/facets.html
@@ -5,9 +5,9 @@
py:strip=""
>
-
+