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

more consistensy in spelling

Browse source
This commit is contained in:
André Menrath 2023-10-05 10:48:09 +02:00
parent 7f9a3efb90
commit e2716ecc3a
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
architecture design proposal.md
View file

@ -20,14 +20,14 @@ The following terms are used:
- **WordPress actor types:** Things on WordPress that can be mapped to actors: - **WordPress actor types:** Things on WordPress that can be mapped to actors:
- WordPress users - WordPress users
- Whole site/blog (relay) - Whole site/blog (relay)
- (custom) post-types - (custom) post types
- **Mapping:** Which WordPress actor types are actually are mapped to any ActivityPub actors at all and to which one. - **Mapping:** Which WordPress actor types are actually are mapped to any ActivityPub actors at all and to which one.
## 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 transfers a WordPress-post of a specific WordPress-post-type to an ActivityPub object of a specific WordPress-object-type. For example a transformer that can transform: - **Transformers:** a piece of code that transfers a WordPress post of a specific WordPress post type to an ActivityPub object of a specific WordPress-object-type. For example a transformer that can transform:
- `post` to a `Note` - `post` to a `Note`
- `post` to a `Article` - `post` to a `Article`
- `post` to `Note`, `Article`, `Image`, `Audio` or `Article` depending on the [post-format](https://wordpress.org/documentation/article/post-formats/) - `post` to `Note`, `Article`, `Image`, `Audio` or `Article` depending on the [post-format](https://wordpress.org/documentation/article/post-formats/)
@ -79,7 +79,7 @@ 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) to a different ActivityPub object types. Transformations that are not
available for a given post-type are greyed out. available for a given post type are greyed out.
| | Note | Article | Page | Event | | | Note | Article | Page | Event |
| ----------------- |:----:|:-------:|:----:|:-----:| | ----------------- |:----:|:-------:|:----:|:-----:|
@ -88,9 +88,9 @@ 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
@ -105,7 +105,7 @@ x: ActivityPub object-types, y: WordPress post-types
## Backend ## Backend
Currently, only one hard-coded transformer exists in [`includes/transformer/class-post.php`](https://github.com/Automattic/wordpress-activitypub/blob/master/includes/transformer/class-post.php). Currently, only one hard-coded transformer exists in [`includes/transformer/class post.php`](https://github.com/Automattic/wordpress-activitypub/blob/master/includes/transformer/class post.php).
```php ```php
/** /**
* WordPress Post Transformer * WordPress Post Transformer
@ -206,7 +206,7 @@ We keep in mind that every post type shall only ever send as a `Create` Activity
| **product** | O | - | C | 0 | 0 | | **product** | O | - | C | 0 | 0 |
**x:** WordPress actor-types **x:** WordPress actor-types
**y:** WordPress post-types **y:** WordPress post types
**C:** Create **C:** Create
**A:** Announce **A:** Announce
**user:** the WordPress user publishing or updating something **user:** the WordPress user publishing or updating something