Macaulay2 » Documentation
Packages » Macaulay2Doc » reading the documentation » viewHelp
next | previous | forward | backward | up | index | toc

viewHelp -- view online documentation in a web browser

Description

Some example uses:

viewHelp -- open the list of local packages and their documentation
viewHelp "Macaulay2" -- open the top of the online documentation tree
viewHelp "matrices" -- open an overview of matrices in Macaulay2
viewHelp X -- open the documentation node whose key is X
viewHelp ideal -- documentation for the function ideal and ways to use it
viewHelp(ideal, List) -- documentation for the method ideal(List)
viewHelp[gb, DegreeLimit] -- documentation for the optional argument gb(...,DegreeLimit=>...)
viewHelp(symbol **, Ring, Ring) -- documentation for the method Ring ** Ring

Caveat

The help command allows other possible arguments, such as help methods ideal, but for viewHelp the argument must refer to only one web page. Note that the Safari browser may prevent loading of the style files for the online documentation.

See also

Ways to use viewHelp:

  • "viewHelp"
  • viewHelp(ZZ) -- see headlines -- display a table of documentation headlines
  • viewHelp(DocumentTag)
  • viewHelp(String)
  • viewHelp(Thing)

For the programmer

The object viewHelp is a command.


The source of this document is in Macaulay2Doc/functions/help-doc.m2:116:0.