Description
This plugin displays the content of a file in a post. The content of the file
(called a “snippet”) is put in a <pre></pre> block by default.
It has the following advantages over pasting the content of the file in your post
yourself:
- When the file is modified, no need to modify the posts referring to it
- Indentation is preserved by default (useful to show code snippets)
- Can optionally provide a link to the file (no need to copy-paste your snippet)
If requested (see the preserveformat parameter), the content of the file
is put in a <div></div> block, with each line (delimited by
the carriage return) in its own <p></p> block.
Usage
Syntax: [file lang="some_lang" start="a_line_number" end="a_line_number" link="on_or_off" style="some_style_properties" preserveformat="on_or_off"]path/to/your/file[/file]
Note: The order of the attributes is mandatory!
Example: Inlining of a file
In your post, write [file]path/to/your/file[/file]. That’s it!
Example: Using a syntax highlighter plugin
If you write [file lang="cpp"]path/to/your/file[/file] (for instance),
and if the syntax highlighter plugin you use supports
the <pre lang="*"></pre> syntax (most does), then the content
of your file will be processed by the syntax highlighter plugin as usual.
Example: Provide a link to the file
If you write [file link="on"]path/to/your/file[/file], a link will
be automatically added to the top left of the text area.
Example: Inline a subset of a file
If you write [file start="10" end="20"]path/to/your/file[/file],
only the lines 10 to 20 of the file will be displayed. You can omit the start
(ie. “from beginning to line 20”) or the end (ie. “from line 10 to the end of
the file”) if you want.
Example: Set the color of the text to red
In your post, write [file style="color: #FF0000;"]path/to/your/file[/file].
Example: Prevent the plugin to process a [file][/file] block
Just write [file off]your content[/file].
Note: The ‘off’ attribute must come BEFORE any other ones.