Event-Federation/documentation
7
1
Fork 0
Code Issues 2 Pull requests Projects Releases Wiki Activity

fix headings

Browse source
This commit is contained in:
André Menrath 2023-10-10 16:00:34 +02:00
parent 30dd7618bf
commit 7618c2956a
1 changed files with 6 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
architecture design proposal.md
View file

@ -72,17 +72,15 @@ Nevertheless, we see a lot of other cases that can benefit, if the primary goals
# Transformer Management # Transformer Management
## User Interface ## Current situation
### Current situation ### Frontend
#### Frontend
The admin user interface in v1.0.0 lets one choose to which object type all post get transformed to. The options are: The admin user interface in v1.0.0 lets one choose to which object type all post get transformed to. The options are:
* [x] Note (default) — Should work with most platforms. * [x] Note (default) — Should work with most platforms.
* [ ] Article — The presentation of the "Article" might change on different platforms. * [ ] Article — The presentation of the "Article" might change on different platforms.
* [ ] WordPress Post-Format — Maps the WordPress Post-Format to the ActivityPub Object Type. * [ ] WordPress Post-Format — Maps the WordPress Post-Format to the ActivityPub Object Type.
#### Backend ### Backend
Currently, all this functionality is handled via one hard-coded transformer in `includes/transformer/class post.php` ([Source](https://github.com/Automattic/wordpress-activitypub/blob/master/includes/transformer/class-post.php)) and the actual logic that assigns the type is somewhere else. Currently, all this functionality is handled via one hard-coded transformer in `includes/transformer/class post.php` ([Source](https://github.com/Automattic/wordpress-activitypub/blob/master/includes/transformer/class-post.php)) and the actual logic that assigns the type is somewhere else.
```php ```php
@ -109,10 +107,10 @@ class Post {
... ...
``` ```
### Proposal ## Proposal
All publicly accessible WordPress post types can become active for ActivityPub federation when selecting a transformer available for the relevant post type. The transformer determines the target ActivityPub object type, which can vary depending on variables like the post type or post format. If there is no specific transformer available for a given post type, it cannot be assigned through the user interface. All publicly accessible WordPress post types can become active for ActivityPub federation when selecting a transformer available for the relevant post type. The transformer determines the target ActivityPub object type, which can vary depending on variables like the post type or post format. If there is no specific transformer available for a given post type, it cannot be assigned through the user interface.
## Frontend ### Frontend
| | Note | Post-Format | The Events Calendar Transformer | Custom Event Transformer | | | Note | Post-Format | The Events Calendar Transformer | Custom Event Transformer |
| ----------------- |:----:|:-----------:|:-------------------------------:|:------------------------:| | ----------------- |:----:|:-----------:|:-------------------------------:|:------------------------:|
| **post** | X | O | - | - | | **post** | X | O | - | - |
@ -130,7 +128,7 @@ All publicly accessible WordPress post types can become active for ActivityPub f
- Should not differ too much from the current view: Maybe completely hide the current activity object type part of the settings and only show the buttons for `enable` and `disable` and move the transformer table to an advanced settings page. - Should not differ too much from the current view: Maybe completely hide the current activity object type part of the settings and only show the buttons for `enable` and `disable` and move the transformer table to an advanced settings page.
- Maybe make the tables more advanced and clearly show the origin of the transformer (built-in, etc.) and maybe a Pop-Up with a description, or even a link to a configuration page of the transformer. - Maybe make the tables more advanced and clearly show the origin of the transformer (built-in, etc.) and maybe a Pop-Up with a description, or even a link to a configuration page of the transformer.
## Backend ### Backend
A solution could be to define a transformer interface and let the transformers be implementations. A solution could be to define a transformer interface and let the transformers be implementations.
```php ```php