Prompt hiding for cut-and-paste

posted Wed 9 May 2012 by Michael Galloy under IDL, IDLdoc

[experiment]: http://michaelgalloy.com/wp-content/uploads/2012/05/prompt_hiding.html “Prompt hiding example”
[sphinx]: http://sphinx.pocoo.org/ “Sphinx documentation”

[^1]: Sphinx is somewhat the Python equivalent to IDLdoc, but much more general.

While looking up some Python docs generated by the excellent [Sphinx][sphinx] documentation tool[^1], I noticed that Sphinx can show/hide the prompts and output in a code snippet. This allows the user to see the full code and output, but then can hit a button and get text suitable for cut-and-pasting onto the command line to try it for themselves. Check out my simple [experiment] to see how it works.

I will definitely have to work this into an IDLdoc release soon.

[3] Comments

3 Responses to “Prompt hiding for cut-and-paste”

Michael Galloy says:
May 16th, 2012 at 8:08 pm
Here’s an example of IDLdoc using this idea.
Michael Galloy says:
May 17th, 2012 at 4:49 pm
OK, styling is a bit better now; this is in the trunk of IDLdoc now and will be in the next release.
Mark Piper says:
May 17th, 2012 at 9:04 pm
This is really cool, Mike; thanks!

michaelgalloy.com

Resources for IDL developers

Buy Modern IDL now!

Modern IDL offers IDL programmers one place to look for explanation, techniques, and reference material, for beginners and advanced users alike.

"... But I've always wanted a thorough, concise, up-to-date overview of the the IDL language and its vast capabilities. This is exactly what Mike's book provides in 464 very informative pages... Highly recommended!"
—Mort Canty

About me

I'm a software developer focusing on high-performance computing and visualization in scientific programming. I work mostly in IDL, but occasionally use C, CUDA, and Python.

I currently work for the National Center for Atmospheric Research (NCAR) at the Mauna Loa Solar Observatory. Previously, I worked for Tech-X Corporation, where I was the main developer for GPULib, a library of IDL bindings for GPU accelerated computation routines.

I am the creator and main developer for the open source projects IDLdoc, mgunit, and rIDL.

Contact me at +Michael Galloy, @mgalloy, or via email at mgalloy at gmail dot com. For more details about me, see my CV/resume.

Need consulting/instruction? Contact me.

Other

Feeds

GPULib

GPULib enables IDL developers to access the high-performance capabilities of modern NVIDIA graphics cards without knowledge of CUDA programming.

TaskDL

TaskDL is a task-farming solution for IDL designed for problems with loosely-coupled, parallel applications where no communication between nodes of a cluster is required.

mpiDL

mpiDL is a library of IDL bindings for Message Passing Interface (MPI) used for tightly-coupled parallel applications.

Remote Data Toolkit

The Remote Data Toolkit is a library of IDL routines allowing for easy access to various scientific data in formats such as OPeNDAP, HDF 5, and netCDF.
Modern IDL

Modern IDL offers IDL programmers one place to look, for beginners and advanced users alike. This book also contains: a thorough tutorial on the core topics of IDL; a comprehensive introduction to the object graphics system; common problems and gotchas with many examples; advanced topics not normally found are discussed throughout the book: regular expressions, object graphics, advanced widget programming, performance, object-oriented programming, etc.
IDLdoc

IDLdoc is an open source utility for generating documentation from IDL source code and specially formatted comments.

mgunit

mgunit is an open source unit testing framework for IDL.

rIDL

rIDL is an open source IDL command line replacement.

mglib

mglib is an open source library of IDL routines in areas of visualization, application development, command line utilities, analysis, data access, etc.

Prompt hiding for cut-and-paste

3 Responses to “Prompt hiding for cut-and-paste”