DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:airtable

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
plugin:airtable [2021-05-18 16:08] – airtable -> Airtable Sync. in title tag cameronwardplugin:airtable [2021-07-01 20:16] (current) – [Installation] cameronward
Line 6: Line 6:
 email      : cameronward007@gmail.com  email      : cameronward007@gmail.com 
 type       : syntax type       : syntax
-lastupdate : 2021-05-17+lastupdate : 2021-07-01
 compatible : Hogfather, 2020-07-29 compatible : Hogfather, 2020-07-29
 depends    :  depends    : 
Line 22: Line 22:
  
 ===== Installation ===== ===== Installation =====
 +
 +:!: **Not for production use** - this plugin is in early development and is not intended for production use  
  
 :!: **External requirements:** This plugin requires additional setup in order to function:  :!: **External requirements:** This plugin requires additional setup in order to function: 
   * Create an airtable account and generate an [[https://airtable.com/api|API Key ]]   * Create an airtable account and generate an [[https://airtable.com/api|API Key ]]
-  * See configuration section to setup BASE ID and API Keys+  * Set BASE ID and API Keys using dokuwiki's: [[plugin:config|Configuration Manager]]
  
 Install the plugin using the [[plugin:plugin|Plugin Manager]] and the download URL above, which points to latest version of the plugin. Refer to [[:Plugins]] on how to install plugins manually. Install the plugin using the [[plugin:plugin|Plugin Manager]] and the download URL above, which points to latest version of the plugin. Refer to [[:Plugins]] on how to install plugins manually.
Line 31: Line 33:
 ===== Examples/Usage ===== ===== Examples/Usage =====
  
-  <airtable>Type: Image, Table: tblwWxohDeMeAAzdW, WHERE: {Ref #} = 19, image-size: small, alt-tag: marble-machine-x</airtable> +Full usage and examples can be found on the [[https://github.com/CameronWard301/airtable|Github Page]]
- +
-This would display a small image from the specified table where the reference id for the field = 19. It would also set +
-the images alt tag to "marble-machine-x" +
- +
-===== Syntax ===== +
- +
-Use the following syntax on any dokuwiki page. (Currently only image sync is working)   +
-Required Parameters: +
- +
-<code> <airtable>type: XXX, table: XXX, where: XXX</airtable> </code> +
-  * **type** can be one of these: +
-    * //img//    --- query an image +
-    * //table// --- query a table +
-    * //text// --- query text +
-  * **table** --- The table you wish to pull data from. +
-    * You can find the table id by visiting your base and copying it from the url. +
-    * E.g. https://airtable.com/tblQeRuyF7dZuuOLr/viwY9EwnBsF9dWsPt?blocks=hide the table ID here is: `tblQeRuyF7dZuuOLr +
-  * **where** --- [[https://support.airtable.com/hc/en-us/articles/203255215-Formula-Field-Reference|formula]] used to filter the results +
- +
-==== Images ==== +
-   <airtable>type: image, table: TABLE_NAME, where: QUERY_PARAM</airtable> +
- +
-Optional Parameters: +
- +
-  * **image-size** --- The size of the image to appear on the page. Can be one of these: +
-    * //small// +
-    * //large// --- (default)  +
-    * //full//    +
-  * **alt-tag**: ---- Image description. [[(https://moz.com/learn/seo/alt-text|How to write a good alt tag]] +
- +
-===Example:=== +
-   <airtable>Type: Image, Table: tblwWxohDeMeAAzdW, WHERE: {Ref #} = 19, image-size: small, alt-tag: marble-machine-x</airtable>   +
- +
-This would display a small image from the specified table where the reference id for the field = 19. It would also set the images alt tag to: "marble-machine-x"+
  
 ===== Development ===== ===== Development =====
plugin/airtable.1621346937.txt.gz · Last modified: 2021-05-18 16:08 by cameronward

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki