smr/assets/faq.html

<!DOCTYPE html>
<html lang="en">
	<head>
		<meta charset="utf-8">
		<title>&#x1f351;</title>
		<link href="/_css/milligram.css" rel="stylesheet">
		<link href="/_css/style.css" rel="stylesheet">
	</head>
	<body class="container">
		<main class="wrapper">
			<h1>FAQ</h1>
			An attempt to answer frequently asked questions, and document
			the details of site features. As with all software documentation,
			this is how the developer <b>thinks</b> these things work,
			to find out how things actually work, see the source code.
			<h2>How do I register an account?</h2>
			You can go <a href="/_claim">here</a> to register an account,
			although you can also post pastes and comments anonymously.
			<h2>Parsers? What are those?</h2>
			Parsers are how you can style the text you post. While
			this software started as a pastebin clone, the need to style
			text better than pastebin.com quickly became apparent. Two
			parsers are currently available:
			<h3>The plain parser</h3>
			<p>The goal of the plain parser is to format plain text exactly as you would expect it. It does not try to to anything fancy and tries to be faithful to the plaintext representation.
			<h3>Imageboard parser</h3>
			<p>The imageboard parser delivers an approximation of Infinity markup, and will be familiar to those who have used imageboards before. The imageboard parser supports the following markup:
			<p>Surround text with double single-quotes(') to make text <i>italic</i>
			<p>Surround text with triple single-quotes to make text <b>bold</b>
			<p>Surround text with underscores(_) to make it <u>underlined</u>
			<p>Surround text with double asterisks(*) to make it <span class="spoiler">spoilered</span>
			<p>Surround text with tildes(~) to make it <s>strike through</s>
			<p>Begin a line with a greater-than followed by a space to make it
			<p><span class="greentext">&gt;greentext</span>
			<p>Begin a line with a less-than followed by a space to make it
			<p><span class="pinktext">&lt;pinktext</span>
			<p>Surround text with forum-style [spoiler] and [/spoiler] tags as a second way to <span class="spoiler2">spoiler</span>
			<p>Surround text with forum-style [code] and [/code] tags to make it

			<pre><code>Preformatted and monospace</code></pre>

			<p>If you have incomplete markup at the end, it shouldn't break anything, let me know if it does.
			<h2>How does search work?</h2>
			<p>The search utility searches for stories on the site.
			At it's most simple, it searches stories based on tags,
			but it can also filter stories based on: title, author,
			date, and hits. In general, the syntax for search is
			<code>{+-} &lt;field&gt; &lt;operator&gt; &lt;value&gt;</code>
			<p>The first <code>+</code> or <code>-</code> specifies
			weather to include or exclude results based on this
			search, the <code>&lt;field&gt;</code> specifies what
			field to search for (or search based on tag if this is
			missing), and <code>&lt;operator&gt;</code> specifies
			how to search.
			<p>For title and author, the only allowed operator is
			<code>=</code>. This operator will search for <code>&lt;value&gt;</code> 
			appearing anywhere in the field, case insensitive. For
			hits and time, the allowed operators are
			<code>&gt;</code>,<code>&lt;</code>,<code>&gt;=</code>,
			<code>&lt;=</code>,<code>=</code>, which searches for
			greater than, less than, greater than or equal to, less
			than or equal to, and strictly equal to, respectively.
			Tag does not need a <code>&lt;field&gt;</code> or <code>&lt;operator&gt;</code>, and only allows
			exact matches. As a quirk of this system, it is
			impossible to search for the tags "author", "title",
			"hits" or "date".

			<p>Examples:

			<pre><code>+author=admin -meta</code></pre>
			<p>Will return all stories by the users "admin" and "badminton_enthusiast" that do not include the "meta" tag.
			<pre><code>+hits&gt;20 -date&gt;=1609459201</code></pre>
			<p>Will return all stories with more than 20 hits that were posted before January 1, 2021 (unix timestamp 1609459201).
			<p>While the date field is a little hard to use for humans, it may be useful for robots.
			<h2>How do I enable reader mode on my story?</h2>
			Unfortunately, there is no web standard about how reader
			modes for different browsers work, and no way to hint to
			the browser that a page is readable. The site makes a
			best effort to trigger browsers into thinking a post is
			readable, but this is unreliable. In general, if reader mode
			is broken you just need to make your post a little longer.
		</main>
	</body>
</html>
Add a search utility Add a search utility Implement a dark theme Add an FAQ page with some info 2020-12-28 05:01:07 +01:00			`<!DOCTYPE html>`
			`<html lang="en">`
			`<head>`
			`<meta charset="utf-8">`
			`<title>🍑</title>`
			`<link href="/_css/milligram.css" rel="stylesheet">`
			`<link href="/_css/style.css" rel="stylesheet">`
			`</head>`
			`<body class="container">`
			`<main class="wrapper">`
			`<h1>FAQ</h1>`
			`An attempt to answer frequently asked questions, and document`
Spellcheck for faq Also add a nice serif text font. 2020-12-28 05:23:43 +01:00			`the details of site features. As with all software documentation,`
Add a search utility Add a search utility Implement a dark theme Add an FAQ page with some info 2020-12-28 05:01:07 +01:00			`this is how the developer <b>thinks</b> these things work,`
			`to find out how things actually work, see the source code.`
Spellcheck for faq Also add a nice serif text font. 2020-12-28 05:23:43 +01:00			`<h2>How do I register an account?</h2>`
Add a search utility Add a search utility Implement a dark theme Add an FAQ page with some info 2020-12-28 05:01:07 +01:00			`You can go <a href="/_claim">here</a> to register an account,`
			`although you can also post pastes and comments anonymously.`
			`<h2>Parsers? What are those?</h2>`
Spellcheck for faq Also add a nice serif text font. 2020-12-28 05:23:43 +01:00			`Parsers are how you can style the text you post. While`
Add a search utility Add a search utility Implement a dark theme Add an FAQ page with some info 2020-12-28 05:01:07 +01:00			`this software started as a pastebin clone, the need to style`
			`text better than pastebin.com quickly became apparent. Two`
			`parsers are currently available:`
			`<h3>The plain parser</h3>`
			`<p>The goal of the plain parser is to format plain text exactly as you would expect it. It does not try to to anything fancy and tries to be faithful to the plaintext representation.`
			`<h3>Imageboard parser</h3>`
			`<p>The imageboard parser delivers an approximation of Infinity markup, and will be familiar to those who have used imageboards before. The imageboard parser supports the following markup:`
			`<p>Surround text with double single-quotes(') to make text <i>italic</i>`
			`<p>Surround text with triple single-quotes to make text <b>bold</b>`
			`<p>Surround text with underscores(_) to make it <u>underlined</u>`
			`<p>Surround text with double asterisks(*) to make it <span class="spoiler">spoilered</span>`
			`<p>Surround text with tildes(~) to make it <s>strike through</s>`
			`<p>Begin a line with a greater-than followed by a space to make it`
			`<p><span class="greentext">>greentext</span>`
			`<p>Begin a line with a less-than followed by a space to make it`
			`<p><span class="pinktext"><pinktext</span>`
			`<p>Surround text with forum-style [spoiler] and [/spoiler] tags as a second way to <span class="spoiler2">spoiler</span>`
			`<p>Surround text with forum-style [code] and [/code] tags to make it`

Spellcheck for faq Also add a nice serif text font. 2020-12-28 05:23:43 +01:00			`<pre><code>Preformatted and monospace</code></pre>`
Add a search utility Add a search utility Implement a dark theme Add an FAQ page with some info 2020-12-28 05:01:07 +01:00
			`<p>If you have incomplete markup at the end, it shouldn't break anything, let me know if it does.`
			`<h2>How does search work?</h2>`
			`<p>The search utility searches for stories on the site.`
			`At it's most simple, it searches stories based on tags,`
			`but it can also filter stories based on: title, author,`
			`date, and hits. In general, the syntax for search is`
Spellcheck for faq Also add a nice serif text font. 2020-12-28 05:23:43 +01:00			`<code>{+-} <field> <operator> <value></code>`
Add a search utility Add a search utility Implement a dark theme Add an FAQ page with some info 2020-12-28 05:01:07 +01:00			`<p>The first <code>+</code> or <code>-</code> specifies`
			`weather to include or exclude results based on this`
			`search, the <code><field></code> specifies what`
			`field to search for (or search based on tag if this is`
			`missing), and <code><operator></code> specifies`
			`how to search.`
Spellcheck for faq Also add a nice serif text font. 2020-12-28 05:23:43 +01:00			`<p>For title and author, the only allowed operator is`
			`<code>=</code>. This operator will search for <code><value></code>`
Add a search utility Add a search utility Implement a dark theme Add an FAQ page with some info 2020-12-28 05:01:07 +01:00			`appearing anywhere in the field, case insensitive. For`
			`hits and time, the allowed operators are`
			`<code>></code>,<code><</code>,<code>>=</code>,`
			`<code><=</code>,<code>=</code>, which searches for`
			`greater than, less than, greater than or equal to, less`
			`than or equal to, and strictly equal to, respectively.`
Spellcheck for faq Also add a nice serif text font. 2020-12-28 05:23:43 +01:00			`Tag does not need a <code><field></code> or <code><operator></code>, and only allows`
Add a search utility Add a search utility Implement a dark theme Add an FAQ page with some info 2020-12-28 05:01:07 +01:00			`exact matches. As a quirk of this system, it is`
			`impossible to search for the tags "author", "title",`
Spellcheck for faq Also add a nice serif text font. 2020-12-28 05:23:43 +01:00			`"hits" or "date".`
Add a search utility Add a search utility Implement a dark theme Add an FAQ page with some info 2020-12-28 05:01:07 +01:00
Spellcheck for faq Also add a nice serif text font. 2020-12-28 05:23:43 +01:00			`<p>Examples:`
Add a search utility Add a search utility Implement a dark theme Add an FAQ page with some info 2020-12-28 05:01:07 +01:00
			`<pre><code>+author=admin -meta</code></pre>`
Spellcheck for faq Also add a nice serif text font. 2020-12-28 05:23:43 +01:00			`<p>Will return all stories by the users "admin" and "badminton_enthusiast" that do not include the "meta" tag.`
			`<pre><code>+hits>20 -date>=1609459201</code></pre>`
			`<p>Will return all stories with more than 20 hits that were posted before January 1, 2021 (unix timestamp 1609459201).`
			`<p>While the date field is a little hard to use for humans, it may be useful for robots.`
Add a search utility Add a search utility Implement a dark theme Add an FAQ page with some info 2020-12-28 05:01:07 +01:00			`<h2>How do I enable reader mode on my story?</h2>`
			`Unfortunately, there is no web standard about how reader`
			`modes for different browsers work, and no way to hint to`
			`the browser that a page is readable. The site makes a`
			`best effort to trigger browsers into thinking a post is`
			`readable, but this is unreliable. In general, if reader mode`
			`is broken you just need to make your post a little longer.`
			`</main>`
			`</body>`
			`</html>`