Skip to content

Commit e8733a3

Browse files
circuscodecircuscode
committed
Update readme.txt
1 parent 85b6b58 commit e8733a3

File tree

1 file changed

+116
-5
lines changed

1 file changed

+116
-5
lines changed

‎readme.txt‎

Lines changed: 116 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
=== Mathilda ===
1+
=== TootPress ===
22
Contributors: unmus
33
Tags: mastodon, toots, microblogging, blog, fediverse
44
Requires at least: 6.1
@@ -12,16 +12,127 @@ TootPress copies your toots from Mastodon to WordPress.
1212

1313
== Description ==
1414

15-
TootPress brings your toots into your blog. The plugin copies your toots from Mastodon continuously and saves them in the WordPress database. After that the toots can be displayed on the blog chronologically.
15+
TootPress brings your data back and copies your toots from Mastodon to WordPress continuously. The toots will be saved in the WordPress database and can be displayed on the blog chronologically (but do not have to). Indeed, Mastodon is also blogging, micro-blogging so to speak.
1616

1717
= Functions =
1818

19-
* Copy your toots from Mastodon
20-
* Display the toots on the blog
19+
* Copy your toots back
20+
* Copy your tooted images back
21+
* Display your toots on the blog
22+
* Retrieve your complete timeline
2123
* Languague: English, German (only FrontEnd)
2224

25+
= Live Demo =
26+
27+
[Here!](https://www.unmus.de/troets/)
28+
29+
= Related Links =
30+
31+
* [Source Code @ GitHub](https://github.com/circuscode/tootpress)
32+
33+
== Installation ==
34+
35+
1. Download the plugin from the WordPress Plugin Repository
36+
2. Activate the plugin in WordPress
37+
3. Follow the setup manual
38+
39+
== Frequently Asked Questions ==
40+
41+
= Why are boosts, replys and private toots not supported? =
42+
43+
Boosts are not your toots. Replys are communication, but not micro-posts. Private Toots should stay private.
44+
45+
= How does TootPress handle the canonical URL? =
46+
47+
TootPress does not modify the existing canonical url handling in WordPress. If you want to create a unique canonical url for each TootPress subpage, you must control that with a SEO plugin. This becomes relevant when your toots must be distributed over several pages and the plugin starts the paging process.
48+
49+
= What have to be considered with the usage of caching plugins? =
50+
51+
The length of the cron period in combination with the configuration of caching determines how early a toot will be displayed within the blog. If a toot should be displayed as early as possible, the caching must be deactivated for the page containing the toots. Another possibility is removing the affected page from the cache, if new toots have been loaded. For this, a WordPress Action is fired by the plugin, which then must be processed by your caching plugin.
52+
53+
= Does TootPress support WordPress Multisite? =
54+
55+
No. TootPress does not support the WordPress Multisite Feature. The plugin is working on the master-site, but is not working on all other child sites within the wordpress network.
56+
2357
== Changelog ==
2458

2559
= 0.1 "Ms. Marvel" =
2660
* March 2023
27-
* Initial Release
61+
* Initial Release
62+
63+
== Configuration ==
64+
65+
= Setup Manual =
66+
67+
1. Create an Application on your Mastodon Instance to get API Access (under Settings/Development)
68+
2. Restrict the Authorization of the created Application to Read (all data)
69+
3. Maintain Mastodon Instance and Access Token in the TootPress Settings
70+
4. Retrieve your Account ID (in WordPress under Tools/Toots)
71+
5. Maintain the Account ID in the TootPress Settings
72+
6. Create a new WordPress Page and add the Page to your Menu
73+
7. Maintain the Page ID in the TootPress Settings (you find the Page ID in URL of the Browser when editing the Page in WordPress)
74+
8. Run Mastodon API Request once (in WordPress under Tools/Toots)
75+
9. Activate Steady Fetch
76+
10. That's it!
77+
78+
= Instructions for Use =
79+
80+
* You find TootPress in WordPress in the area of Settings and Tools
81+
* Steady Fetch activates the automatic and regular load of new toots
82+
* First API Request will copy your last 40 toots
83+
* New toots will be loaded every 15 minutes (customizable)
84+
* You can load your complete timeline into WordPress with the eponymous function
85+
* Loading your complete timeline can take several hours depending of the amount of toots
86+
* 480 toots are loaded per hour as maximum
87+
* You can run a Mastodon API Request everytime at your own with the eponymous function
88+
* There is no prescribed order for the execution of Steady Fetch, Complete Timeline or manual requests
89+
* If problems occur, TootPress provides a Healthy Check
90+
91+
= Supported Toot Objects =
92+
93+
Following toot objects are supported.
94+
95+
* Text
96+
* Images
97+
* URLs
98+
* Hashtags
99+
* Mentions
100+
101+
= Not supported Toot Objects =
102+
103+
Following toot objects are not supported.
104+
105+
* Galleries
106+
* Audio
107+
* Video
108+
* Poll
109+
* Emojis
110+
* Teaser
111+
112+
= Excluded Toot Types =
113+
114+
Following toot types are excluded from the data transfer.
115+
116+
* Boosts
117+
* Replys
118+
* Private Toots
119+
120+
= CSS classes =
121+
122+
TootPress comes with basic CSS Styles. For best fit it is required to add additional styles in your theme. All TootPress UI elements can be addressed with individual CSS selectors. Please use the browser development tools to find the right classes.
123+
124+
= Data & Files =
125+
126+
TootPress creates 2 folders within wp-content/uploads.
127+
128+
* tootpress-mastodonapidata = Archive of the received Mastodon API data
129+
* tootpress-images = Toot Image Folder
130+
131+
= Cron Jobs =
132+
133+
* Steady Fetch (every 15 minutes, customizable)
134+
* Load Complete Timeline (every 5 minutes)
135+
136+
= TootPress API =
137+
138+
WordPress Action: tootpress_toots_update (fired on toot update)

0 commit comments

Comments
 (0)