Software / code / prosody-modules
Annotate
mod_pubsub_summary/README.md @ 5931:d194d1012fd3
Updating dox for mod_rest. Ideas expressed / clarified:
1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component.
2) Understanding some of the implications of this choice:
A) Changes to user authentication
B) How it affects subdomains
3) More consistent use of domain names for clarity.
4) Using different heading sizes to show scope of section.
Essentially, I added all the tidbits I had to clarify in getting this to work in my
own example.
| author | Ben Smith <bens@effortlessis.com> |
|---|---|
| date | Mon, 13 May 2024 13:25:13 -0700 |
| parent | 5140:ce11c217704a |
| rev | line source |
|---|---|
|
4874
b7222636bf26
mod_pubsub_summary: Add stub documentation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
1 Module that generates a nicer text version of Atom feeds, meant for |
|
b7222636bf26
mod_pubsub_summary: Add stub documentation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
2 use with [mod_pubsub_feeds] and [mod_pubsub_text_interface]. |
|
b7222636bf26
mod_pubsub_summary: Add stub documentation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
3 |
|
5140
ce11c217704a
mod_pubsub_summary: Mention HTML to Message Styling conversion
Kim Alvefur <zash@zash.se>
parents:
4875
diff
changeset
|
4 It extracts title, content and links from entries, does a crude |
|
ce11c217704a
mod_pubsub_summary: Mention HTML to Message Styling conversion
Kim Alvefur <zash@zash.se>
parents:
4875
diff
changeset
|
5 conversion of HTML to [XEP-0393: Message Styling] and formats a text |
|
4874
b7222636bf26
mod_pubsub_summary: Add stub documentation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
6 version like this: |
|
b7222636bf26
mod_pubsub_summary: Add stub documentation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
7 |
|
b7222636bf26
mod_pubsub_summary: Add stub documentation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
8 > \***Example Post Title**\* |
|
b7222636bf26
mod_pubsub_summary: Add stub documentation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
9 > |
|
b7222636bf26
mod_pubsub_summary: Add stub documentation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
10 > Lorem ipsum dolor sit amet. |
|
b7222636bf26
mod_pubsub_summary: Add stub documentation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
11 > |
|
4875
c8a7cb6fa1a7
mod_pubsub_summary: Fix typo in example
Kim Alvefur <zash@zash.se>
parents:
4874
diff
changeset
|
12 > https://blog.example.com/example-post |
|
4874
b7222636bf26
mod_pubsub_summary: Add stub documentation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
13 |
|
b7222636bf26
mod_pubsub_summary: Add stub documentation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
14 |
