-
Notifications
You must be signed in to change notification settings - Fork 0
/
readme.txt
145 lines (118 loc) · 8.75 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
=== Scientific and Interactive Blocks - inseri core ===
Contributors: inseriswiss
Tags: gutenberg, interactive, JavaScript, Plotly, Python
Requires at least: 6.3
Tested up to: 6.7.1
Requires PHP: 7.4
Stable tag: 1.0.0
License: GPL-3.0-or-later
License URI: https://www.gnu.org/licenses/gpl-3.0.html
Scientific and Interactive Gutenberg Blocks to facilitate Open Science
== Description ==
The vision of inseri is to enable scholars to design and publish interactive and executable online content without requiring web development skills. So that they can publish with ease the research findings in an open, citable and interactive way for effortless reuse by any researcher or the general public. Through interactivity, everyone is encouraged to edit the parameters, use own data, or reuse publicly published data to explore the research findings.
As a result, inseri core introduces scientific and interactive Gutenberg blocks to facilitate open access and open science communication. The inseri core blocks are not isolated elements but they can receive input from and give output to other blocks. A typical example would start with a Text Editor block containing the configuration for a Dropdown block. By selecting one option in the Dropdown block would provide a Web API block with the parameters to retrieve data from an external source. Using a Python Code block, the web API response could then be transformed into a suitable data format for a Plotly Chart block.
## Blocks:
- **[Cytoscape Block](https://docs.inseri.swiss/blocks/cytoscape/)**: It displays network diagram using the data of another block with Cytoscape.
- **[Data Table Block](https://docs.inseri.swiss/blocks/dataTable/)**: It displays tabular data of another block and gives guests the option to explore it.
- **[Download Block](https://docs.inseri.swiss/blocks/download/)**: It gives guests the possibility to download data from another block.
- **[Dropdown Block](https://docs.inseri.swiss/blocks/dropdown/)**: It provides guests options to choose from and the selected option can be reused in other blocks.
- **[Export Block](https://docs.inseri.swiss/blocks/export/)**: It makes the post or page content open access by allowing the visitors to download the corresponding [blueprint.json](https://wordpress.github.io/wordpress-playground/blueprints-api/using-blueprints/) and WXR file.
- **[HTML Code Block](https://docs.inseri.swiss/blocks/html/)**: It renders HTML code using the other block's data.
- **[IIIF Viewer Block](https://docs.inseri.swiss/blocks/iiifViewer/)**: It showcases images with pan/zoom functionality, along with videos and audios consumed by an IIIF API.
- **[Image Box Block](https://docs.inseri.swiss/blocks/image/)**: It displays an image utilizing the data of another block.
- **[JavaScript Code Block](https://docs.inseri.swiss/blocks/javascript/)**: Guests can run JavaScript code with data from other blocks and the result of the execution is made available to other blocks.
- **[Local File Import Block](https://docs.inseri.swiss/blocks/localFileImport/)**: It allows guests to provide their own data for blocks.
- **[Media Collection Block](https://docs.inseri.swiss/blocks/mediaCollection/)**: A collection of media files is made available as data for other blocks.
- **[Plotly Chart Block](https://docs.inseri.swiss/blocks/plotly/)**: It visualizes the data of another block using Plotly.
- **[Python Code Block](https://docs.inseri.swiss/blocks/python/)**: Guests can run Python code with data from other blocks with the use of Pyodide and the result of the execution is made available to other blocks.
- **[R Code Block](https://docs.inseri.swiss/blocks/rCode/)**: Guests can run R code with data from other blocks with the use of WebR and the result of the execution is made available to other blocks.
- **[Share Block](https://docs.inseri.swiss/blocks/share/)**: Guests can share the state of a page with other visitors, allowing them to reproduce it.
- **[Slider Block](https://docs.inseri.swiss/blocks/slider/)**: It gives guests the possibility to choose a value or a range within a specified boundaries.
- **[Text Editor Block](https://docs.inseri.swiss/blocks/textEditor/)**: It allows to share text content like JSON or XML with other blocks.
- **[Text Viewer Block](https://docs.inseri.swiss/blocks/textViewer/)**: It displays text content like JSON or XML from other block.
- **[Web API Block](https://docs.inseri.swiss/blocks/webApi/)**: It enables to call a web API and to share this data with other blocks.
- **[Zenodo Repository Block](https://docs.inseri.swiss/blocks/zenodo/)**: Using a DOI, a dataset can be loaded from Zenodo.org and shared with other blocks.
inseri name comes from the Latin _insero_ which means **to sow, to plant** but also **to insert**.
- More information about the project can be found at [inseri.swiss/about](https://inseri.swiss/about).
- For examples and showcases see [inseri.swiss](https://inseri.swiss).
- Detailed documentation is available at [docs.inseri.swiss](https://docs.inseri.swiss/).
- Try out our [Playground](https://inseri.swiss/playground/).
- For Ideas and Questions please use [GitHub Discussions](https://github.com/inseri-swiss/inseri-core-wp/discussions).
- Bug and Issue reports are welcome on [GitHub Issues](https://github.com/inseri-swiss/inseri-core-wp/issues).
- The development takes place on [GitHub](https://github.com/inseri-swiss/inseri-core-wp).
Do you want to get regular notifications? **Watch** the [GitHub](https://github.com/inseri-swiss/inseri-core-wp) repository!<br/>
Do you want to show your interest? **Star** the [GitHub](https://github.com/inseri-swiss/inseri-core-wp) repository and **Follow** [inseri.swiss](https://github.com/inseri-swiss/) organization!
== Screenshots ==
1. Create beautiful charts with Plotly
2. Call any Web API
3. Execute Python code
4. Load data from Zenodo.org
5. Enable guests to provide their own data
6. Render HTML code
== Changelog ==
### [1.0.0](https://github.com/inseri-swiss/inseri-core-wp/releases/tag/v1.0.0)
- Update: pyodide 0.26.4
- Update: diverse dependencies
### [0.4.3](https://github.com/inseri-swiss/inseri-core-wp/releases/tag/v0.4.3)
- New: Share block
- Update: clover-iiif dependency
### [0.4.2](https://github.com/inseri-swiss/inseri-core-wp/releases/tag/v0.4.2)
- Fix: HTML code can be used by less privileged users
- Fix: block names are displayed when published
- Update: diverse dependencies
### [0.4.1](https://github.com/inseri-swiss/inseri-core-wp/releases/tag/v0.4.1)
- Update: Files, which are created within a Python block, are shared with other blocks.
### [0.4.0](https://github.com/inseri-swiss/inseri-core-wp/releases/tag/v0.4.0)
**Upgrade Notice**: Each post/page with a Zenodo block needs to be opened and re-saved.
- BREAKING CHANGE: Zenodo block resolves file links every time
- New: R Code block
- Update: Download block supports custom file extension
- Update: block names are visible in the list view
- Update: pyodide 0.26.2
- Update: diverse dependencies
### [0.3.8](https://github.com/inseri-swiss/inseri-core-wp/releases/tag/v0.3.8)
- New: Export block
- Update: blocks are now supported in the site editor
- Update: diverse dependencies
### [0.3.6](https://github.com/inseri-swiss/inseri-core-wp/releases/tag/v0.3.6)
- Update: JavaScript Code block supports async
### [0.3.5](https://github.com/inseri-swiss/inseri-core-wp/releases/tag/v0.3.5)
- New: JavaScript Code block
- Update: pyodide 0.25.1
- Update: diverse dependencies
- Update: Improved source selection
### [0.3.4](https://github.com/inseri-swiss/inseri-core-wp/releases/tag/v0.3.4)
- Fix: Data Table block
### [0.3.3](https://github.com/inseri-swiss/inseri-core-wp/releases/tag/v0.3.3)
- New: Slider block
- New: Data Table block
- Fix: Zenodo api has changed
- Update: Improved hiding behavior for Text Editor, Media Collection, Python Code, Web API and Zenodo Repository
### [0.3.2](https://github.com/inseri-swiss/inseri-core-wp/releases/tag/v0.3.2)
- New: inseri Data Flow which displays block connections
- New: Cytoscape block
### [0.3.1](https://github.com/inseri-swiss/inseri-core-wp/releases/tag/v0.3.1)
- New: IIIF Viewer block
### [0.3.0](https://github.com/inseri-swiss/inseri-core-wp/releases/tag/v0.3.0)
- BREAKING CHANGE: change underlying block connection protocol
- New: enable to copy/duplicate the blocks together while preserving the connection
- Update: pyodide 0.24.1
- Update: diverse dependencies
### [0.2.1](https://github.com/inseri-swiss/inseri-core-wp/releases/tag/v0.2.1)
- minor changes
### [0.2.0](https://github.com/inseri-swiss/inseri-core-wp/releases/tag/v0.2.0)
- BREAKING CHANGE: renaming block from 'Media Library' to 'Media Collection'
### 0.1.0 MVP
added 12 new blocks:
- Download
- Dropdown
- HTML Code
- Image Box
- Local File Import
- Media Library
- Plotly Chart
- Python Code
- Text Editor
- Text Viewer
- Web API Block
- Zenodo Repository