Changeset 1181636

Timestamp:

06/16/2015 05:49:27 AM (11 years ago)

Author:

samwilson

Message:

Shortcode.

Location:

tabulate/trunk

Files:

• README.md (modified) (4 diffs)
• src/Shortcode.php (added)
• tabulate.php (modified) (3 diffs)
• templates/data_table.html (added)
• templates/table.html (modified) (1 diff)

tabulate/trunk/README.md

@@ -31 +31 @@
    negations of all of these). Multiple filters are conjunctive (i.e. with a
    logical *and*).
-1. Access can be granted to *read*, *create*, *update*, *delete*, and *import*
+2. Access can be granted to *read*, *create*, *update*, *delete*, and *import*
    records in any or all tables. (This can be done by anyone with the
    *promote_users* capability.)
-2. CSV data can be imported, with the UI supporting column mapping, data
+3. CSV data can be imported, with the UI supporting column mapping, data
    validation, and previewing prior to final import. If an imported row has a
    value for the Primary Key, the existing row will be overwritten.
-3. Data can be exported to CSV, including after filters have been applied. 
-4. A quick-jump navigation box (located top right of every page) can be
+4. Data can be exported to CSV, including after filters have been applied. 
+5. A quick-jump navigation box (located top right of every page) can be
    activated by installing the [WP REST API](https://wordpress.org/plugins/json-rest-api/)
    plugin.
-5. Records in tables with *date* columns can be viewed in a calendar.
-6. Entity Relationship Diagrams (drawn with [GraphViz](http://graphviz.org/))
+6. Records in tables with *date* columns can be viewed in a calendar.
+7. Entity Relationship Diagrams (drawn with [GraphViz](http://graphviz.org/))
    can be automatically generated, with any specified subset of tables. Foreign
    keys are displayed as directed edges. This feature is only available if the
    [TFO Graphviz plugin](https://wordpress.org/plugins/tfo-graphviz/) is installed.
-7. All data modifications are recorded, along with optional comments that users
+8. All data modifications are recorded, along with optional comments that users
    can provide when updating data.
+9. The `[tabulate]` shortcode can be used to embed tables, lists, and row-counts
+   into WordPress content. For more details, see the [FAQ section](https://wordpress.org/plugins/tabulate/faq/).
 
 ## Installation
@@ -63 +65 @@
 ## Frequently Asked Questions
 
-### How should issues be reported?
+### How does one use the shortcode?
+
+A [Shortcode](http://codex.wordpress.org/Shortcode) is a WordPress method of
+embedding content into posts and pages. Tabulate provides one short code,
+`[tabulate]`, which can be used to add tables, lists, and record-counts to your
+content. Its parameters are as follows:
+
+`table` — The name of the table in question. Required. No default.
+
+`format` — One of `table`, `list`, or `count`. Optional. Defaults to `table`.
+
+Do note that if a table is not accessible to the browsing user then nothing will
+be displayed. (This currently means that anonymous users can not view any
+Tabulate data, because there is no way to grant them access; this will be fixed
+soon.)
+
+### Where should issues be reported?
 
 Please log all bugs, feature requests, and other issues in the GitHub issue
-tracker: https://github.com/tabulate/tabulate/issues
+tracker at https://github.com/tabulate/tabulate/issues
 
 ### What modifications does Tabulate make to the database?
@@ -80 +98 @@
 
 ### Where is the developers' documentation?
+
 For information about the development of Tabulate or integrating other plugins
 with it please see
@@ -95 +114 @@
 https://github.com/tabulate/tabulate/commits/master
 
-Prior to version 1, changes are not being lsited here (there are too many of
+Prior to version 1, changes are not being listed here (there are too many of
 them, and nothing is stable yet).
 

tabulate/trunk/tabulate.php

@@ -3 +3 @@
  * Plugin Name: Tabulate
  * Description: Manage relational tabular data within the WP admin area, using the full power of your MySQL database.
- * Version: 0.15.0
+ * Version: 0.16.0
  * Author: Sam Wilson
  * Author URI: http://samwilson.id.au/
@@ -10 +10 @@
  */
 
-define( 'TABULATE_VERSION', '0.15.0' );
+define( 'TABULATE_VERSION', '0.16.0' );
 define( 'TABULATE_SLUG', 'tabulate' );
 
@@ -42 +42 @@
     add_filter( 'json_endpoints', array( $jsonController, 'register_routes' ) );
 } );
+
+// Shortcode.
+$shortcode = new \WordPress\Tabulate\Shortcode( $wpdb );
+add_shortcode(TABULATE_SLUG, array( $shortcode, 'run' ) );

tabulate/trunk/templates/table.html

@@ -103 +103 @@
 </div>
 
-<table class='wp-list-table widefat'>
-    <thead>
-        <tr>
-            <th>&nbsp;</th>
-            {% for column in table.get_columns %}
-            <th>{{column.get_title}}</th>
-            {% endfor %}
-        </tr>
-    </thead>
-    <tbody>
-        {% for record in records %}
-        <tr>
-            <td>
-                <a href="{{ record.get_url() }}" class="">Edit</a>
-            </td>
-            {% for column in table.get_columns %}
-            <td class="type-{{ column.type }} {% if column.is_foreign_key %}is-foreign-key{% endif %}">
-
-                {% if column.is_foreign_key %}
-
-                <a href="{{ record.get_referenced_record(column.get_name).get_url }}">
-                    {{ attribute(record, column.get_name~'FKTITLE') }}
-                </a>
-
-                {% elseif column.is_boolean %}
-                {% if attribute(record, column.get_name) is sameas(true) %}
-                Yes
-                {% elseif attribute(record, column.get_name) is sameas(false) %}
-                No
-                {% else %}
-
-                {% endif %}
-
-                {% else %}
-                {{ attribute(record, column.get_name) }}
-
-                {% endif %}
-            </td>
-            {% endfor %}
-        </tr>
-        {% endfor %}
-    </tbody>
-</table>
+{% include 'data_table.html' with { links:true } %}
 
 {%endblock%}