This is an old revision of the document!
Table of Contents
Airtable Sync Plugin
Compatible with DokuWiki
- 2024-02-06 "Kaos" unknown
- 2023-04-04 "Jack Jackrum" unknown
- 2022-07-31 "Igor" unknown
- 2020-07-29 "Hogfather" yes
Installation
External requirements: This plugin requires additional setup in order to function:
- Create an airtable account and generate an API Key
- Set BASE ID and API Keys using dokuwiki's: Configuration Manager
Install the plugin using the Plugin Manager and the download URL above, which points to latest version of the plugin. Refer to Plugins on how to install plugins manually.
Examples/Usage
<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”
Syntax
Use the following syntax on any dokuwiki page. (Currently only image sync is working)
Required Parameters:
<airtable>type: XXX, table: XXX, where: XXX</airtable>
- 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 — 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. 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
Change Log
- Update README.md (2021-07-01 20:17)
- Merge pull request #12 from CameronWard301/artable-syntax-dev (2021-07-01 19:42)
- Version increase (2021-07-01 19:40)
- Performance Increase: Processing now happens in the handle() method i… (2021-07-01 19:38)
- Bugfix: Fixed a bug where if the order-by field wasn't set, the plugi… (2021-07-01 19:15)
- Bugfix: Not setting optional where parameter no longer creates "field… (2021-07-01 18:03)
- Merge pull request #10 from CameronWard301/artable-syntax-dev (2021-06-06 17:43)
- updated version date (2021-06-06 17:42)