Re: [Doc-SIG] Documentation systems for other languages
On Fri, 7 Jan 2000 16:05:59 PST, bill janssen wrote:
Before that, (i think) edward welbourne wrote:
For a pythonic system, folding would mean taking any fairly large chunk of code or doc (sharing a common base indent) and providing for it to be *displayed* (by the IDE) either (open fold) as the whole chunk or (closed fold) as a single line carrying (typically encoded as a comment) some text that says what's in the fold. In between, of course, we have the fold open but some portions of its contents folded out of sight. Most modern directory-browsers display directory tree hierarchies in a way instantly recognisable to anyone who ever used a folded editor.
Sounds like outline mode in emacs. The GNU Emacs support for SGML provides this, perhaps more closely resembling what you describe.
I've been meaning to mention my outdent.el - it provides emacs outline-mode style text visibility control based on indentation, and runs as a minor mode - so you can run it in conjunction with python mode. I find it quite useful for looking at the structure of modules, especially large ones, and narrowing focus to particular portions. There are things yet to be done for it - searching can leave the cursor within hidden regions (so you need to hit ^C^I or ^C^S to expose where you are - interrupting the search), and i've been hoping for years to have a moment to incorporate this functionality directly in python-mode.el, but alas. It should be useful as is - it is for me... Find it at http://starship.python.net/crew/klm/outdent.el Ken Manheimer klm@i.am
Ken Manheimer: |I've been meaning to mention my outdent.el - it provides emacs |outline-mode style text visibility control based on indentation, and |runs as a minor mode - so you can run it in conjunction with python |mode. I find it quite useful for looking at the structure of modules, |especially large ones, and narrowing focus to particular portions. That is a really nice aid for Emacs users. Personally I think this is worth posting to the main python list! ;-) And linked off of http://www.python.org/emacs/, if you're confortable with it. I can see myself using this a good bit. So many times I've been browsing someone else's .py and wanted to know what class we're in. Page up, page up, page up, and hope you don't miss it, or do a search-backward-regex. Now just C-c C-u. Hiding can be useful for browsing too, as you said. Seeing outdent-show-all, I was looking for an 'outdent-hide-all' or 'outdent-hide-this-level', but didn't find one. No big deal. I'll write a macro for that sometime. Thanks for the tool. -- Randall Hopper aa8vb@yahoo.com
On Tue, 11 Jan 2000, Randall Hopper wrote:
[I posted outdent.el, an exposure-control emacs minor mode for indented text.]
That is a really nice aid for Emacs users. Personally I think this is worth posting to the main python list! ;-) And linked off of http://www.python.org/emacs/, if you're confortable with it.
It was on the python.org contrib section, but that's now gone. I think it was in the python.org emacs section, too, but that seems to be gone - too bad! I too would like to see it back there. I don't have time to post it to comp.lang.emacs right now - feel free to do so, if you'd like! I just can't followup at the moment, due to lack of time...
Seeing outdent-show-all, I was looking for an 'outdent-hide-all' or 'outdent-hide-this-level', but didn't find one. No big deal. I'll write a macro for that sometime.
Do '^U^C^H' at a top-level topic. (If you just keep doing a '^C^H' it'll close things until you get to the top level, then a message will tell you to give the repeat count.)
Thanks for the tool.
Glad you like it! Ken klm@digicool.com
Ken Manheimer: |> That is a really nice aid for Emacs users. Personally I think this is |> worth posting to the main python list! ;-) And linked off of |> http://www.python.org/emacs/, if you're confortable with it. | |It was on the python.org contrib section, but that's now gone. I think it |was in the python.org emacs section, too, but that seems to be gone - too |bad! No it's still there: http://www.python.org/emacs/ However I found it via the search engine, so I don't know whether it's reachable through links. FAQ entry 1.19 really needs updated to include: Other Emacs goodies for Python (PDB Mode, outdent, etc.) can be found at: http://www.python.org/emacs Randall |> Seeing outdent-show-all, I was looking for an 'outdent-hide-all' or |> 'outdent-hide-this-level', but didn't find one. No big deal. I'll write a |> macro for that sometime. | |Do '^U^C^H' at a top-level topic. (If you just keep doing a '^C^H' it'll |close things until you get to the top level, then a message will tell you |to give the repeat count.) Great. Referring to the function help on outdent-mode again, I infer that ^U must generally mean "for all"; I didn't pick that up the first time from the specific outdent-show-all example. -- Randall Hopper aa8vb@yahoo.com
On Tue, 18 Jan 2000, Randall Hopper wrote:
Ken Manheimer: |> That is a really nice aid for Emacs users. Personally I think this is |> worth posting to the main python list! ;-) And linked off of |> http://www.python.org/emacs/, if you're confortable with it. | |It was on the python.org contrib section, but that's now gone. I think it |was in the python.org emacs section, too, but that seems to be gone - too |bad!
No it's still there:
Whoops - my statement was ambiguous - i didn't mean that http://www.python.org/emacs/ was gone, but rather that outdent isn't in it.
However I found it via the search engine, so I don't know whether it's reachable through links.
FAQ entry 1.19 really needs updated to include:
Other Emacs goodies for Python (PDB Mode, outdent, etc.) can be found at:
Yes - i think outdent was there, can't recall why it was ditched... (Barry?)
Randall
|> Seeing outdent-show-all, I was looking for an 'outdent-hide-all' or |> 'outdent-hide-this-level', but didn't find one. No big deal. I'll write a |> macro for that sometime. | |Do '^U^C^H' at a top-level topic. (If you just keep doing a '^C^H' it'll |close things until you get to the top level, then a message will tell you |to give the repeat count.)
Great. Referring to the function help on outdent-mode again, I infer that ^U must generally mean "for all"; I didn't pick that up the first time from the specific outdent-show-all example.
It's not ideal. Neither is an alternative choice i made in my outliner for emacs, allout.el, where doing a hide of a top-level topic that's already hidden would do a hide-all. Neither is particularly obvious, and its easier to accidentally invoke the allout choice - for better or worse, i'm not sure... Ken Manheimer klm@digicool.com
participants (2)
-
Ken Manheimer -
Randall Hopper