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

File highlight+data range #1813

Merged
merged 7 commits into from Oct 4, 2021
Merged

File highlight+data range #1813

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d18aa28
add data-range to file-highlight
Mar 15, 2019
8787048
Add data-range to file-highlight
Mar 16, 2019
e29cb05
gulp?
Mar 16, 2019
d305fca
gulp?
Mar 16, 2019
c759e49
Improvements (#1)
RunDevelopment Mar 16, 2019
2514f76
Merge branch 'master' into a-fh
RunDevelopment Oct 4, 2021
2197d14
Removed unused variable
RunDevelopment Oct 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
135 changes: 85 additions & 50 deletions plugins/file-highlight/index.html
View file
Open in desktop
@@ -1,75 +1,110 @@
<!DOCTYPE html>
<html lang="en">

<head>

<meta charset="utf-8" />
<link rel="icon" href="favicon.png" />
<title>File Highlight ▲ Prism plugins</title>
<base href="../.." />
<link rel="stylesheet" href="style.css" />
<link rel="stylesheet" href="themes/prism.css" data-noprefix />
<link rel="stylesheet" href="plugins/toolbar/prism-toolbar.css" data-noprefix />
<script src="scripts/prefixfree.min.js"></script>

<script>var _gaq = [['_setAccount', 'UA-33746269-1'], ['_trackPageview']];</script>
<script src="https://www.google-analytics.com/ga.js" async></script>
<meta charset="utf-8" />
<link rel="icon" href="favicon.png" />
<title>File Highlight ▲ Prism plugins</title>
<base href="../.." />
<link rel="stylesheet" href="style.css" />
<link rel="stylesheet" href="themes/prism.css" data-noprefix />
<link rel="stylesheet" href="plugins/toolbar/prism-toolbar.css" data-noprefix />
<link rel="stylesheet" href="plugins/line-numbers/prism-line-numbers.css" data-noprefix />

<script src="scripts/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>

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

<h2>File Highlight</h2>
<p>Fetch external files and highlight them with Prism. Used on the Prism website itself.</p>
</header>

<h2>File Highlight</h2>
<p>Fetch external files and highlight them with Prism. Used on the Prism website itself.</p>
</header>
<section class="language-markup">
<h1>How to use</h1>

<section class="language-markup">
<h1>How to use</h1>
<p>Use the <code>data-src</code> attribute on empty <code>&lt;pre></code> elements, like so:</p>

<p>Use the <code>data-src</code> attribute on empty <code>&lt;pre></code> elements, like so:</p>
<pre><code>&lt;pre data-src="myfile.js">&lt;/pre></code></pre>

<pre><code>&lt;pre data-src="myfile.js">&lt;/pre></code></pre>
<p>
You don’t need to specify the language, it’s automatically determined by the file extension.
If, however, the language cannot be determined from the file extension or the file extension is incorrect, you may
specify a language as well (with the usual class name way).
</p>

<p>You don’t need to specify the language, it’s automatically determined by the file extension.
If, however, the language cannot be determined from the file extension or the file extension is incorrect, you may specify a language as well (with the usual class name way).</p>
<p>
Use the <code>data-range</code> attribute to display only a selected range of lines
from the file, like so:
</p>

<p>Please note that the files are fetched with XMLHttpRequest. This means that if the file is on a different origin, fetching it will fail, unless CORS is enabled on that website.</p>
<pre><code>&lt;pre data-src="myfile.js" data-range="1,5">&lt;/pre></code></pre>

<p>
When used in conjunction with the <a href="plugins/toolbar">Toolbar plugin</a>, this plugin can also display a button to download the file.
To use it, add a <code>data-download-link</code> attribute on the <code>&lt;pre></code> element.<br />
Optionally, the text can also be customized by using a <code>data-download-link-label</code> attribute.
</p>
<pre><code>&lt;pre data-src="myfile.js" data-download-link data-download-link-label="Download this file">&lt;/pre></code></pre>
</section>
<p>
Lines start at 1, so <code>"1,5"</code> will display line 1 up to and including line 5. It's also possible to specify just a single line (e.g. <code>"5"</code> for just line 5) and open ranges (e.g. <code>"3,"</code> for all lines starting at line 3). Negative integers can be used to specify the n-th last line, e.g. -2 for the second last line.
</p>
<p>
When <code>data-range</code> is used in conjunction with the <a href="plugins/line-numbers">Line Numbers plugin</a>,
this plugin will add the proper <code>data-start</code> according to the specified range.
This behavior can be overridden by setting the <code>data-start</code> attribute manually.
</p>

<section>
<h1>Examples</h1>
<p>
Please note that the files are fetched with XMLHttpRequest. This means that if the file is on a different origin,
fetching it will fail, unless CORS is enabled on that website.
</p>

<p>The plugin’s JS code:</p>
<pre data-src="plugins/file-highlight/prism-file-highlight.js"></pre>
<p>
When used in conjunction with the <a href="plugins/toolbar">Toolbar plugin</a>, this plugin can also display a
button to download the file.
To use it, add a <code>data-download-link</code> attribute on the <code>&lt;pre></code> element.<br />
Optionally, the text can also be customized by using a <code>data-download-link-label</code> attribute.
</p>
<pre><code>&lt;pre data-src="myfile.js" data-download-link data-download-link-label="Download this file">&lt;/pre></code></pre>
</section>

<p>This page:</p>
<pre data-src="plugins/file-highlight/index.html"></pre>
<section>
<h1>Examples</h1>

<p>File that doesn’t exist:</p>
<pre data-src="foobar.js"></pre>
<p>The plugin’s JS code:</p>
<pre data-src="plugins/file-highlight/prism-file-highlight.js"></pre>

<p>With a download button:</p>
<pre data-src="plugins/file-highlight/prism-file-highlight.js" data-download-link data-download-link-label="Download this file"></pre>
<p>This page (first 15 lines using data-range):</p>
<pre data-src="plugins/file-highlight/index.html" data-range="1,15"></pre>

<p>For more examples, browse around the Prism website. Most large code samples are actually files fetched with this plugin.</p>
</section>
<p>File that doesn’t exist:</p>
<pre data-src="foobar.js"></pre>

<footer data-src="templates/footer.html" data-type="text/html"></footer>
<p>With a download button, line-numbers, and data-range="29,62" :</p>
<pre data-src="plugins/file-highlight/prism-file-highlight.js" data-range="29,62" class="line-numbers"
data-download-link data-download-link-label="Download this file"></pre>

<script src="prism.js"></script>
<!-- The File Highlight plugin is already included into Prism.js build -->
<script src="plugins/toolbar/prism-toolbar.js"></script>
<script src="scripts/utopia.js"></script>
<script src="components.js"></script>
<script src="scripts/code.js"></script>
<p>For more examples, browse around the Prism website. Most large code samples are actually files fetched with this plugin.</p>
</section>

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

<script src="prism.js"></script>
<!-- The File Highlight plugin is already included into Prism.js build -->
<script src="plugins/toolbar/prism-toolbar.js"></script>
<script src="plugins/line-numbers/prism-line-numbers.js"></script>
<script src="scripts/utopia.js"></script>
<script src="components.js"></script>
<script src="scripts/code.js"></script>


</body>
</html>

</html>