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

make spelling consistent and add examples

Browse source
This commit is contained in:
André Menrath 2023-10-05 14:08:28 +02:00
parent 0f0fcda233
commit 1b890d6c56
1 changed files with 7 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
architecture design proposal.md
View file

@ -26,7 +26,7 @@ The following terms are used:
## Content related ## Content related
- **post type:** Post type and custom post types within WordPress - **post type:** Post type and custom post types within WordPress
- **Object Type:** ActivityPub [Object-Type](https://www.w3.org/TR/activitystreams-vocabulary/#object-types) - **Object Type:** ActivityPub [object type](https://www.w3.org/TR/activitystreams-vocabulary/#object types)
- **Transformers:** a piece of code that converts items of a particular WordPress post type to an ActivityPub object of (a) specified type(s). For example a transformer that can transform: - **Transformers:** a piece of code that converts items of a particular WordPress post type to an ActivityPub object of (a) specified type(s). For example a transformer that can transform:
- `post` to a `Note` - `post` to a `Note`
- `post` to a `Article` - `post` to a `Article`
@ -66,6 +66,7 @@ Nevertheless, we see a lot of other cases that can benefit, if we achieve this u
- ... - ...
- ActivityPub offers features how to deal with multilingual content ([contentMap - see Example 115](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-contentmap)) which could be implemented differently by multilingual and translation plugins (example search for the current use of `->set_content_map` within the ActivityPub plugin). - ActivityPub offers features how to deal with multilingual content ([contentMap - see Example 115](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-contentmap)) which could be implemented differently by multilingual and translation plugins (example search for the current use of `->set_content_map` within the ActivityPub plugin).
**Note:** CastoPop, to give an example, has currently decided that podcast episodes will not be sent to followers as a `Create` activity directly containing the `PodcastEpisode` object, but will send a `Note` which is linking to the `PodcastEpisode`, because most Fediverse implementations currently ignore by default all object types they don't know. This is likely the same reason [flohmarkt](https://codeberg.org/grindhold/flohmarkt) is currently also using the `Note` an not `Product` even though that one would be available in the offical specification.
# Transformer Management # Transformer Management
@ -80,8 +81,8 @@ The admin user interface in v1.0.0 lets one choose to which object type all post
### Proposal ### Proposal
Every public WordPress post type may be transformed (have different transformers available) to a different ActivityPub object types. Transformations that are not Every public WordPress post type may be transformed (have different transformers available) may convert it to an ActivityPub object. Transformations that are not
available for a given post type are greyed out. available for a given post type are greyed out in the user interface:
| | Note | Article | Page | Event | | | Note | Article | Page | Event |
| ----------------- |:----:|:-------:|:----:|:-----:| | ----------------- |:----:|:-------:|:----:|:-----:|
@ -90,10 +91,11 @@ available for a given post type are greyed out.
| **tribe_events** | O | - | - | X | | **tribe_events** | O | - | - | X |
| **...** | O | - | - | - | | **...** | O | - | - | - |
x: ActivityPub object-types, y: WordPress post types **x:** ActivityPub object types
**y:** WordPress post types
- For any custom post type, if there is a custom transformer registered, indicate that one should be selected as default (or select it right ahead?). - For any custom post type, if there is a custom transformer registered, indicate that one should be selected as default (or select it right ahead?).
- 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.
### Problems ### Problems