Updated Help; refer to "Gemini/Atom feeds"

This commit is contained in:
Jaakko Keränen 2023-07-18 14:49:41 +03:00
parent 6208b9f2ba
commit f26fabeb11
No known key found for this signature in database
GPG Key ID: BACCFCFB98DB2EDC
4 changed files with 26 additions and 9 deletions

View File

@ -518,9 +518,24 @@ Bubble is open source:
if intro:
page += unescape_ini_gemtext(intro) + '\n\n'
page += '## User Registration\n\nTo create a new account, navigate to the capsule front page and activate a client certificate. Please check that the certificate is in effect for the entire domain:\n'
page += f'=> {self.path} {session.bubble.site_icon} {session.bubble.site_name}\n'
page += f"""## User Registration
To create a new account, navigate to the capsule front page and activate a client certificate. Please check that the certificate is in effect for the entire domain:
=> {self.path} {session.bubble.site_icon} {session.bubble.site_name}
After registering your account, you should visit Settings to configure a few things:
=> /settings/profile Set up your user profile.
You can select an Emoji avatar, describe who you are, and include one featured link that appears at the top of your "u/" page.
=> /settings/display Set your time zone.
Otherwise, all displayed times are shown in UTC. Your time zone is not displayed publicly for privacy reasons.
=> /settings/certs Configure a Recovery URL.
See the "Account Recovery" section for more details.
=> /settings/notif Set an email address for notifications.
Don't forget to check out the "Posting and Commenting" section for details about making posts. The main points you should know is that Gemtext formatting is fully supported and comments can be drafted, too.
"""
page += """
## Posting and Commenting
@ -614,13 +629,15 @@ User subspaces ("u/" prefix) are intended for personal posts. Each individual po
You can also use tag filtering to have more fine-grained control over feeds. You are free to tag your posts however you like.
In your user profile, you can configure the title of your "u/" feed. By default, your username is the feed title.
=> /settings/profile Settings > Profile
=> /settings/profile In your user profile, you can configure the title of your "u/" feed.
By default, your username is the feed title.
The post title that is set in the composer will be used as-is in Gemini/Atom feeds. If the title is missing, a truncated version of the post contents are used instead.
A convenient action link is provided for submitting your "u/" Gemini feed and your individual posts to the Antenna aggregator. Antenna submission does not happen automatically so you retain control of when and if the submission is done.
The Atom feed generated by Bubble contains the full contents of each post as HTML. Any comments about the post are not included.
### Tinylogs
The formatting of posts is altered when viewing them via Tinylog: all headings are converted to level 3.
@ -657,7 +674,7 @@ A moderator of a subspace can assign any other user as an additional moderator o
### Issue Trackers
Individual subspaces can be used as issue trackers instead of regular posting. Issue trackers differ from regular subspaces in that each post will be assigned a unique ID number, and each issue has an open/closed status. One can also reference issues in the same tracker just by writing the ID number preceded by a hash:
Individual subspaces can be used for project issue tracking instead of regular posting. Issue trackers differ from regular subspaces in that each post will be assigned a unique ID number, and each issue has an open/closed status. One can also reference issues in the same tracker just by writing the ID number preceded by a hash. This automatically creates a bidirectional cross reference.
> Also see #123.

View File

@ -6,7 +6,7 @@ Bubble has been designed to be useful for both individuals and communities. It h
* Someone could run Bubble in a manner similar to WordPress, as a Gemini-based CMS for their capsule. Every user on a Bubble server gets their own personal "u/" feed that is available both for Gemini subscriptions and Tinylog followers.
* A group of people can run Bubble as their own version of Station. Users' posts appear in the shared All Posts feed on the front page.
* Groups of people can set up their own moderated "s/" subspaces on a larger Bubble instance for topic-specific discussions, much like subreddits on Reddit. Users can freely create new Bubble subspaces. Subspaces have their own home pages and Gemini feeds.
* Groups of people can set up their own moderated "s/" subspaces on a larger Bubble instance for topic-specific discussions, much like subreddits on Reddit. Users can freely create new Bubble subspaces. Subspaces have their own home pages and Gemini/Atom feeds.
* A developer of Gemini software can switch a subspace to issue tracking mode and link it with a Git repository. Issue tracking subspaces behave like GitHub Issues (and other Git forges on the web) in that posts have an open/closed status and they can cross-reference other issues in the tracker and commits in the Git repository.
## Requirements

View File

@ -313,7 +313,7 @@ def make_composer_page(session):
page += f'=> {link}/title ✏️ Edit {post_type.lower()} title\n'
if not subspace.flags & Subspace.OMIT_FROM_ALL_FLAG:
page += f'=> {link}/omit-all {session.CHECKS[nonzero(post.flags & Post.OMIT_FROM_ALL_FLAG)]} Omit {post_type.lower()} from All Posts\n'
page += f'=> {link}/omit-feed {session.CHECKS[nonzero(post.flags & Post.OMIT_FROM_FEED_FLAG)]} Omit {post_type.lower()} from Gemini feed\n'
page += f'=> {link}/omit-feed {session.CHECKS[nonzero(post.flags & Post.OMIT_FROM_FEED_FLAG)]} Omit {post_type.lower()} from Gemini/Atom feed\n'
if is_issue_tracker:
page += f'=> /{subspace.title()} 🐞 Issue in: {subspace.title()}\n'
if not is_draft:

View File

@ -577,8 +577,8 @@ def make_settings_page(session):
page += f'\n=> /settings/omit-all {session.CHECKS[nonzero(user_space.flags & Subspace.OMIT_FROM_ALL_FLAG)]} ' + \
f'Omit u/{session.user.name} from All Posts\n'
page += f'=> /settings/omit-feed {session.CHECKS[nonzero(user_space.flags & Subspace.OMIT_FROM_FEED_BY_DEFAULT)]} ' + \
'Omit posts from Gemini feed by default\n'
page += 'Individual posts can be included or excluded from the Gemini feed using the composer.\n'
'Omit posts from Gemini/Atom feed by default\n'
page += 'Individual posts can be included or excluded from Gemini/Atom feeds using the composer.\n'
page += '\n=> /settings/profile ⚙️ Profile\n'
page += '=> /settings/display ⚙️ Display\n'