- Compatible XF Versions
- 2.0, 2.1, 2.2
- Visible Branding
- No
- Additional Requirements
-
For 2.1+ versions:
• XenForo 2.1
• PHP 7 +
Description
This addon makes code bbcode and code editor way more functional by adding copy, expand, collapse buttons, resizer bar and automatically adjusting the colors to fit chosen forum style.
Features
Custom title and lines highlighting
You can now specify a custom code block header title. For example, users can provide a filename for code blocks instead of writing it in the text or putting the whole code block inside a spoiler with filename title.
Moreover, you can even highlight certain lines!
Custom title and lines to be highlighted can be set via "Insert code" dialog:
You can also set the title and lines to highlight directly in text editor by adding title="..." and highlight="..." parameters in code bbcode.
Example:
[code lang="php" title="My Custom Title"]<? .... ?>[/code]
will produce this codeblock: Hovering custom title will show the code language:
Example of highlighting:
[code lang="php" highlight="2, 5-8"]a log of code...[/code]
Expand/Collapse buttons
Expand button smoothly increasing the height of code block until all the code is showing. It is visible only when code block height is LESS than the actual code size.
Collapse button smoothly decreasing the height of code block to it's default height which you can set in style properties. It is visible only when code block height is LARGER than default code block height.
Both expand and collapse buttons are visible when code block height is within min and max limits and invisible on code blocks that are smaller than default code block height.
The default height of code block can be set in style properties ("Code" section below "Messages"):
Copy button
Copy button simply copy the code right into your clipboard:
Line numbers
All code blocks have line numbers (up to 1000 lines). Line numbers can be turned off via style properties:
Resizer
Every code block which code height is larger than the default height has a resizer bar. It allows users to vertically resize code block:
Common languages
I always thought there is something wrong about "Common languages". Why can't we set which languages are "common" to our specific forum? Weird...
With Code addon you can now set common languages right after "Allowed code languages" option in "Messages" option-group:
Hurray!
Default language
You can also set a default language code for "Insert code" dialog via "Default code language" option after common languages in "Messages" option-group:
Custom code block CSS class
There is an option to add a custom CSS class for code block. Just specify
class="..."
BB code attribute for that. Now you can style code blocks with this class. Here is an example: Installation
- Download the addon
- Upload contents of
upload
folder to your forum root - In admin control panel go to "Addons" section and install Code
WARNING: after unistalling all code blocks with custom titles/highlighting/class will not be rendered as code blocks!
- Uninstall the addon from ACP
- Go to forum root folder and remove
js/CMTV/Code
folder.