#18292: Fix HTML output
-------------------------------------+-------------------------------------
       Reporter:  vbraun             |        Owner:
           Type:  defect             |       Status:  needs_info
       Priority:  major              |    Milestone:  sage-6.7
      Component:  notebook           |   Resolution:
       Keywords:                     |    Merged in:
        Authors:  Volker Braun       |    Reviewers:  Andrey Novoseltsev
Report Upstream:  N/A                |  Work issues:
         Branch:                     |       Commit:
  u/vbraun/fix_html_output           |  6def164370b96868c373f85ed81fe861cc2e336e
   Dependencies:                     |     Stopgaps:
-------------------------------------+-------------------------------------

Comment (by kcrisman):

 > How on earth is somebody supposed to come up with `show`? And even if
 you find the many (and often misguided) examples in the docs, can you tell
 me what it does?

 Nope, I can't, but at least it's in a lot of places so people can find it.
 So if `pretty_print` starts showing up lots of places (perhaps replacing a
 misguided `show`), they we should be golden.  There are various tutorial-
 esque parts of the Sage doc/tutorial as well  (perhaps where `html` used
 to appear as an example).

 > Someone who knows what MathJax is and can write raw HTML is
 sophisticated enough to read some basic tutorial that better mention
 existence of pretty_print. It may be also a good idea to have a section of
 the tutorial specifically on displaying thing nicely.

 They might not know about MathJax, just that there is a way to get things
 to look nice.  If there were sufficient places where it was all introduced
 (including the fragment business) that would be an acceptable solution, I
 think.

 > * Pretty print is a technical term:
 https://en.wikipedia.org/wiki/Prettyprint

 That proves my point, I think: it's not a term in general non-technical
 usage.

 Seriously, is `print_pretty` a possibility as an alias, or is that just
 pointless?

 Here is an example of what I mean.  You just did
 {{{
 #!diff
 -.. skip
 -
 -::
 -
 -    sage: html.table( [ (i,det(A^i)) for i in [0..4] ] )
 -    <html>...</html>
 +    sage: table( [ (i,det(A^i)) for i in [0..4] ] )
 +      0   1
 +      1   -2
 +      2   4
 +      3   -8
 +      4   16
 }}}
 But now anyone using a notebook interface won't know how to make it
 "pretty".    Yet elsewhere in your diff you have
 `pretty_print(table(input))`.  This would have been a great opportunity to
 help teach people about this.  In one place you even '''left''' the
 wording
 {{{
  Even better, we can put a header line on it to make it really clear what
  we are doing, by adding lists. We've seen keywords like ``header=True``
  when doing some of our plotting and limits. What do you think will
 -happen if you put dollar signs around the labels in the header?
 +happen if you put dollar signs around the labels in the header? ::
 }}}
 which makes absolutely no sense without the html/MathJax showing up in the
 notebook!

--
Ticket URL: <http://trac.sagemath.org/ticket/18292#comment:63>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica, 
and MATLAB

-- 
You received this message because you are subscribed to the Google Groups 
"sage-trac" 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/sage-trac.
For more options, visit https://groups.google.com/d/optout.

Reply via email to