From f46cc5c6b4747afa1bfe0621abf28c320c2e93ce Mon Sep 17 00:00:00 2001 From: "Davide P. Cervone" Date: Fri, 18 Mar 2011 18:54:00 -0400 Subject: [PATCH] Update documentation to reflect new situation for element(s) parameters --- docs/html/_sources/api/hub.txt | 67 ++++++++++++----------- docs/html/_sources/options/hub.txt | 10 ++++ docs/html/_sources/options/jsMath2jax.txt | 6 -- docs/html/_sources/options/mml2jax.txt | 5 -- docs/html/_sources/options/tex2jax.txt | 5 -- docs/html/api/hub.html | 67 ++++++++++++----------- docs/html/options/hub.html | 12 ++++ docs/html/options/jsMath2jax.html | 7 --- docs/html/options/mml2jax.html | 7 --- docs/html/options/tex2jax.html | 7 --- docs/html/searchindex.js | 2 +- docs/source/api/hub.rst | 67 ++++++++++++----------- docs/source/options/hub.rst | 10 ++++ docs/source/options/jsMath2jax.rst | 6 -- docs/source/options/mml2jax.rst | 5 -- docs/source/options/tex2jax.rst | 5 -- 16 files changed, 138 insertions(+), 150 deletions(-) diff --git a/docs/html/_sources/api/hub.txt b/docs/html/_sources/api/hub.txt index a836236a4..4a05c9775 100644 --- a/docs/html/_sources/api/hub.txt +++ b/docs/html/_sources/api/hub.txt @@ -187,24 +187,26 @@ Methods .. Method:: Typeset([element[,callback]]) - Calls the preprocessors on the given element, and then typesets - any math elements within the element. If no `element` is - provided, the whole document is processed. The `element` is - either the DOM `id` of the element, or a reference to the DOM - element itself. The `callback` is called when the process is - complete. See the :ref:`Modifying Math ` section - for details of how to use this method properly. + Calls the preprocessors on the given element (or elements if it is an + array of elements), and then typesets any math elements within the + element. If no `element` is provided, the whole document is processed. + The `element` is either the DOM `id` of the element, a reference to + the DOM element itself, or an array of id's or refereneces. The + `callback` is called when the process is complete. See the + :ref:`Modifying Math ` section for details of how to use + this method properly. :Parameters: - - **element** --- the element whose math is to be typeset + - **element** --- the element(s) whose math is to be typeset - **callback** --- the callback specification :Returns: the callback object .. method:: PreProcess([element[,callback]]) - Calls the loaded preprocessors on the entire document, or on the - given DOM element. The `element` is either the DOM `id` of the - element, or a reference to the DOM element itself. The `callback` + Calls the loaded preprocessors on the entire document, or on the given + DOM element (or elements, if it is an array of elements). The + `element` is either the DOM `id` of the element, a reference to the + DOM element itself, or an array of id's or references. The `callback` is called when the processing is complete. :Parameters: @@ -214,43 +216,44 @@ Methods .. method:: Process([element[,callback]]) - Scans either the entire document or a given DOM `element` for - MathJax ``