AvalonDocumentationEngine/views/articles/Searching.ejs
2023-01-05 18:17:51 -06:00

35 lines
No EOL
2 KiB
Text

<p>Searching in the Avalon Documentation Engine is possible.</p>
<p>Use the searchbar element on the top-left to type text in and look for articles using a filter.</p>
<h1>Search methods</h1>
<h2>Searching by name</h2>
<p>This is the default behaviour, typing in a name, and getting your result.</p>
<p>Simply type <code>QUERY</code> (replace "QUERY" with your desired search) into the searchbar.</p>
<h2>Searching by tag</h2>
<p>Searching for articles using their tag is also very easy.</p>
<p>Simply wrap your tag name search in parentheses, like this: <code>(QUERY)</code></p>
<p>There are two ways to search for a tag name:</p>
<ul>
<li>Short name (e.g. <code>//</code> for Meta)</li>
<li>Full name (found by hovering over tag)</li>
</ul>
<h2>Searching for redirects</h2>
<p>Searching for redirects is enabled by default when searching, but there's another mode where you can search for redirects only.</p>
<p>Make your search a &gt;&gt;, like this: <code>&gt;&gt;</code></p>
<p>Use two greater than symbols (>) to write the entire thing.</p>
<p>If you want to search for redirects that lead to a specific page, you can type <code>&gt;&gt; QUERY</code>, adding an article page (not tag) at the very end.</p>
<h1>Shortcuts (Longcuts?)</h1>
<h2>Tagged</h2>
<code>Tagged QUERY</code>
<code>(QUERY</code>
<h2>Redirects</h2>
<code>Redirects QUERY</code>
<code>Redirects to QUERY</code>
<code>&gt;&gt; to QUERY</code>
<h2>Preventing shortcut corrections</h2>
<p>Preventing corrections is easy, simply put a <code>\</code> anywhere within your query to cancel a redirect.</p>
<p>For example, if the article you want to look for is called "Redirects and Tags", the <code>Redirects QUERY</code> shortcut would not let you type <code>Redirects </code>.</code></p>
<p>So, you can simply cancel the shortcut by placing a <code>\</code> anywhere it would block a shortcut - usally at the start or in the middle of the word.</p>
<code>\Redirects </code>
<code>\(</code>
<code>\Redirects to</code>
<code>\Tagged</code>