From 1b890d6c569eae76f74e60080c665e1a8e146b7a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Menrath?= Date: Thu, 5 Oct 2023 14:08:28 +0200 Subject: [PATCH] make spelling consistent and add examples --- architecture design proposal.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/architecture design proposal.md b/architecture design proposal.md index 750e98d..6e70df1 100755 --- a/architecture design proposal.md +++ b/architecture design proposal.md @@ -26,7 +26,7 @@ The following terms are used: ## Content related - **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: - `post` to a `Note` - `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). +**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 @@ -80,8 +81,8 @@ 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. +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 in the user interface: | | Note | Article | Page | Event | | ----------------- |:----:|:-------:|:----:|:-----:| @@ -90,10 +91,11 @@ 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?). -- 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