Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document standard tokens and provide examples #3104

Merged
merged 20 commits into from
Oct 21, 2021
Merged

Document standard tokens and provide examples #3104

Changes from 7 commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
b661fc9
Document standard tokens
hoonweiting Oct 3, 2021
cf1e850
Apply suggestions from code review
hoonweiting Oct 3, 2021
d6c3483
Collapse inserted/deleted and attr-name/attr-value pairs
hoonweiting Oct 3, 2021
2b593f7
Improve definitions for builtin and punctuation
hoonweiting Oct 3, 2021
4fcd969
Reduce number of numbers examples
hoonweiting Oct 3, 2021
1d44f70
Add more examples
hoonweiting Oct 4, 2021
fe59d12
Edit introductory blurb
hoonweiting Oct 4, 2021
5bad862
Apply suggestions from code review
hoonweiting Oct 4, 2021
c8035a8
Add missing `</code>` tag
hoonweiting Oct 4, 2021
871ce64
Made the token list a table
RunDevelopment Oct 4, 2021
8615c44
Make the token list a table (#1)
hoonweiting Oct 5, 2021
08c4e46
Move non-standard tokens blurb into a section of its own
hoonweiting Oct 5, 2021
0ad11a2
Match table cell padding with that in extending.html
hoonweiting Oct 5, 2021
483d267
Change "Prism" to "Prism's themes" in the embedded languages section
hoonweiting Oct 5, 2021
d47f0a5
Provide example for non-standard tokens
hoonweiting Oct 5, 2021
ca765be
Remove link to non-existent Show Language CSS file
hoonweiting Oct 7, 2021
ae645ed
Merge branch 'master' into 2849-token-type-docs
hoonweiting Oct 21, 2021
6ac2537
Remove blank line at the start of the code block
hoonweiting Oct 21, 2021
f0846dd
Add `language-none` class to `body` tag
hoonweiting Oct 21, 2021
a27a11c
Add links to `tokens.html`
hoonweiting Oct 21, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
335 changes: 335 additions & 0 deletions tokens.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,335 @@
<!DOCTYPE html>
<html lang="en">
<head>

<meta charset="utf-8" />
<link rel="icon" href="assets/favicon.png" />
<title>Prism tokens ▲ Prism</title>
<link rel="stylesheet" href="assets/style.css" />
<link rel="stylesheet" href="themes/prism.css" data-noprefix />
<link rel="stylesheet" href="plugins/line-highlight/prism-line-highlight.css" data-noprefix />
<link rel="stylesheet" href="plugins/toolbar/prism-toolbar.css" data-noprefix />
<link rel="stylesheet" href="plugins/show-language/prism-show-language.css" data-noprefix />
<script src="assets/vendor/prefixfree.min.js"></script>

<script>var _gaq = [['_setAccount', 'UA-33746269-1'], ['_trackPageview']];</script>
<script src="https://www.google-analytics.com/ga.js" async></script>
</head>
<body class="language-none">

<header>
<div class="intro" data-src="assets/templates/header-main.html" data-type="text/html"></div>

<h2>Prism tokens</h2>
<p>Prism identifies tokens in your code, which are in turn styled by CSS to produce the syntax highlighting. This page provides an overview of the standard tokens and corresponding examples.</p>
</header>

<section id="standard-tokens">
<h1>Standard tokens</h1>

<p>When defining a new language, you will need to provide token names for each 'type' of code, such as keywords and operators, so Prism can highlight code accordingly. It is recommended to make use of the following standard tokens to ensure that highlight code will be highlighted, as Prism's themes (both official and non-official) only guarantee coverage for these standard tokens.</p>
hoonweiting marked this conversation as resolved.
Show resolved Hide resolved

<p>Sometimes, a language might use a particular name to refer to certain pieces of code, but which is not one of Prism's standard token names, such as <code>function-defintion</code>. Since <code>function-definition</code> is not a standard token, you might want to alias it with a standard token such as <code>function</code>, which is semantically similar in meaning, and will ensure that Prism's themes will highlight it.</p>
RunDevelopment marked this conversation as resolved.
Show resolved Hide resolved

<dl>
RunDevelopment marked this conversation as resolved.
Show resolved Hide resolved
<dt><code>keyword</code></dt>
<dd>Pre-defined and reserved words.
<pre><code class="language-javascript">for (const foo of bar) {
console.log(foo);
if (foo === 'foobar') {
break;
}
}</code></pre>
<pre><code class="language-bash">if [ -d $directory ]; then
echo "Directory exists"
else
echo "Directory does not exists"
fi</code></pre></dd>

<dt><code>builtin</code></dt>
<dd>Functions/Methods/Classes/Types that are available out of the box.
<pre><code class="language-python">pi = round(float('3.14159'), 2)</code></pre>
<pre><code class="language-typescript">interface SearchFunc {
(source: string, subString: string): boolean;
}</code></pre></dd>

<dt><code>class-name</code></dt>
<dd>The name of a class, interface, trait, or type.
<pre><code class="language-javascript">class Rectangle extends Square {
constructor(length, breadth) {
super(length);
this.breadth = breadth;
}
}</code></pre>
<pre><code class="language-csharp">public class CameraController : MonoBehaviour
{
// TODO: Control camera
}</code></pre></dd>

<dt><code>function</code></dt>
<dd>The name of a function or method.
<pre><code class="language-javascript">function isEven(number) {
return Number(number) % 2 === 0;
}

function isOdd(number) {
return !isEven(number);
}</code></pre></dd>

<dt><code>boolean</code></dt>
<dd>True and false, and pairs with similar concepts (e.g. yes and no).
<pre><code class="language-javascript">console.log(true === false); // prints false
console.log(true === !false); // prints true</code></pre></dd>

<dt><code>number</code></dt>
<dd>A numerical value, regardless of base and order, and no matter real or imaginary.
<pre><code class="language-python">3.14159
42
0xdeadbeef
1e100
.001j</code></pre></dd>

<dt><code>string</code></dt>
<dd>Literal text, including numbers and symbols and maybe even more special characters.
<pre><code class="language-javascript">let greeting = 'Hello World!';</code></pre></dd>

<dt><code>char</code></dt>
<dd>A string that can comprise only a single character, enforced by the language.
<pre><code class="language-elm">'A'
'z'
'0'
'-'
'\t'
'\u{2728}'</code></pre></dd>

<dt><code>symbol</code></dt>
<dd>A primitive data type found in some languages, can be thought of as an identifier.
<pre><code class="language-smalltalk">#myFirstSymbol "#myFirstSymbol is a symbol in Smalltalk and is the same object as all other #myFirstSymbol symbols"</code></pre></dd>

<dt><code>regex</code></dt>
<dd>A regular expression.
<pre><code class="language-javascript">let regexPattern = /((?:^|[^$\w\xA0-\uFFFF."'\])\s]|\b(?:return|yield))\s*)\/(?:\[(?:[^\]\\\r\n]|\\.)*\]|\\.|[^/\\\[\r\n])+\/[dgimyus]{0,7}(?=(?:\s|\/\*(?:[^*]|\*(?!\/))*\*\/)*(?:$|[\r\n,.;:})\]]|\/\/))/;</code></pre></dd>

<dt><code>url</code></dt>
<dd>A link to another page or resource.
<pre><code class="language-css">body {
background: url(foo.png);
}</code></pre>
<pre><code class="language-markdown">[Prism](https://prismjs.com) is a cool syntax highlighter.</code></pre></dd>

<dt><code>operator</code></dt>
<dd>A symbol that represents an action or process, whether it's a mathematical operation, logical operation, and so on.
<pre><code class="language-javascript">x = y
x *= y
x !== y
x++
-y
x &gt;&gt;&gt; y
x || y
z ? x : y</code></pre></dd>

<dt><code>variable</code></dt>
<dd>The name of a variable. This token is intended to be used sparingly. It's generally used on special variables (e.g. Less or Bash), not general variables from imperative and procedural programming languages (e.g. C, JavaScript, Python).
<pre><code class="language-less">@nice-blue: #5B83AD;
@light-blue: lighten(@nice-blue, 20%);</code></pre>
<pre><code class="language-bash">echo $STRING
args=("$@")
echo ${args[0]} ${args[1]} ${args[2]}</code></pre></dd>

<dt><code>constant</code></dt>
<dd>The name of a constant.
<pre><code class="language-javascript">const PI = 3.14159;</code></pre>
<pre><code class="language-rust">const THING: u32 = 0xABAD1DEA;</code></pre>
<pre><code class="language-c">fprintf( stdout, "hello world\n" );</code></pre></dd>

<dt><code>property</code></dt>
<dd>An attribute/characteristic or object/map key.
<pre><code class="language-css">body {
color: red;
line-height: normal;
}</code></pre>
<pre><code class="language-json">{
"data": {
"labels": ["foo", "bar"],
},
"error": null,
"status": "Ok"
}</code></pre></dd>

<dt><code>punctuation</code></dt>
<dd>Punctuation such as brackets, parentheses, commas, and more.
<pre><code class="language-python">def median(pool):
'''Statistical median to demonstrate doctest.
>>> median([2, 9, 9, 7, 9, 2, 4, 5, 8])
7
'''
copy = sorted(pool)
size = len(copy)
if size % 2 == 1:
return copy[(size - 1) / 2]
else:
return (copy[size/2 - 1] + copy[size/2]) / 2</code></pre></dd>

<dt><code>important</code></dt>
<dd>Anything that is important and needs special highlighting.
<pre><code class="language-css">body {
color: red !important;
}</code></pre>
<pre><code class="language-markdown"># This is a heading. Headings are important.</code></pre></dd>

<dt><code>comment</code></dt>
<dd>Code comments.
<pre><code class="language-markup">&lt;!-- Here's a comment --&gt;
&lt;style&gt;
/* Here's another comment */
&lt;/style&gt;
&lt;script&gt;
// Here's yet another comment
&lt;/script&gt;</code></pre></dd>

<dt><code>inserted</code> and <code>deleted</code></dt>
<dd>Added or modified line and deleted line respectively, mainly for diffs. In general, also the idea of something being increased and decreased/removed respectively.
<pre><code class="language-diff">--- qcli.yml 2014-12-16 11:43:41.000000000 +0800
+++ /Users/uranusjr/Desktop/qcli.yml 2014-12-31 11:28:08.000000000 +0800
@@ -4,5 +4,5 @@
project:
sources: "src/*.cpp"
headers: "src/*.h"
- qt: core
+ qt: core gui
public_headers: "src/*.h"</code></pre></dd>

<dt><code>bold</code></dt>
<dd>Bolded text. Mostly found in document-markup languages.
<pre><code class="language-markdown">**I am bolded text!**</code></pre></dd>

<dt><code>italic</code></dt>
<dd>Italicised text. Mostly found in document-markup languages.
<pre><code class="language-markdown">*I am italicised text!*</code></pre></dd>

<dt><code>tag</code></dt>
<dd>A markup tag (e.g. HTML and XML tags).
<pre><code class="language-markup">&lt;p&gt;Hello World!&lt;/p&gt;</code></pre></dd>

<dt><code>attr-name</code> and <code>attr-value</code></dt>
<dd>Kind of like a property of a markup tag and its value/argument respectively.
<pre><code class="language-markup">&lt;p id="greeting"&gt;Hello World!&lt;/p&gt;
&lt;video width="1280" height="720" allowfullscreen controls&gt;
&lt;source src="hello_world.mp4" type="video/mp4" /&gt;
&lt;/video&gt;</code></pre></dd>

<dt><code>namespace</code></dt>
<dd>Used to provide uniquely named elements and attributes in XML documents. Outside of markup languages, it is used to tokenize the package/namespace part of identifiers.
<pre><code class="language-markup">&lt;html:p foo:bar="baz" foo:weee&gt;&lt;/html:p&gt;</code></pre>
<pre><code class="language-csharp">namespace Foo.Bar {}
using Foo.Bar;</code></pre>
<pre><code class="language-java">class Foo extends foo.bar.Foo {
java.util.List<foo.bar.Foo.Bar> bar(foo.bar.Baz bat) throws java.lang.IOException {
hoonweiting marked this conversation as resolved.
Show resolved Hide resolved
throw new java.lang.UnsupportedOperationException("Not implemented");
}
}</code></pre>
<pre><code class="language-rust">use std::collections::HashMap;
use std::fmt;
use std::iter;
use std::result;
use std::sync::Arc;

use regex_syntax::hir::{self, Hir};
use regex_syntax::is_word_byte;
use regex_syntax::utf8::{Utf8Range, Utf8Sequence, Utf8Sequences};

use crate::prog::{
EmptyLook, Inst, InstBytes, InstChar, InstEmptyLook, InstPtr, InstRanges,
InstSave, InstSplit, Program,
};

use crate::Error;

type Result = result::Result<Patch, Error>;
type ResultOrEmpty = result::Result<Option<Patch>, Error>;</code></pre></dd>
hoonweiting marked this conversation as resolved.
Show resolved Hide resolved

<dt><code>prolog</code></dt>
<dd>The first part of an XML document.
<pre><code class="language-markup">&lt;?xml version="1.0" encoding="utf-8"?&gt;
&lt;svg&gt;&lt;/svg&gt;</code></pre></dd>

<dt><code>doctype</code></dt>
<dd>Document type declaration, specific to markup languages.
<pre><code class="language-markup">&lt;!DOCTYPE html&gt;
&lt;html&gt;&lt;/html&gt;</code></pre></dd>

<dt><code>cdata</code></dt>
<dd>Character data, specific to markup languages.
<pre><code class="language-markup">&lt;ns1:description&gt;&lt;![CDATA[
CDATA is &lt;not&gt; magical.
]]>&lt;/ns1:description&gt;</code></pre></dd>

<dt><code>entity</code></dt>
<dd>Code used to display reserved characters in markup languages.
<pre><code class="language-markup">&amp;amp; &amp;#x2665; &amp;#160; &amp;#x152;</code></pre></dd>

<dt><code>atrule</code></dt>
<dd>Literally <code>@</code> rules (statements) in stylesheets.
<pre><code class="language-css">@font-family {
font-family: Questrial;
src: url(questrial.otf);
}

@media screen and (min-width: 768px) {
/* rules here */
}</code></pre></dd>

<dt><code>selector</code></dt>
<dd>Code that identifies or picks something out of a group to operate on, such as the names of HTML elements in stylesheets.
<pre><code class="language-css">section h1,
#features li strong,
header h2,
footer p {
/* styles here */
}</code></pre></dd>
</dl>
</section>

<section id="embedded-languages">
<h1>Embedded languages</h1>

<p>In addition to the standard tokens above, Prism also has a token for languages that are embedded in another language, such as CSS in HTML, JS in HTML, Bash in Shell-session, and CSS in JS, allowing Prism to highlight the tokens in the embedded languages more accurately. All embedded languages are wrapped in their own special token, which includes a CSS class <code>language-xxxx</code> corresponding to the embedded language.</p>

<p>Open your browser's developer tools and check out the example below to see it in action!</p>

<pre data-line="6-10,14-18"><code class="language-markup">&lt;!DOCTYPE html&gt;
&lt;html lang="en"&gt;
&lt;head&gt;
&lt;meta charset="utf-8" /&gt;
&lt;title>I can haz embedded CSS and JS&lt;/title&gt;
&lt;style&gt;
@media print {
p { color: red !important; }
}
&lt;/style&gt;
&lt;/head&gt;
&lt;body&gt;
&lt;h1&gt;I can haz embedded CSS and JS&lt;/h1&gt;
&lt;script&gt;
if (true) {
console.log('foo');
}
&lt;/script&gt;

&lt;/body&gt;
&lt;/html&gt;</code></pre>
</section>

<footer data-src="assets/templates/footer.html" data-type="text/html"></footer>

<script src="assets/vendor/utopia.js"></script>
<script src="prism.js"></script>
<script src="plugins/autoloader/prism-autoloader.js"></script>
<script src="plugins/line-highlight/prism-line-highlight.js"></script>
<script src="plugins/toolbar/prism-toolbar.js"></script>
<script src="plugins/show-language/prism-show-language.js"></script>
<script src="components.js"></script>
<script src="assets/code.js"></script>

</body>
</html>