====== codeprism Plugin ====== ---- plugin ---- description: Provide nice syntax highlighting using Prism.js author : siyuanliu email : siyuanl96@gmail.com type : syntax, action lastupdate : 2023-12-03 compatible : Jack Jackrum depends : conflicts : similar : dokuprism, codify tags : code, prismjs, syntaxhighlight downloadurl: https://github.com/siyuanl96/dokuwiki-plugin-codeprism/archive/refs/tags/v1.0.tar.gz bugtracker : https://github.com/siyuanl96/dokuwiki-plugin-codeprism/issues sourcerepo : https://github.com/siyuanl96/dokuwiki-plugin-codeprism/ donationurl: screenshot_img : ---- ===== Installation ===== Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually. ===== Examples / Usage ===== === Syntax highlight === {{https://raw.githubusercontent.com/siyuanl96/dokuwiki-issue/main/codeprism/codeprism-demo.png?400x200&recache}} === Command line === {{https://raw.githubusercontent.com/siyuanl96/dokuwiki-issue/main/codeprism/codeprism-cmdline.png?400x200&recache}} === CSS preview === {{https://raw.githubusercontent.com/siyuanl96/dokuwiki-issue/main/codeprism/codeprism-previewer.png?400x200&recache}} You can also watch demos at [[https://wiki.pushmindstack.com/tools/dokuwiki/codeprism|here]]. ===== Syntax ===== Codeprismsupports two syntax: * **%%<%%codeprism** //attributes//**%%>%%**Your code...%%<%%**/codeprism**%%>%% * **%%<%%fileprism** //attributes// **/%%>%%** Table 1 and Table 2 list the attributes supported by the above syntax. ^ Table 1. Attributes supported by %%<%%codeprism%%>%% |||| ^ Key ^ Description ^ Value ^ Example ^ | ''title'' | Specify code title | A string without spaces. | ''title=codeprism.css'' | | ''el'' | Enable line numbers | ''true'', ''false''. | ''el=true'' | | ''sl'' | Start line number | One number. | ''sl=10'' | | ''hl'' | Highlight line numbers | One number or multiple numbers with '','' or ''-'' (''-'' indicates range). | ''hl=1,3,4-9'' | | ''lang'' | Language | See [[https://prismjs.com/index.html#supported-languages|this page]]. | ''lang=php'' | | ''cmd'' | Command line style | ''true''. (If ''cmdout'' is set, ''cmd'' is set to ''true'' by default.) | ''cmd=true'' | | ''cmdout'' | Command output line numbers | One number or multiple numbers with '','' or ''-'' (''-'' indicates range). | ''cmdout=2,4,6-9'' | | ''css'' | Assign a custom CSS to the code block | Default is ''dft''. You can create a CSS named ''pre.dokuwiki-plugin-codeprism-**custom**'' ((''custom'' is any word you like to use)) in [[devel:css#user_styles|conf/userstyle.css]] and use it by ''css=custom''. | ''css=custom'' | | ''user'' | Specify the user name at the command shell prompt | A string without spaces. (If the ''user'' is not specified, the default user name configured in the **Configuration Settings** is used. You can also use ''user'' to re-specify a new user name.) | ''user=Source'' | | ''host'' | Specify the host name at the command shell prompt | A string without spaces. (If the ''host'' is not specified, the default host name configured in the **Configuration Settings** is used. You can also use ''host'' to re-specify a new host name.) | ''host=Debian'' | ^ Table 2. Attributes supported by %%<%%fileprism%%>%% |||| ^ Key ^ Description ^ Value ^ Example ^ | ''src'' | Specifies file path | File path. | ''src=:media:code:test.py'' | | ''range'' | Specifies the lines to be displayed in the file | ''n'' for display line n.\\ ''n,'' for display all lines start at n.\\ ''m,n'' for display line m to line n. | ''range=4''\\ ''range=4,''\\ ''range=4,20'' | | ''hl'' | See ''hl'' in ''codeprism'' | | | | ''el'' | See ''el'' in ''codeprism'' | | | | ''css'' | See ''css'' in ''codeprism'' | | | | ''title'' | See ''title'' in ''codeprism'' | | | ===== Configuration and Settings ===== ^ Setting ^ Description ^ | theme | Specify Codeprism theme. | | cdn | Specify a CDN which provide PrismJS. | | custom-cdn | Specify the CDN yourself if the CDNs listed in the setting ''cdn'' does not meet your needs. | | override-code | **True** to override ''code'' syntax. | | show-invis | **True** to show hidden characters such as tabs and line breaks. | | hl-brace | **True** to highlight brace pairs when the cursor hovers over one of the braces. | | previewer | **True** to enable preview angle, color, gradient, easing, and time. | | user | Specify the default user name at the command shell prompt when using command line style((Using ''cmd'' or ''cmdout'' attribute.)). | | host | Specify the default host name at the command shell prompt when using command line style((Using ''cmd'' or ''cmdout'' attribute.)). | ===== Development ===== The source code of the plugin is available at GitHub: https://github.com/siyuanl96/dokuwiki-plugin-codeprism. === Changelog === {{rss>https://github.com/siyuanl96/dokuwiki-plugin-codeprism/commits/main.atom date 8}} === Known Bugs and Issues === N/A === ToDo/Wish List === N/A ===== FAQ ===== N/A