Make shift-enter docstrings appear in printed / published worksheets

[rlmill]

If I type sage.graphs.chrompoly?? for example in a cell, and evaluate, I get a nice chunk of code. But when I hit "print", all I get is the input. Docs should be included in the printed worksheets.

CC: @williamstein

Component: notebook

Author: Tim Dumol

Reviewer: Mitesh Patel

Merged: sagenb-0.7

Issue created by migration from https://trac.sagemath.org/ticket/3083

[TimDumol]

comment:1

This bug is caused by the fact that introspection output is not saved with the worksheet. Should this be the case?

[TimDumol]

Author: Tim Dumol

[TimDumol]

comment:2

This should do the job.

[TimDumol]

Makes evaluated (S-Enter, eval link, etc.) introspection show up in print while clearly marking that TAB introspected output is unprinted (also makes it draggable).

[williamstein]

comment:3

Attachment: trac_3083-print-documentation.patch.gz

Big +1 to this design approach.

[TimDumol]

Rebase on a new patch set.

[TimDumol]

comment:4

Attachment: trac_3083-print-documentation.2.patch.gz

The new patch set is:

trac_7650-sagenb_doctesting_v6.patch
trac_7650-reviewer.patch
trac_7648-missing_indent.patch
trac_7663-rstrip_prompt.patch
trac_7847-empty-trash-no-referer.patch
trac_7786-template-jinja-idiomatic.patch
trac_7863-declare_vars_aux_js_v2.patch
trac_7874-typeset_interact_labels.patch
trac_7858-key_binding_vars_v2.patch
trac_7666-alphanumeric_cell_ids_B5.patch
trac_7666-reviewer.patch
trac_7835-preparsing-unicode_v2.patch
trac_7249_jinja2_v5.patch
trac_2779-sagenb-error-message.patch
2779_2_banner.patch
trac_3154-spurious-u0027-output.patch
trac_7969-escaped-backslash.patch
trac_7937-sass_manifest.patch
trac_4217-html-system-formatting.patch
trac_3083-print-documentation.patch

Sorry for the immense patch queue.

[qed777]

comment:5

Well done!

• "Closing" a dialog does not remove it from the DOM. It's just hidden. I suggest mapping the close button to, e.g., $('.dialog').dialog('destroy').remove();.

• For 'eval'-method docstrings, the sans-serif font becomes monospaced.

• I suggest changing "Click on the box..." to, e.g., "Click here..." and binding the click event to just that div. Otherwise, users who click on the docstring as they read it and/or copy examples might get an unwanted dialog.

• It might be worth it to mention on the "Help" page or in the tutorial which docstrings are printable.

• If I evaluate factor? in a cell, I can print the docstring with the worksheet, as desired. People might also find it useful for evaluated docstrings to survive reopening the worksheet or to appear in published worksheets (e.g., as part of an annotated tutorial). But I suggest waiting for feedback on the mailing lists and, if it's necessary, creating new tickets.