Skip to content
SurogateDocs

Forums and Q&A

The portal’s forum widget is a board of topics. People signed in start a topic with a title and a message, and others answer it. On a Q&A forum, people vote answers up, and the one who asked accepts the answer that solved it.

yaml
regions:
main:
- id: forum
app: portal
widget: forum
preferences: { kind: questions, moderation: after, limit: 20 }
  • kind: discussion (when left out) for topics people talk about, or questions for questions and their answers. Changing it later changes the topics started afterwards; each topic keeps the kind it was started with.
  • moderation: after (when left out) publishes a topic or an answer as soon as it is written; before keeps it waiting until a moderator approves it.
  • limit: how many topics a page of the list shows (1 to 50; 20 when left out).

Each forum widget is a board of its own: two forums, on one page or on two, keep their topics apart. A page with a forum is made for each person and never kept in a cache.

The topics belong to the widget where they were started. Moving the widget to another page, or giving it another id, leaves its topics behind: they come back if it returns.

The forum lists its topics, pinned ones first, then the most recently answered, each with its author, its number of answers and when it was last answered. Pressing a topic opens it on the same page: its message first, then its answers, 50 to a page. All topics leads back to the list.

Visitors read the topics and are asked to sign in. People signed in who may see the widget start a topic (a title of up to 200 characters and a message of up to 10,000) and answer topics, in plain text with its line breaks. They name others with @ and their handle, as in comments.

When someone answers a topic, the person who started it gets a notification that leads to the answer.

People delete their own topics and answers, and flag someone else’s, as with comments. A topic nobody answered goes when its author deletes it. One that others answered stays for their answers, as Topic removed, with no title, words or author, and takes no new answers.

On a forum of kind: questions:

  • Each answer shows its votes. People signed in vote an answer up once, never their own, and may take their vote back.
  • The one who asked, or a moderator, accepts an answer; it then shows first, marked Accepted answer, and its author is told. The others follow, the most voted first.
  • A question with an accepted answer people see is marked Answered in the list.

The site’s moderators see a topic’s Pin, Lock and Delete the topic:

  • Pin keeps a topic at the top of the list.
  • Lock closes a topic: it keeps its answers but takes no new ones, votes or acceptance, and says so.
  • Delete the topic deletes it with all its answers.

Topics and answers that wait, are flagged or were hidden are in the moderation queue, as Forum on the page and the topic’s title. Hiding a topic’s first message hides the topic; deleting it deletes the topic. A topic waiting for a moderator shows to its author only, marked as waiting.

Each person starts at most 5 topics an hour and writes at most 50 messages a day in one topic; the limits of comments on how fast one writes apply too. A topic takes at most 1,000 answers. Each person votes, or takes a vote back, at most 10 times a minute.

When a person is erased from the portal, their topics nobody answered go with them; the ones others answered stay for those answers, with no title, words or author. Their votes are taken back.