On 8/15/2013 11:52 AM, Edward K. Ream wrote:
Rev 5906 completes the work of editing more than a year's worth of
emails into preliminary docs of features, especially plugins.
The release notes, in LeoDocs.leo, contain two sets of (identical)
docs, one in the plugins chapter::
Users Guide-->Intermediate Topics-->Plugins-->@file
plugins.txt-->@rst html\plugins.html-->Recently added plugins
and one in the release notes, the top-level clone::
Leo 4.11 a1 Release notes-->Plugins
I would appreciate editorial help for these docs from plugin writers,
especially the "improved" plugins: bookmarks.py, ipython.py,
valuespace.py and viewrendered.py.
**Please** help me out by:
1. Bringing the docs up to date,
2. Removing any redundant material,
3. Creating up-to-date summaries.
Given the difficulties of collaborating on .leo files directly, please
announce the corrections *here*. I can then do the merging myself.
Edward
--
Hi Edward,
I updated printing.py in rev 5904. The new complete docsting is as follows:
QQQ
'''Supports printing from the Qt GUI.
Jacob M. Peck, 2013
Commands
========
This plugin supports the following commands:
print-selected-node
-------------------
Opens up the print dialog to print the selected headline and node.
print-preview-selected-node
---------------------------
Opens up the print preview dialog to preview the selected headline
and node.
print-selected-node-body
------------------------
Opens up the print dialog to print the selected node body.
print-preview-selected-node-body
--------------------------------
Opens up the print preview dialog to preview the selected node body.
print-expanded-node
-------------------
Opens up the print dialog to print the expanded contents of the
selected node, with top-level headline.
print-preview-expanded-node
---------------------------
Opens up the print preview dialog to preview the expanded contents
of theselected node, with top-level headline.
print-expanded-node-body
------------------------
Opens up the print dialog to print the expanded node body.
print-preview-expanded-node-body
--------------------------------
Opens up the print preview dialog to preview the expanded node
body.
print-marked-nodes
------------------
Opens up the print dialog to print all marked nodes in the current
outline, with headlines.
print-preview-marked-nodes
--------------------------
Opens up the print preview dialog to preview all marked nodes in \
the current outline, with headlines.
print-marked-node-bodies
------------------------
Opens up the print dialog to print the bodies of all marked nodes
in the current outline.
print-preview-marked-node-bodies
--------------------------------
Opens up the print preview dialog to preview the bodies of all
marked nodes in the current outline.
print-selected-node-body-html
-----------------------------
Opens up the print dialog to print the body of the selected node
as a rendered HTML (i.e., rich text) document.
print-preview-selected-node-body-html
-------------------------------------
Opens up the print preview dialog to preview the body of the selected
node as a rendered HTML (i.e., rich text) document.
Settings
========
- ``@string printing-font-family = DejaVu Sans Mono``
The font family for printing. A monospaced font is recommended.
- ``@string printing-font-size = 12``
The font size for printing bodies, in px. Due to limitations
of PyQt, the size of headlines cannot be changed.
'''
QQQ
The viewrendered notes look correct in the release notes section.
The following node needs to be revised, by running Terry's script
(leo/doc/pluginCatalog.py or something like it): Users
Guide-->Intermediate Topics-->Plugins-->@file plugins.txt-->@rst
html\plugins.html-->Summary
I would also suggest replacing Users Guide-->Intermediate
Topics-->Plugins-->@file plugins.txt-->@rst html\plugins.html-->Qt only
plugins-->viewrendered.py with the current docstring from viewrendered,
as that is way more up to date, and explains the @md markdown rendering
additions.
-->Jake
--
You received this message because you are subscribed to the Google Groups
"leo-editor" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/leo-editor.
For more options, visit https://groups.google.com/groups/opt_out.
