mick2nd / code-section

Joplin plugin to render a section of a source file as code

Code Section Joplin Plug-in

This plug-in displays a piece of source code. It reads this source code from a source file which is appended to the note. The code is selected by supporting a code definition inside a code definition block.

The code definition looks as follows:

```codesection
{
"lang": "python",
"src": "CODE-SOURCE-APPENDIX",
"begin": 1,
"end": 50,
"expandTabs": true,
"tabSize": 4,
"lineNumbers": false
}
```

Several entries can be omitted and will be replaced by their defaults. The source language and the source itself are mandatory.

The inserted code will be displayed using the default renderer for that language including syntax highlighting.

This could look like this:

Procedure

1. Append a code source to the note
2. Immediately following it add a codesection describing the code to be displayed
3. The description has the shape of a JSON string
4. The "src" attribute identifies the code source (its id followed by extension)
5. Alternatively you could copy and paste the code insertion into the quotes of src

Problems

1. The resource folder is not recognized after the start of Joplin. Workaround: Invoke the settings and then leave them
2. Only local sources in the resource folder can be displayed, no web content
3. The plug-in uses synchronous file access to read the source, no asynchronous access

Release Notes

1.0.7

• Update of the Joplin API
• Bug-fix: plug-in did not work without extension of the code file or with more than one dot in the file name

1.0.6

• Changed architecture of the plug-in
• Code Sections are printed now with export to pdf

1.0.5

• Added a context menu command to insert a template of a code section
• Added a few properties to the code section description:
  • scale: a scale factor in percent as 80% or absolute font size
  • spacing: the line spacing, default is 130% of the font size
  • height: the height of the code section window, may be "auto", "fill", a value in pixels ("400px") or a factor in percent relating to the window height

1.0.4

• Fixed the bug where resource folder was not recognized. Workaround is no longer needed (see Problems 1.).

code-section's Issues

typo in the readme

Nice plugin.

The example codesection code block in the readme.md has an typo.
The last comma throws the error

"SyntaxError: Expected double-quoted property name in JSON at position ###"

Fix:

"lineNumbers": false,
should be
"lineNumbers": false