Forum Posts Feed
Using Outliner for Software Development Documentation?
< Next Topic | Back to topic list | Previous Topic >
Posted by Paul Korm
Apr 18, 2016 at 05:24 PM
Might be possible—what are you using as your source code editor?
Lothar Scholz wrote:
Thanks, yes something like Quiver looks nice.
>Wish only i could mark some points and ranges in source code and refer
>to them.
>
>
Posted by Lothar Scholz
Apr 21, 2016 at 03:32 AM
> Paul Korm wrote:
> Might be possible—what are you using as your source code editor?
I’m using a few. What i would need is some scripting features to add it.
I find it remarkable that so many outlines still do not offer any extension mechanism.
Posted by shatteredmindofbob
Apr 21, 2016 at 03:59 AM
Lothar Scholz wrote:
>
>> Paul Korm wrote:
>> Might be possible—what are you using as your source code editor?
>
>I’m using a few. What i would need is some scripting features to add it.
>I find it remarkable that so many outlines still do not offer any
>extension mechanism.
Is Emacs among them by any chance? You might find what you’re looking for with Org-Mode and an extension called Org-Babel.
Though, not really being a programmer, I can’t offer much else. http://orgmode.org/worg/org-contrib/babel/
Posted by Marbux
Apr 21, 2016 at 09:41 PM
Lothar Scholz wrote:
>
>> Paul Korm wrote:
>> Might be possible—what are you using as your source code editor?
>
>I’m using a few. What i would need is some scripting features to add it.
>I find it remarkable that so many outlines still do not offer any
>extension mechanism.
NoteCase Pro might be what you are looking for, perhaps in companionship with the Geany text editor/IDE. Both support the same range of operating systems, both support UTF-8 Unicode, and both are extensible with Lua, Geany with Lua 5.1 and NC Pro with Lua 5.3.x. Both provide programmable graphical user interfaces for scripts. For an as-yet unpublished article I’ve been working up a list of NoteCase Pro features enable using it as its own IDE. Here’s what I’ve put together so far:
Since I can’t find the old list, here we go on a new list of NC Pro features/scripts that enable the program to serve as its own IDE. Eventually to be expanded to a Help file section and as a resource for writing an article.
Feedback is welcome. If you add any, I’ll try to keep them collected in this top note as a list.
* Integrated Lua scripting engine.
* As of 21 April 2016, 357 API methods exported to Lua; one enables execution of 158 user actions.
* Three embedded programming libraries, one adds UTF-8 support for Lua, one adds HTTP networking commands, one adds cross-platform file system commands.
* Line numbering, with associated API methods.
* Go To Line.
* Source language highlighting for 64 source languages, with associated API methods.
* Scripts can be plain text files, embedded in NoteCase Pro documents, or embedded in a NoteCase Pro plugin (a specially formatted NoteCase Pro document).
* Scripts can be launched manually by selection, by assignment to event trigger, by assignment to shortcut or toolbar icon, by script-launcher menu, by other scripts, by typing an abbreviation, or by command-line argument.
* Unlimited number of scripts can be embedded in a NoteCase Pro document or plugin.
* API methods for building and executing modular embedded scripts.
* Free networked plugin distribution/installation system with a user interface modeled on the familiar Synaptic package manager for Linux.
* User-contributed free Plugin Developer Toolkit that, inter alia, generates a new plugin framework from a template.
* Dozens of user-contributed free scripting aides.
* Full support for custom global and node properties in the form of key/value pairs, including API methods for creation/substitution and manipulation by document/node.
* Program supports 32 event triggers for automatic launching of scripts.
* Scripted import/export of nodes and plain text files for keeping external code files synced with document nodes.
* All nodes have template property that can be set so that all new descendants inherit node properties, e.g., a source language highlighting property (keep different language source code in same document with syntax highlighting intelligently applied).
* Program can display arbitrary groups of nodes (created in memory only) so that the user is not trapped by the hierarchy in which nodes are stored. Arbitrary node groups can be defined by search, by node tag, by custom property, scripted actions, etc.
* Nodes can be sorted in either tree or list mode manually, automatically, by scripted action, etc.
* All nodes have a unique ID, making them individually addressable by scripts.
* Program reads only a node’s plain text when executing a script embedded in it, allowing use of rich text and hyperlinks within scripts and script comments. Hyperlinking to chained modules is particularly useful in modular scripts to aid in code legibility.
* All methods fully documented in an 1800-plus-page Help file.
Probably lots more. This is the first day I’ve been working on the list.
If you’d like to give it a try, scripts work in the free download in trial mode (all features unlocked except writing to disk). If trying on Windows, get the 32-bit version. The 64-bit version is missing some features mentioned above (line numbering, go to line, syntax highlighting) because the GTK2 gstreamer library has not yet been ported to Win64 (and probably won’t be before NoteCase Pro is ported to GTK3). I’d be happy to email you a collection of 200-plus embedded scripts that I’m working on to give you an idea of the kinds of extensibility available. Just drop me an email at marbux pine @ spruce gmail maple .com (subtract the trees).
Best regards,
Paul
Posted by Alexander Deliyannis
Apr 22, 2016 at 09:06 PM
Lothar Scholz wrote:
>I find it remarkable that so many outlines still do not offer any
>extension mechanism.
You might want to check out Leo http://leoeditor.com/ It’s a cross-platform outliner / IDE / editor, fully scriptable via Python. It claims to work well with emacs, xemacs, vim, and ipython.