From e2716ecc3a6799c3ec3f94e47804c9707162d392 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Menrath?= Date: Thu, 5 Oct 2023 10:48:09 +0200 Subject: [PATCH] more consistensy in spelling --- architecture design proposal.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/architecture design proposal.md b/architecture design proposal.md index 81b7216..5d83f71 100755 --- a/architecture design proposal.md +++ b/architecture design proposal.md @@ -20,14 +20,14 @@ The following terms are used: - **WordPress actor types:** Things on WordPress that can be mapped to actors: - WordPress users - 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. ## 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) -- **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 `Article` - `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 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 | | ----------------- |:----:|:-------:|:----:|:-----:| @@ -88,9 +88,9 @@ available for a given post-type are greyed out. | **tribe_events** | O | - | - | X | | **...** | 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. ### Problems @@ -105,7 +105,7 @@ x: ActivityPub object-types, y: WordPress post-types ## 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 /** * 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 | **x:** WordPress actor-types -**y:** WordPress post-types +**y:** WordPress post types **C:** Create **A:** Announce **user:** the WordPress user publishing or updating something