Add "How to Check if It's Working" section in admin #70

Merged
linos merged 4 commits from improve_admin_help into main 2024-10-22 18:52:57 +02:00
6 changed files with 32 additions and 13 deletions
Showing only changes of commit 61522ddcbe - Show all commits

View file

@ -3,7 +3,7 @@
* Plugin Name: ActivityPub Event Bridge
* Description: Integrating popular event plugins with the ActivityPub plugin.
* Plugin URI: https://event-federation.eu/
* Version: 0.1.1.5
* Version: 0.1.1.6
* Author: André Menrath
* Author URI: https://graz.social/@linos
* Text Domain: activitypub-event-bridge

View file

@ -166,3 +166,14 @@
vertical-align: middle;
margin: 0 0.3em;
}
code.activitypub-event-bridge-settings-example-url {
display: block;
background: rgb(28, 29, 33);
padding: 8px;
margin: 10px 0px 10px 0;
border-radius: 7px;
color: #d5d5d6;
overflow-x: auto;
word-break: break-all;
}

View file

@ -173,7 +173,7 @@ final class The_Events_Calendar extends Event {
} else {
$location->set_address( $venue->post_title );
}
$location->set_id( $venue->permalink );
$location->set_id( $venue->ID );
$location->set_name( $venue->post_title );
return $location;

View file

@ -3,7 +3,7 @@
* General settings class.
*
* This file contains the General class definition, which handles the "General" settings
* page for the ActivityPub Event Extension Plugin, providing options for configuring various general settings.
* page for the Activitypub Event Bridge Plugin, providing options for configuring various general settings.
*
* @package ActivityPub_Event_Bridge
* @since 1.0.0
@ -18,9 +18,9 @@ use ActivityPub_Event_Bridge\Plugins\Event_Plugin;
use ActivityPub_Event_Bridge\Setup;
/**
* Class responsible for the ActivityPub Event Extension related Settings.
* Class responsible for the Activitypub Event Bridge related Settings.
*
* Class which handles the "General" settings page for the ActivityPub Event Extension Plugin,
* Class which handles the "General" settings page for the Activitypub Event Bridge Plugin,
* providing options for configuring various general settings.
*
* @since 1.0.0
@ -36,11 +36,11 @@ class Settings_Page {
*/
public static function admin_menu(): void {
\add_options_page(
'Activitypub Event Extension',
'Activitypub Event Bridge',
__( 'ActivityPub Event Bridge', 'activitypub-event-bridge' ),
'manage_options',
self::SETTINGS_SLUG,
array( self::STATIC, 'settings_page' )
array( self::STATIC, 'settings_page' ),
);
}

View file

@ -3,7 +3,7 @@
* General settings class.
*
* This file contains the General class definition, which handles the "General" settings
* page for the ActivityPub Event Extension Plugin, providing options for configuring various general settings.
* page for the Activitypub Event Bridge Plugin, providing options for configuring various general settings.
*
* @package ActivityPub_Event_Bridge
* @since 1.0.0

View file

@ -29,7 +29,7 @@ if ( empty( $example_event_post ) ) {
$example_event_post = 'https://yoursite.com/events/event-name';
$example_event_post_is_dummy = true;
} else {
$example_event_post = \get_permalink( $example_event_post[0]);
$example_event_post = \get_permalink( $example_event_post[0] );
$example_event_post_is_dummy = false;
}
@ -133,8 +133,10 @@ WP_Filesystem();
<div id="activitypub-event-bridge-help-accordion-mastodon" class="activitypub-event-bridge-settings-accordion-panel" hidden="hidden">
<ol class="activitypub-event-bridge-settings-numbered-list">
<li><?php \esc_html_e( 'Log into your Mastodon account.', 'activitypub-event-bridge' ); ?></li>
<li><?php \esc_html_e( 'In the search bar, type or copy the full URL of one of your event pages (e.g., https://yoursite.com/events/event-name).', 'activitypub-event-bridge' ); ?></li>
<li>
<?php \esc_html_e( 'In the search bar, type or copy the full URL of one of your event pages. For example:', 'activitypub-event-bridge' ); ?>
<code class="activitypub-event-bridge-settings-example-url"><?php echo \esc_url( $example_event_post ); ?></code>
</li>
<li><?php \esc_html_e( 'If everything is set up correctly, you\'ll see a post representing your event. It should include the event\'s image, title, and a brief description.', 'activitypub-event-bridge' ); ?></li>
</ol>
</div>
@ -151,7 +153,10 @@ WP_Filesystem();
<div id="activitypub-event-bridge-help-accordion-mobilizon" class="activitypub-event-bridge-settings-accordion-panel" hidden="hidden">
<ol class="activitypub-event-bridge-settings-numbered-list">
<li><?php \esc_html_e( 'Log into your Mobilizon account.', 'activitypub-event-bridge' ); ?></li>
<li><?php \esc_html_e( 'In the search bar, type or copy the full URL of one of your event pages.', 'activitypub-event-bridge' ); ?></li>
<li>
<?php \esc_html_e( 'In the search bar, type or copy the full URL of one of your event pages. For example:', 'activitypub-event-bridge' ); ?>
<code class="activitypub-event-bridge-settings-example-url"><?php echo \esc_url( $example_event_post ); ?></code>
</li>
<li><?php \esc_html_e( 'If everything is set up correctly, you\'ll see a full representation of your WordPress event. This will include the event\'s banner image, title, complete description, start and end times, categories, tags, and whether it\'s an online event.', 'activitypub-event-bridge' ); ?></li>
</ol>
</div>
@ -169,7 +174,10 @@ WP_Filesystem();
<p><?php \esc_html_e( 'Of course any other application in the Fediverse should work as well. Most applications support importing external content via searching for the contents full URL.', 'activitypub-event-bridge' ); ?></p>
<ol class="activitypub-event-bridge-settings-numbered-list">
<li><?php \esc_html_e( 'Log into your account on any Fediverse app.', 'activitypub-event-bridge' ); ?></li>
<li><?php \esc_html_e( 'In the search bar, type or copy the full URL of one of your event pages (e.g., https://yoursite.com/events/event-name).', 'activitypub-event-bridge' ); ?></li>
<li>
<?php \esc_html_e( 'In the search bar, type or copy the full URL of one of your event pages. For example:', 'activitypub-event-bridge' ); ?>
<code class="activitypub-event-bridge-settings-example-url"><?php echo \esc_url( $example_event_post ); ?></code>
</li>
<li><?php \esc_html_e( 'If the application which your are using natively supports ActivityPub events, you should see a representation of your WordPress event. If your application is supports receiving ActivityPub events you will get a post which summarizes the event. Keep in mind that some apps may not support events at all.', 'activitypub-event-bridge' ); ?></li>
</ol>
</div>