Re: Updating docs

2015-03-19 Thread Largo84
That would be a great help to link to other references (like Emacs or Vim) 
that use similar terminology and solve similar problems. No sense in 
'reinventing the wheel'.

Rob..

On Thursday, March 19, 2015 at 11:00:49 AM UTC-4, Edward K. Ream wrote:



 On Mon, Mar 16, 2015 at 4:35 PM, 'Terry Brown' via leo-editor 
 ​leo-e...@googlegroups.com javascript: wrote:

 On Mon, 16 Mar 2015 14:18:23 -0700 (PDT)
 Largo84 lar...@gmail.com javascript: wrote:

  I'm really glad the docs are being updated. I know that's a
  monumental task. I only use a fraction of Leo's commands, mostly
  because I don't even know what they're supposed to accomplish. A few
  examples:


 ​Thanks, Terry, for your discussion of the rectangle commands.

 I've added an item in the doc's to-do list for 5.1b1.

 I wonder, perhaps there should be more links to the Emacs docs :-)

   Tangle all @root nodes in the selected outline.

 ​The  tangle and untangle command have been removed from the docs.

 @root is now officially in limbo.  It exists​, but only as an Easter Egg 
 for compatibility with old code.  There are absolutely no advantages to 
 using @root, and many disadvantages.

 Ah.  As I write this, I see way forward.  I'll change the docstring for 
 the tangle* and untangle* commands to say that @root and all related 
 commands are deprecated.

 Edward


-- 
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 leo-editor+unsubscr...@googlegroups.com.
To post to this group, send email to leo-editor@googlegroups.com.
Visit this group at http://groups.google.com/group/leo-editor.
For more options, visit https://groups.google.com/d/optout.


Re: Updating docs

2015-03-19 Thread Edward K. Ream
On Mon, Mar 16, 2015 at 4:35 PM, 'Terry Brown' via leo-editor
​leo-editor@googlegroups.com wrote:

 On Mon, 16 Mar 2015 14:18:23 -0700 (PDT)
 Largo84 larg...@gmail.com wrote:

  I'm really glad the docs are being updated. I know that's a
  monumental task. I only use a fraction of Leo's commands, mostly
  because I don't even know what they're supposed to accomplish. A few
  examples:


​Thanks, Terry, for your discussion of the rectangle commands.

I've added an item in the doc's to-do list for 5.1b1.

I wonder, perhaps there should be more links to the Emacs docs :-)

  Tangle all @root nodes in the selected outline.

​The  tangle and untangle command have been removed from the docs.

@root is now officially in limbo.  It exists​, but only as an Easter Egg
for compatibility with old code.  There are absolutely no advantages to
using @root, and many disadvantages.

Ah.  As I write this, I see way forward.  I'll change the docstring for the
tangle* and untangle* commands to say that @root and all related commands
are deprecated.

Edward

-- 
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 leo-editor+unsubscr...@googlegroups.com.
To post to this group, send email to leo-editor@googlegroups.com.
Visit this group at http://groups.google.com/group/leo-editor.
For more options, visit https://groups.google.com/d/optout.


Re: Updating docs

2015-03-16 Thread 'Terry Brown' via leo-editor
On Mon, 16 Mar 2015 14:18:23 -0700 (PDT)
Largo84 larg...@gmail.com wrote:

 I'm really glad the docs are being updated. I know that's a
 monumental task. I only use a fraction of Leo's commands, mostly
 because I don't even know what they're supposed to accomplish. A few
 examples:
 
 1) There are seven 'Rectangle' commands. Running help-for-command

I know you want the docs. to be more complete, not just answers for
your questions, but putting this text in Leo:
  
   I'm really glad the docs are being updated. I know that's a
   monumental task. I only use a fraction of Leo's commands, mostly
   because I don't even know what they're supposed to accomplish. A few
   examples:

Placing the cursor immediately before the first I, holding shift and
moving it to immediately before the word examples selects a zero
width rectangle from the beginning to the end of the selection (zero
width because the selection starts and ends in the same column.  Then
running rectangle-string [largo]spaceenter yields:

   [largo] I'm really glad the docs are being updated. I know that's a
   [largo] monumental task. I only use a fraction of Leo's commands, mostly
   [largo] because I don't even know what they're supposed to accomplish. A few
   [largo] examples:

i.e. the insertion of a rectangle of text.  Basically emulates the
Emacs commands:
http://www.gnu.org/software/emacs/manual/html_node/emacs/Rectangles.html

 Tangle all @root nodes in the selected outline.

Knuth's literate programming which combines detailed narrative
documentation of the code with the code itself uses all kinds of
tangle and weave related terms to refer to the process of
producing code from the combined texts, or docs., etc.  I'm not really
sure that literate programming has much hold these days, even though it
inspired Leo initially.  It was good for languages like TeX that are
hard to read quickly, but modern languages can be fairly easy to read,
if you pick good variable names etc., and if properly structured can
usually be sufficiently documented with the languages own features
(docstrings) and systems like Sphinx. (Any or all of this could be
wrong, but I think it was Knuth and this is what it's about).

That said http://yihui.name/knitr/ is basically literate programming
for R, and very useful for documenting analysis to make it repeatable.

Cheers -Terry

-- 
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 leo-editor+unsubscr...@googlegroups.com.
To post to this group, send email to leo-editor@googlegroups.com.
Visit this group at http://groups.google.com/group/leo-editor.
For more options, visit https://groups.google.com/d/optout.