cdocutils.nodes document q)q}q(U nametypesq}q(XSetqKXmethodsqNX api-messageqKXClearq KXthe mathjax.message objectq NXLogq KuUsubstitution_defsq }q Uparse_messagesq]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hhhUmethodsqhU api-messageqh h h Uthe-mathjax-message-objectqh h uUchildrenq]q(cdocutils.nodes target q)q}q(U rawsourceqX.. _api-message:qUparentqhUsourceq cdocutils.nodes reprunicode q!XU/Data/Code/JavaScript/MathJax/Code/SourceForge/trunk/mathjax/docs/rst/api/message.rstq"q#}q$bUtagnameq%Utargetq&U attributesq'}q((Uidsq)]q*Ubackrefsq+]q,Udupnamesq-]q.Uclassesq/]q0Unamesq1]q2Urefidq3huUlineq4KUdocumentq5hh]q6ubcdocutils.nodes section q7)q8}q9(hUhhh h#Uexpect_referenced_by_nameq:}q;hhsh%Usectionqh/]q?h+]q@h)]qA(hheh1]qB(h heuh4Kh5hUexpect_referenced_by_idqC}qDhhsh]qE(cdocutils.nodes title qF)qG}qH(hXThe MathJax.Message ObjectqIhh8h h#h%UtitleqJh'}qK(h-]qLh/]qMh+]qNh)]qOh1]qPuh4Kh5hh]qQcdocutils.nodes Text qRXThe MathJax.Message ObjectqSqT}qU(hhIhhGubaubcdocutils.nodes paragraph qV)qW}qX(hX%The ``MathJax.Message`` object contains the methods used to manage the small message area that appears at the lower-left corner of the window. MathJax uses this area to inform the user of time-consuming actions, like loading files and fonts, or how far along in the typesetting process it is.qYhh8h h#h%U paragraphqZh'}q[(h-]q\h/]q]h+]q^h)]q_h1]q`uh4Kh5hh]qa(hRXThe qbqc}qd(hXThe qehhWubcdocutils.nodes literal qf)qg}qh(hX``MathJax.Message``qih'}qj(h-]qkh/]qlh+]qmh)]qnh1]qouhhWh]qphRXMathJax.Messageqqqr}qs(hUhhgubah%UliteralqtubhRX object contains the methods used to manage the small message area that appears at the lower-left corner of the window. MathJax uses this area to inform the user of time-consuming actions, like loading files and fonts, or how far along in the typesetting process it is.quqv}qw(hX object contains the methods used to manage the small message area that appears at the lower-left corner of the window. MathJax uses this area to inform the user of time-consuming actions, like loading files and fonts, or how far along in the typesetting process it is.qxhhWubeubhV)qy}qz(hXThe page author can customize the look of the message window by setting styles for the ``#MathJax_Message`` selector (which can be set viaq{hh8h h#h%hZh'}q|(h-]q}h/]q~h+]qh)]qh1]quh4K h5hh]q(hRXWThe page author can customize the look of the message window by setting styles for the qq}q(hXWThe page author can customize the look of the message window by setting styles for the qhhyubhf)q}q(hX``#MathJax_Message``qh'}q(h-]qh/]qh+]qh)]qh1]quhhyh]qhRX#MathJax_Messageqq}q(hUhhubah%htubhRX selector (which can be set viaqq}q(hX selector (which can be set viaqhhyubeubcdocutils.nodes literal_block q)q}q(hXRMathJax.Hub.Config({ styles: { "#MathJax_Message": { ... } } });qhh8h h#h%U literal_blockqh'}q(UlinenosqUlanguageqX javascriptqU xml:spaceqUpreserveqh)]qh+]qh-]qh/]qh1]quh4Kh5hh]qhRXRMathJax.Hub.Config({ styles: { "#MathJax_Message": { ... } } });qq}q(hUhhubaubhV)q}q(hXBecause of a bug in Internet Explorer, in order to change the side of the screen where the the message occurs, you must also set the side for ``#MathJax_MSIE_Frame``, as inqhh8h h#h%hZh'}q(h-]qh/]qh+]qh)]qh1]quh4Kh5hh]q(hRXBecause of a bug in Internet Explorer, in order to change the side of the screen where the the message occurs, you must also set the side for qq}q(hXBecause of a bug in Internet Explorer, in order to change the side of the screen where the the message occurs, you must also set the side for qhhubhf)q}q(hX``#MathJax_MSIE_Frame``qh'}q(h-]qh/]qh+]qh)]qh1]quhhh]qhRX#MathJax_MSIE_Frameqąq}q(hUhhubah%htubhRX, as inqDžq}q(hX, as inqhhubeubh)q}q(hXMathJax.Hub.Config({ styles: { "#MathJax_Message": {left: "", right: 0}, "#MathJax_MSIE_Frame": {left: "", right: 0} } });qhh8h h#h%hh'}q(hhX javascriptqhhh)]qh+]qh-]qh/]qh1]quh4K(h5hh]qhRXMathJax.Hub.Config({ styles: { "#MathJax_Message": {left: "", right: 0}, "#MathJax_MSIE_Frame": {left: "", right: 0} } });qօq}q(hUhhubaubhV)q}q(hXIt is possible that a message is already being displayed when another message needs to be posted. For this reason, when a message is displayed on screen, it gets an id number that is used when you want to remove or change that message. That way, when a message is removed, the previous message (if any) can be redisplayed if it hasn't been removed. This allows for intermittent messages (like file loading messages) to obscure longer-term message (like "Processing Math" messages) temporarily.qhh8h h#h%hZh'}q(h-]qh/]qh+]qh)]qh1]quh4K)h5hh]qhRXIt is possible that a message is already being displayed when another message needs to be posted. For this reason, when a message is displayed on screen, it gets an id number that is used when you want to remove or change that message. That way, when a message is removed, the previous message (if any) can be redisplayed if it hasn't been removed. This allows for intermittent messages (like file loading messages) to obscure longer-term message (like "Processing Math" messages) temporarily.qㅁq}q(hhhhubaubh7)q}q(hUhh8h h#h%h(h-]r?h/]r@h+]rAh)]rBh1]rCuh4KFh5hh]rD(csphinx.addnodes desc_parameter rE)rF}rG(hXmessagerHhj;h h#h%Udesc_parameterrIh'}rJ(h-]rKh/]rLh+]rMh)]rNh1]rOuh4KFh5hh]rPhRXmessagerQrR}rS(hUhjFubaubcsphinx.addnodes desc_optional rT)rU}rV(hUhj;h h#h%U desc_optionalrWh'}rX(h-]rYh/]rZh+]r[h)]r\h1]r]uh4KFh5hh]r^(jE)r_}r`(hXnhjUh h#h%jIh'}ra(h-]rbh/]rch+]rdh)]reh1]rfuh4KFh5hh]rghRXnrh}ri(hUhj_ubaubjT)rj}rk(hUhjUh h#h%jWh'}rl(h-]rmh/]rnh+]roh)]rph1]rquh4KFh5hh]rrjE)rs}rt(hXdelayruhjjh h#h%jIh'}rv(h-]rwh/]rxh+]ryh)]rzh1]r{uh4KFh5hh]r|hRXdelayr}r~}r(hUhjsubaubaubeubeubeubcsphinx.addnodes desc_content r)r}r(hUhj h h#h%U desc_contentrh'}r(h-]rh/]rh+]rh)]rh1]ruh4KFh5hh]r(hV)r}r(hXThis sets the message being displayed to the given `message` string. If `n` is not ``null``, it represents a message id number and the text is set for that message id, otherwise a new id number is created for this message. If `delay` is provided, it is the time (in milliseconds) to display the message before it is cleared. If `delay` is not provided, the message will not be removed automatically; you must call the :meth:`MathJax.Messsage.Clear()` method by hand to remove it.rhjh h#h%hZh'}r(h-]rh/]rh+]rh)]rh1]ruh4K8h5hh]r(hRX3This sets the message being displayed to the given rr}r(hX3This sets the message being displayed to the given rhjubcdocutils.nodes title_reference r)r}r(hX `message`rh'}r(h-]rh/]rh+]rh)]rh1]ruhjh]rhRXmessagerr}r(hUhjubah%Utitle_referencerubhRX string. If rr}r(hX string. If rhjubj)r}r(hX`n`rh'}r(h-]rh/]rh+]rh)]rh1]ruhjh]rhRXnr}r(hUhjubah%jubhRX is not rr}r(hX is not rhjubhf)r}r(hX``null``rh'}r(h-]rh/]rh+]rh)]rh1]ruhjh]rhRXnullrr}r(hUhjubah%htubhRX, it represents a message id number and the text is set for that message id, otherwise a new id number is created for this message. If rr}r(hX, it represents a message id number and the text is set for that message id, otherwise a new id number is created for this message. If rhjubj)r}r(hX`delay`rh'}r(h-]rh/]rh+]rh)]rh1]ruhjh]rhRXdelayrr}r(hUhjubah%jubhRX` is provided, it is the time (in milliseconds) to display the message before it is cleared. If rr}r(hX` is provided, it is the time (in milliseconds) to display the message before it is cleared. If rhjubj)r}r(hX`delay`rh'}r(h-]rh/]rh+]rh)]rh1]ruhjh]rhRXdelayrr}r(hUhjubah%jubhRXS is not provided, the message will not be removed automatically; you must call the rr}r(hXS is not provided, the message will not be removed automatically; you must call the rhjubcsphinx.addnodes pending_xref r)r}r(hX :meth:`MathJax.Messsage.Clear()`rhjh%U pending_xrefrh'}r(UreftyperXmethrU reftargetrXMathJax.Messsage.ClearrU refdomainrXpyrh)]rh+]rU refexplicitrh-]rh/]rh1]rUrefdocrU api/messagerUpy:classrNU py:modulerNuh4K8h]rhf)r}r(hjh'}r(h-]r h/]r (Uxrefr jXpy-methr eh+]r h)]rh1]ruhjh]rhRXMathJax.Messsage.Clear()rr}r(hUhjubah%htubaubhRX method by hand to remove it.rr}r(hX method by hand to remove it.rhjubeubcdocutils.nodes field_list r)r}r(hUhjh Nh%U field_listrh'}r(h-]rh/]rh+]rh)]r h1]r!uh4Nh5hh]r"(cdocutils.nodes field r#)r$}r%(hUhjh h#h%Ufieldr&h'}r'(h-]r(h/]r)h+]r*h)]r+h1]r,uh4KAh5hh]r-(cdocutils.nodes field_name r.)r/}r0(hX Parametersr1h'}r2(h-]r3h/]r4h+]r5h)]r6h1]r7uhj$h]r8hRX Parameters r9r:}r;(hUhj/ubah%U field_namer<ubcdocutils.nodes field_body r=)r>}r?(hX- **message** --- the text to display in the message area - **n** --- the message id number - **delay** --- amout of time to display the messager@h'}rA(h-]rBh/]rCh+]rDh)]rEh1]rFuhj$h]rGcdocutils.nodes bullet_list rH)rI}rJ(hUh'}rK(UbulletrLX-h)]rMh+]rNh-]rOh/]rPh1]rQuhj>h]rR(cdocutils.nodes list_item rS)rT}rU(hX7**message** --- the text to display in the message arearVh'}rW(h-]rXh/]rYh+]rZh)]r[h1]r\uhjIh]r]hV)r^}r_(hjVhjTh h#h%hZh'}r`(h-]rah/]rbh+]rch)]rdh1]reuh4KBh]rf(cdocutils.nodes strong rg)rh}ri(hX **message**rjh'}rk(h-]rlh/]rmh+]rnh)]roh1]rpuhj^h]rqhRXmessagerrrs}rt(hUhjhubah%UstrongruubhRX, --- the text to display in the message arearvrw}rx(hX, --- the text to display in the message arearyhj^ubeubah%U list_itemrzubjS)r{}r|(hX**n** --- the message id numberr}h'}r~(h-]rh/]rh+]rh)]rh1]ruhjIh]rhV)r}r(hj}hj{h h#h%hZh'}r(h-]rh/]rh+]rh)]rh1]ruh4KCh]r(jg)r}r(hX**n**rh'}r(h-]rh/]rh+]rh)]rh1]ruhjh]rhRXnr}r(hUhjubah%juubhRX --- the message id numberrr}r(hX --- the message id numberrhjubeubah%jzubjS)r}r(hX2**delay** --- amout of time to display the messagerh'}r(h-]rh/]rh+]rh)]rh1]ruhjIh]rhV)r}r(hjhjh h#h%hZh'}r(h-]rh/]rh+]rh)]rh1]ruh4KDh]r(jg)r}r(hX **delay**rh'}r(h-]rh/]rh+]rh)]rh1]ruhjh]rhRXdelayrr}r(hUhjubah%juubhRX) --- amout of time to display the messagerr}r(hX) --- amout of time to display the messagerhjubeubah%jzubeh%U bullet_listrubah%U field_bodyrubeubj#)r}r(hUhjh h#h%j&h'}r(h-]rh/]rh+]rh)]rh1]ruh4KEh5hh]r(j.)r}r(hXReturnsrh'}r(h-]rh/]rh+]rh)]rh1]ruhjh]rhRXReturns rr}r(hUhjubah%j<ubj=)r}r(hX&the message id nuber for this message.rh'}r(h-]rh/]rh+]rh)]rh1]ruhjh]rhV)r}r(hjhjh h#h%hZh'}r(h-]rh/]rh+]rh)]rh1]ruh4KEh]rhRX&the message id nuber for this message.rr}r(hjhjubaubah%jubeubeubeubeubh)r}r(hUhhh Nh%hh'}r(h)]rh+]rh-]rh/]rh1]rUentriesr]r(jXClear()h h trauh4Nh5hh]rubj )r}r(hUhhh Nh%jh'}r(jjXpyrh)]rh+]rh-]rh/]rh1]rjXmethodrjjuh4Nh5hh]r(j)r}r(hXClear(n[,delay])r hjh h#h%j h'}r (h)]r h aj#Nh+]r h-]r h/]rh1]rh aj(h j)Uj*uh4KPh5hh]r(j,)r}r(hh hjh h#h%j/h'}r(h-]rh/]rh+]rh)]rh1]ruh4KPh5hh]rhRXClearrr}r(hUhjubaubj:)r}r(hUhjh h#h%j=h'}r(h-]r h/]r!h+]r"h)]r#h1]r$uh4KPh5hh]r%(jE)r&}r'(hXnhjh h#h%jIh'}r((h-]r)h/]r*h+]r+h)]r,h1]r-uh4KPh5hh]r.hRXnr/}r0(hUhj&ubaubjT)r1}r2(hUhjh h#h%jWh'}r3(h-]r4h/]r5h+]r6h)]r7h1]r8uh4KPh5hh]r9jE)r:}r;(hXdelayr<hj1h h#h%jIh'}r=(h-]r>h/]r?h+]r@h)]rAh1]rBuh4KPh5hh]rChRXdelayrDrE}rF(hUhj:ubaubaubeubeubj)rG}rH(hUhjh h#h%jh'}rI(h-]rJh/]rKh+]rLh)]rMh1]rNuh4KPh5hh]rO(hV)rP}rQ(hXThis causes the message with id `n` to be removed after the given `delay`, in milliseconds. The default delay is 600 milliseconds.rRhjGh h#h%hZh'}rS(h-]rTh/]rUh+]rVh)]rWh1]rXuh4KIh5hh]rY(hRX This causes the message with id rZr[}r\(hX This causes the message with id r]hjPubj)r^}r_(hX`n`r`h'}ra(h-]rbh/]rch+]rdh)]reh1]rfuhjPh]rghRXnrh}ri(hUhj^ubah%jubhRX to be removed after the given rjrk}rl(hX to be removed after the given rmhjPubj)rn}ro(hX`delay`rph'}rq(h-]rrh/]rsh+]rth)]ruh1]rvuhjPh]rwhRXdelayrxry}rz(hUhjnubah%jubhRX:, in milliseconds. The default delay is 600 milliseconds.r{r|}r}(hX:, in milliseconds. The default delay is 600 milliseconds.r~hjPubeubj)r}r(hUhjGh Nh%jh'}r(h-]rh/]rh+]rh)]rh1]ruh4Nh5hh]r(j#)r}r(hUhjh h#h%j&h'}r(h-]rh/]rh+]rh)]rh1]ruh4KLh5hh]r(j.)r}r(hX Parametersrh'}r(h-]rh/]rh+]rh)]rh1]ruhjh]rhRX Parameters rr}r(hUhjubah%j<ubj=)r}r(hXW- **n** --- the message id number - **delay** --- the delay before removing the messagerh'}r(h-]rh/]rh+]rh)]rh1]ruhjh]rjH)r}r(hUh'}r(jLX-h)]rh+]rh-]rh/]rh1]ruhjh]r(jS)r}r(hX**n** --- the message id numberrh'}r(h-]rh/]rh+]rh)]rh1]ruhjh]rhV)r}r(hjhjh h#h%hZh'}r(h-]rh/]rh+]rh)]rh1]ruh4KMh]r(jg)r}r(hX**n**rh'}r(h-]rh/]rh+]rh)]rh1]ruhjh]rhRXnr}r(hUhjubah%juubhRX --- the message id numberrr}r(hX --- the message id numberrhjubeubah%jzubjS)r}r(hX3**delay** --- the delay before removing the messagerh'}r(h-]rh/]rh+]rh)]rh1]ruhjh]rhV)r}r(hjhjh h#h%hZh'}r(h-]rh/]rh+]rh)]rh1]ruh4KNh]r(jg)r}r(hX **delay**rh'}r(h-]rh/]rh+]rh)]rh1]ruhjh]rhRXdelayrr}r(hUhjubah%juubhRX* --- the delay before removing the messagerr}r(hX* --- the delay before removing the messagerhjubeubah%jzubeh%jubah%jubeubj#)r}r(hUhjh h#h%j&h'}r(h-]rh/]rh+]rh)]rh1]ruh4KOh5hh]r(j.)r}r(hXReturnsrh'}r(h-]rh/]rh+]rh)]rh1]r uhjh]r hRXReturns r r }r (hUhjubah%j<ubj=)r}r(hX``null``rh'}r(h-]rh/]rh+]rh)]rh1]ruhjh]rhV)r}r(hjhjh h#h%hZh'}r(h-]rh/]rh+]rh)]rh1]ruh4KOh]r hf)r!}r"(hjh'}r#(h-]r$h/]r%h+]r&h)]r'h1]r(uhjh]r)hRXnullr*r+}r,(hUhj!ubah%htubaubah%jubeubeubeubeubh)r-}r.(hUhhh Nh%hh'}r/(h)]r0h+]r1h-]r2h/]r3h1]r4Uentriesr5]r6(jXLog()h h tr7auh4Nh5hh]r8ubj )r9}r:(hUhhh Nh%jh'}r;(jjXpyr<h)]r=h+]r>h-]r?h/]r@h1]rAjXmethodrBjjBuh4Nh5hh]rC(j)rD}rE(hXLog()rFhj9h h#h%j h'}rG(h)]rHh aj#Nh+]rIh-]rJh/]rKh1]rLh aj(h j)Uj*uh4KVh5hh]rM(j,)rN}rO(hh hjDh h#h%j/h'}rP(h-]rQh/]rRh+]rSh)]rTh1]rUuh4KVh5hh]rVhRXLogrWrX}rY(hUhjNubaubj:)rZ}r[(hUhjDh h#h%j=h'}r\(h-]r]h/]r^h+]r_h)]r`h1]rauh4KVh5hh]rbubeubj)rc}rd(hUhj9h h#h%jh'}re(h-]rfh/]rgh+]rhh)]rih1]rjuh4KVh5hh]rk(hV)rl}rm(hXyReturns a string of all the messages issued so far, separated by newlines. This is used in debugging MathJax operations.rnhjch h#h%hZh'}ro(h-]rph/]rqh+]rrh)]rsh1]rtuh4KSh5hh]ruhRXyReturns a string of all the messages issued so far, separated by newlines. This is used in debugging MathJax operations.rvrw}rx(hjnhjlubaubj)ry}rz(hUhjch Nh%jh'}r{(h-]r|h/]r}h+]r~h)]rh1]ruh4Nh5hh]rj#)r}r(hUhjyh h#h%j&h'}r(h-]rh/]rh+]rh)]rh1]ruh4KVh5hh]r(j.)r}r(hXReturnsrh'}r(h-]rh/]rh+]rh)]rh1]ruhjh]rhRXReturns rr}r(hUhjubah%j<ubj=)r}r(hXstring of all messages so farrh'}r(h-]rh/]rh+]rh)]rh1]ruhjh]rhV)r}r(hjhjh h#h%hZh'}r(h-]rh/]rh+]rh)]rh1]ruh4KVh]rhRXstring of all messages so farrr}r(hjhjubaubah%jubeubaubeubeubeubeubehUU transformerrNU footnote_refsr}rUrefnamesr}rUsymbol_footnotesr]rUautofootnote_refsr]rUsymbol_footnote_refsr]rU citationsr]rh5hU current_linerNUtransform_messagesr]rcdocutils.nodes system_message r)r}r(hUh'}r(h-]rUlevelrKh)]rh+]rUsourcerh#h/]rh1]rUlinerKUtyperUINFOruh]rhV)r}r(hUh'}r(h-]rh/]rh+]rh)]rh1]ruhjh]rhRX1Hyperlink target "api-message" is not referenced.rr}r(hUhjubah%hZubah%Usystem_messagerubaUreporterrNUid_startrKU autofootnotesr]rU citation_refsr}rUindirect_targetsr]rUsettingsr(cdocutils.frontend Values ror}r(Ufootnote_backlinksrKUrecord_dependenciesrNU rfc_base_urlrUhttp://tools.ietf.org/html/rU tracebackrKUpep_referencesrNUstrip_commentsrNU toc_backlinksrUentryrU language_coderUenrU datestamprNU report_levelrKU _destinationrNU halt_levelrKU strip_classesrNhJNUerror_encoding_error_handlerrUbackslashreplacerUdebugrNUembed_stylesheetrUoutput_encoding_error_handlerrUstrictrU sectnum_xformrKUdump_transformsrNU docinfo_xformrKUwarning_streamrNUpep_file_url_templaterUpep-%04drUexit_status_levelrKUconfigrNUstrict_visitorrNUcloak_email_addressesrUtrim_footnote_reference_spacerUenvrNUdump_pseudo_xmlrNUexpose_internalsr NUsectsubtitle_xformr U source_linkr NUrfc_referencesr NUoutput_encodingr Uutf-8rU source_urlrNUinput_encodingrU utf-8-sigrU_disable_configrNU id_prefixrUU tab_widthrKUerror_encodingrUUTF-8rU_sourcerUU/Data/Code/JavaScript/MathJax/Code/SourceForge/trunk/mathjax/docs/rst/api/message.rstrU generatorrNUdump_internalsrNU pep_base_urlrUhttp://www.python.org/dev/peps/rUinput_encoding_error_handlerrjUauto_id_prefixrUidrUdoctitle_xformr Ustrip_elements_with_classesr!NU _config_filesr"]r#Ufile_insertion_enabledr$KU raw_enabledr%KU dump_settingsr&NubUsymbol_footnote_startr'KUidsr(}r)(hjh jDhh8h jhh8hhuUsubstitution_namesr*}r+h%h5h'}r,(h-]r-h)]r.h+]r/Usourcer0h#h/]r1h1]r2uU footnotesr3]r4Urefidsr5}r6h]r7hasub.