77 lines
5.6 KiB
HTML
77 lines
5.6 KiB
HTML
# Introduction
|
|
{% extends 'guides/_layout.html' %}
|
|
{% block guide_content %}
|
|
<section class="guide-section">
|
|
<h2 id="pyrom">What is {{config.SITE_NAME}}?</h2>
|
|
{% if config.GUIDE_DESCRIPTION %}
|
|
<div>{{ config.GUIDE_DESCRIPTION | babycode_strict | safe }}</div>
|
|
{% endif %}
|
|
<p>{{ config.SITE_NAME }} is powered by <a href="https://git.poto.cafe/yagich/pyrom/" target="_blank">Pyrom</a>, a home-grown forum software for the indie web. This guide will help you get started, from creating an account to understanding how discussions are organized.</p>
|
|
</section>
|
|
<section class="guide-section">
|
|
<h2 id="signing-up">Signing up</h2>
|
|
<p>Most interactive features on {{ config.SITE_NAME }} such as creating threads or posting replies require a user account. While browsing is open to all, you must be signed in to participate.</p>
|
|
{% if config.DISABLE_SIGNUP %}
|
|
<p>{{ config.SITE_NAME }} uses an invite-only sign-up system. You cannot sign up directly. Instead, {% if config.USERS_CAN_INVITE %}an existing user{% elif config.MODS_CAN_INVITE %}a moderator{% endif %} can generate an invite link containing an invite key. Using that link will take you to the sign up page.</p>
|
|
{% else %}
|
|
<p>You can create an account on the <a href="{{url_for('users.sign_up')}}">sign-up page.</a> After you create your account, a moderator will need to manually approve your account before you can post. This may take some time.</p>
|
|
{% endif %}
|
|
<p>To create an account, you will need to provide:</p>
|
|
<ul>
|
|
<li>A username:
|
|
<ul>
|
|
<li>Your username must be 3-20 characters long and only include lowercase letters (a-z), numbers (0-9), hyphens (-) and underscores (_).</li>
|
|
<li>If your username includes uppercase characters, the system will automatically convert them to lowercase. Your original capitalization will be preserved as part of your display name.</li>
|
|
</ul>
|
|
</li>
|
|
<li>A strong password:
|
|
<ul>
|
|
<li>Your password must be at least 10 characters long and include at least one uppercase letter, at least one lowercase letter, at least one number, at least one special character, and no spaces.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<p>Once your account is {% if not config.DISABLE_SIGNUP %}confirmed and{% endif %} active, you will have full access to create threads, post replies, and use other features.</p>
|
|
</section>
|
|
<section class="guide-section">
|
|
<h2 id="topics">Topics</h2>
|
|
<p>The front page of {{ config.SITE_NAME }} is an overview of topics that you can create threads in. A topic is a broad category created by moderators to organize discussions.</p>
|
|
<p>Topics usually have a description that is shown under its name. Use it as guidance for where to post a thread. The order topics show up in is chosen by moderators.</p>
|
|
<p>A topic may be locked by a moderator. This will prevent threads from being created or moved into it by non-moderators. These topics are usually used for forum-wide information, but it is of course up to the moderators.</p>
|
|
<p>By default, threads in a topic are sorted by activity, but this can be changed in your user settings.</p>
|
|
</section>
|
|
<section class="guide-section">
|
|
<h2 id="threads">Threads</h2>
|
|
<p>Threads are where discussion happens. A thread is started by a user with a name and an initial post, and other users may add their own posts to it (known as replying to the thread).</p>
|
|
<p>When drafting a thread, you have to choose which topic to post it under. Be sure to follow the posting rules. If you created a thread under the wrong topic, you may move it when viewing replies. Moderators have the option to move any thread.</p>
|
|
<p>A thread may be locked by the original poster (OP) or a moderator. When a thread is locked, nobody except moderators can reply to it.</p>
|
|
<p>A thread may also be stickied by a moderator. Stickied threads show above all other threads in the topic it's under. If a thread is stickied, it is likely important.</p>
|
|
<p>You can subscribe to any thread. When subscribed, you will receive an overview of posts you missed for that thread in your inbox.</p>
|
|
<p>You can</p>
|
|
</section>
|
|
<section class="guide-section">
|
|
<h2 id="posts">Posts</h2>
|
|
<p>Posts are the individual messages that make up a thread. The first post starts the thread, and every subsequent message is a post in reply.</p>
|
|
<p>A post is split up into five sections:</p>
|
|
<ol>
|
|
<li>Usercard
|
|
<ul><li>The post author's information shows up to the left of the post. This includes their avatar, display name, mention, and status.</li></ul>
|
|
</li>
|
|
<li>Post actions
|
|
<ul><li>This shows the time and date when the post has been made (or edited), and buttons for actions you can perform on the post, such as quoting or editing.</li></ul>
|
|
</li>
|
|
<li>Post content
|
|
<ul><li>The actual message of the post.</li></ul>
|
|
</li>
|
|
<li>Signature (sig)
|
|
<ul><li>If the user has a signature set, it will show under each of their posts.</li></ul>
|
|
</li>
|
|
<li>Reactions
|
|
<ul><li>This shows the emoji reactions users have added to the post, and you can add your own.</li></ul>
|
|
</li>
|
|
</ol>
|
|
<p>You may edit or delete your posts after creating them. Edited posts will show when they were edited instead of when they were posted.</p>
|
|
<p>You can quote another user's post by pressing the <button>Quote</button> button on that post. This will copy the contents of it into the reply box and mention the user.</p>
|
|
<p>Posts are written in a markup language called Babycode. <a href="{{ url_for("guides.guide_page", category='user-guides', slug='babycode') }}">More information on it can be found in a separate guide.</a></p>
|
|
</section>
|
|
{% endblock %}
|