OSDN Git Service

Docs on Start Up Sequence
authorSimon Forman <sforman@hushmail.com>
Wed, 8 May 2019 06:23:53 +0000 (23:23 -0700)
committerSimon Forman <sforman@hushmail.com>
Wed, 8 May 2019 06:23:53 +0000 (23:23 -0700)
docs/VUI-docs/build/doctrees/environment.pickle
docs/VUI-docs/build/doctrees/index.doctree
docs/VUI-docs/build/html/_sources/index.rst.txt
docs/VUI-docs/build/html/index.html
docs/VUI-docs/build/html/searchindex.js
docs/VUI-docs/source/index.rst

index af23363..ae5e7e7 100644 (file)
Binary files a/docs/VUI-docs/build/doctrees/environment.pickle and b/docs/VUI-docs/build/doctrees/environment.pickle differ
index e5883d0..32d4306 100644 (file)
Binary files a/docs/VUI-docs/build/doctrees/index.doctree and b/docs/VUI-docs/build/doctrees/index.doctree differ
index 7adeebc..528549c 100644 (file)
@@ -152,6 +152,21 @@ Modules
    persist_task\r
 \r
 \r
+Start Up Sequence\r
+------------------------------\r
+\r
+PersistTask is the first (non-PyGame-specific) object created.\r
+\r
+The ``screen``, ``clock``, and ``pt`` are created in ``init()`` and passed\r
+into ``main()``, which calls ``init_context()`` and then starts\r
+the main loop.\r
+\r
+During ``init_context()`` a few text viewers are opened on files\r
+in the home dir with the help of the ``pt``.  Then the main loop\r
+is started and the ``pt`` task is installed and ``pt`` and ``world``\r
+handlers are registered.\r
+\r
+\r
 Indices and tables\r
 ------------------\r
 \r
index 277979e..6017857 100644 (file)
@@ -151,6 +151,17 @@ instead, but for now look for output in the terminal.</p>
 </ul>
 </div>
 </div>
+<div class="section" id="start-up-sequence">
+<h2>Start Up Sequence<a class="headerlink" href="#start-up-sequence" title="Permalink to this headline">¶</a></h2>
+<p>PersistTask is the first (non-PyGame-specific) object created.</p>
+<p>The <code class="docutils literal notranslate"><span class="pre">screen</span></code>, <code class="docutils literal notranslate"><span class="pre">clock</span></code>, and <code class="docutils literal notranslate"><span class="pre">pt</span></code> are created in <code class="docutils literal notranslate"><span class="pre">init()</span></code> and passed
+into <code class="docutils literal notranslate"><span class="pre">main()</span></code>, which calls <code class="docutils literal notranslate"><span class="pre">init_context()</span></code> and then starts
+the main loop.</p>
+<p>During <code class="docutils literal notranslate"><span class="pre">init_context()</span></code> a few text viewers are opened on files
+in the home dir with the help of the <code class="docutils literal notranslate"><span class="pre">pt</span></code>.  Then the main loop
+is started and the <code class="docutils literal notranslate"><span class="pre">pt</span></code> task is installed and <code class="docutils literal notranslate"><span class="pre">pt</span></code> and <code class="docutils literal notranslate"><span class="pre">world</span></code>
+handlers are registered.</p>
+</div>
 <div class="section" id="indices-and-tables">
 <h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h2>
 <ul class="simple">
index c791fdf..68cd713 100644 (file)
@@ -1 +1 @@
-Search.setIndex({docnames:["core","display","index","main","persist_task","stack_viewer","text_viewer","viewer"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.viewcode":1,sphinx:54},filenames:["core.rst","display.rst","index.rst","main.rst","persist_task.rst","stack_viewer.rst","text_viewer.rst","viewer.rst"],objects:{"joy.vui":{core:[0,0,0,"-"],display:[1,0,0,"-"],main:[3,0,0,"-"],persist_task:[4,0,0,"-"],stack_viewer:[5,0,0,"-"],text_viewer:[6,0,0,"-"],viewer:[7,0,0,"-"]},"joy.vui.core":{ARROW_KEYS:[0,1,1,""],AVAILABLE_TASK_EVENTS:[0,1,1,""],CommandMessage:[0,2,1,""],MOUSE_EVENTS:[0,1,1,""],Message:[0,2,1,""],ModifyMessage:[0,2,1,""],OpenMessage:[0,2,1,""],PersistMessage:[0,2,1,""],ShutdownMessage:[0,2,1,""],TASK_EVENTS:[0,1,1,""],TheLoop:[0,2,1,""],World:[0,2,1,""],open_viewer_on_string:[0,4,1,""],push:[0,4,1,""]},"joy.vui.core.TheLoop":{install_task:[0,3,1,""],loop:[0,3,1,""],remove_task:[0,3,1,""],run_task:[0,3,1,""]},"joy.vui.core.World":{handle:[0,3,1,""]},"joy.vui.display":{Display:[1,2,1,""],Track:[1,2,1,""]},"joy.vui.display.Display":{at:[1,3,1,""],broadcast:[1,3,1,""],change_viewer:[1,3,1,""],close_viewer:[1,3,1,""],dispatch_event:[1,3,1,""],done_resizing:[1,3,1,""],focus:[1,3,1,""],grow_viewer:[1,3,1,""],init_text:[1,3,1,""],iter_viewers:[1,3,1,""],open_viewer:[1,3,1,""],redraw:[1,3,1,""]},"joy.vui.display.Track":{broadcast:[1,3,1,""],change_viewer:[1,3,1,""],close_viewer:[1,3,1,""],draw:[1,3,1,""],open_viewer:[1,3,1,""],redraw:[1,3,1,""],split:[1,3,1,""],viewer_at:[1,3,1,""]},"joy.vui.main":{FileFaker:[3,2,1,""],error_guard:[3,4,1,""],init:[3,4,1,""],init_context:[3,4,1,""],load_definitions:[3,4,1,""],load_primitives:[3,4,1,""],main:[3,4,1,""]},"joy.vui.main.FileFaker":{write:[3,3,1,""]},"joy.vui.persist_task":{PersistTask:[4,2,1,""],PickledResource:[4,2,1,""],Resource:[4,2,1,""],check_filename:[4,4,1,""],init_repo:[4,4,1,""],make_repo_relative_path_maker:[4,4,1,""],open_repo:[4,4,1,""]},"joy.vui.persist_task.PersistTask":{commit:[4,3,1,""],handle:[4,3,1,""],handle_modify:[4,3,1,""],handle_open:[4,3,1,""],handle_persist:[4,3,1,""],handle_persist_new:[4,3,1,""],open:[4,3,1,""],persist:[4,3,1,""],scan:[4,3,1,""],task_run:[4,3,1,""]},"joy.vui.persist_task.Resource":{persist:[4,3,1,""]},"joy.vui.stack_viewer":{StackViewer:[5,2,1,""],fsi:[5,4,1,""]},"joy.vui.text_viewer":{TextViewer:[6,2,1,""]},"joy.vui.text_viewer.TextViewer":{at:[6,3,1,""],close:[6,3,1,""]},"joy.vui.viewer":{MenuViewer:[7,2,1,""],SomeViewer:[7,2,1,""],Viewer:[7,2,1,""]},"joy.vui.viewer.MenuViewer":{draw:[7,3,1,""]},"joy.vui.viewer.Viewer":{close:[7,3,1,""],draw:[7,3,1,""],split:[7,3,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","data","Python data"],"2":["py","class","Python class"],"3":["py","method","Python method"],"4":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:data","2":"py:class","3":"py:method","4":"py:function"},terms:{"1024x768":2,"boolean":1,"break":[1,2],"case":1,"class":[0,1,3,4,5,6,7],"default":[2,4],"function":[0,1,2,3,4],"import":2,"new":[1,2,7],"return":[1,4,6,7],"var":2,"while":1,For:0,IDs:0,Not:1,One:2,The:[0,1,2,7],Then:2,There:[1,2],These:2,__contains__:1,abl:2,accept:1,action:2,actual:[0,1],add:0,addit:2,adjust:1,after:2,again:2,aid:2,aka:2,all:[0,1,2,4],along:[1,2],alreadi:[1,2],also:2,ani:[1,2,4,6,7],anoth:[1,2],appear:2,area:1,aren:2,argument:4,around:2,arrow:0,arrow_kei:0,assign:0,auto:[2,4],automat:[1,2],avail:[1,2,7],available_task_ev:0,bar:2,base:[0,7],been:0,begin:2,blank:2,book:1,bootstrap:2,boundari:1,bracket:2,broadcast:[0,1],buggi:2,bunch:0,button:[0,2],bypass:2,call:[1,3],can:[1,2],caus:1,chang:[2,4],change_view:1,chapter:[1,2],charact:6,check:[2,4],check_filenam:4,class_:1,clear:[1,2],click:[0,2],clock:[0,3],close:[0,1,2,6,7],close_view:1,code:[2,3],color:0,column:6,command:[0,1,2],commandmessag:0,commit:4,configur:2,constant:0,contain:0,content:[0,1,2,4],content_id:[0,4],context:[0,1],coord:1,coordin:[1,6,7],copi:[1,2],core:2,corner:1,coupl:1,cover:[1,2],creat:[1,2,3,4],crude:2,current:2,cursor:2,cut:2,dai:2,data:[2,4],deal:[0,4],defin:[0,1],definit:[2,3],delet:2,depend:[2,4],detail:0,develop:2,dict:1,dictionari:[0,2,3],differ:2,dir:[2,4],direct:2,directli:1,directori:[1,2,4],dispatch:[0,4],dispatch_ev:1,displai:[0,2,3],divid:2,docsi:[],docstr:2,doe:[1,4],doesn:4,don:1,done:1,done_res:1,dosen:2,down:0,drag:[1,2],draw:[1,7],dulwich:[2,4],dunno:[],each:[1,2],edit:2,editor:2,effect:4,effici:1,els:1,end:2,enough:2,entir:2,environ:2,error_guard:3,escap:0,etc:[1,6,7],eval:3,evalu:3,event:[0,1,2,3],ever:2,everi:0,everyth:3,except:[1,3,4],execut:2,exist:[1,4],exit:0,expos:[1,2],facilit:1,fals:[1,4],feedback:2,feel:2,few:2,field:0,file:[1,2,3,4],filefak:3,filenam:[1,4],fill:2,first:2,fix:2,flag:0,focu:1,follow:2,foo:4,format:5,forth:2,four:1,framer:0,free:2,freed:1,from:3,frozenset:0,fsi:5,full:2,fullscreen:2,further:2,gain:1,get:[1,2,7],git:[2,4],give:0,given:[1,4,6],going:[1,2],good:[],grab:2,graphic:2,group:0,grow:[1,2],grow_view:1,gui:2,guid:[],hackili:1,handi:2,handl:[0,1,4],handle_foo:4,handle_modifi:4,handle_open:4,handle_persist:4,handle_persist_new:4,handler:[1,3],happen:1,has:2,have:[0,1,2],height:[1,7],help:2,helper:[0,1,4],hidden:[1,2],hide:1,highest:2,highlight:2,hold:[0,1],home:[2,3,4],horizont:2,how:[],idea:[],immedi:2,impair:2,implement:1,index:2,indic:1,inform:1,init:[3,4],init_context:3,init_repo:4,init_text:1,initi:[3,4],insid:7,instal:[0,2],install_task:0,instead:[1,2,3],intend:2,interact:2,interest:2,interfac:2,interpret:2,invers:1,isn:4,item:[0,2,5],iter:1,iter_view:1,its:[0,1,2,4,7],joi:[0,1,3,4,5,6,7],joy_hom:[2,4],joyhom:1,joypi:[],just:[2,3],keep:[0,2],kei:[0,2],kind:2,languag:2,larger:1,last:1,layout:2,least:1,leav:2,left:[1,2],less:2,let:[2,3],librari:[2,3],like:2,line:[2,4,6],list:[2,4],littl:2,load:3,load_definit:3,load_primit:3,locat:[1,2],log:[0,2,3],look:[2,4],lookup:1,loop:[0,3],loos:1,lost:2,lower:7,machineri:[0,1,2],main:[0,2],mainloop:0,maintain:0,make_repo_relative_path_mak:4,manag:[0,1],mani:0,marker:2,mask:3,menu:[2,3],menuview:[1,7],messag:[0,1,3,4],method:[0,1,4],middl:2,millisecond:0,model:[1,2],modifi:0,modifymessag:0,modul:[0,1,4],more:[1,2,3],mous:[0,1,2],mouse_ev:0,mouse_up:1,mousemot:1,move:2,much:2,must:[1,7],name:[0,1,2,4],name_spac:3,neighbor:1,new_i:1,none:[1,4],note:2,notgitrepositori:4,notifi:0,now:7,nowher:2,number:[1,2],oberon:[0,1,2],object:[0,1,3,4],old:1,one:[1,2],ones:1,onli:[1,2],onto:[0,1,7],open:[0,1,2,3,4],open_repo:4,open_resource_at_good_loc:2,open_view:1,open_viewer_on_str:0,openmessag:0,option:2,order:1,other:2,otherwis:[1,4],out:2,output:2,outsid:2,outstand:4,overlai:1,page:2,paramet:1,pars:2,part:[1,7],pass:[0,1,2],path:4,paus:2,per:2,persist:2,persist_task:4,persistmessag:0,persisttask:[3,4],pickl:[0,3,4],pickledresourc:4,pixel:[1,2],plai:2,point:2,pop:2,possibl:0,present:1,press:[0,2],pretend:3,pretti:2,previou:2,primit:[2,3],print:[2,3],program:2,project:[1,2],provid:2,pull:3,pump:0,push:0,pygam:[0,1,2,3],python:[2,3],queue:0,quickli:2,quot:2,rais:4,ratio:1,realli:2,record:2,recov:2,rect:1,redirect:3,redraw:1,redrawn:7,refer:[0,1],regist:[1,3],rel:[1,4,7],releas:[2,6,7],remain:7,remov:0,remove_task:0,repo:4,repo_dir:4,repo_relative_filenam:4,repositori:4,reset:2,reset_log:2,resiz:[1,2],resolut:2,resourc:[0,2,4,6,7],rest:2,restart:2,restor:1,result:4,retain:1,retri:3,reus:[1,2],reveal:1,right:2,row:6,run:[0,2,3],run_task:0,runtim:2,same:[1,2],saniti:4,save:[2,4],scan:4,scratch:3,screen:[1,2,3,6],script:2,scroll:2,search:2,see:2,see_resourc:2,seem:2,select:2,send:[1,2],sender:[0,1],set:[0,1,2,3],share:2,shift:2,shine:0,should:[1,2],show:[0,2],shut:0,shutdownmessag:0,signal:0,simpl:[1,2],sit:2,size:[1,2],small:1,some:[0,1,2,3],someth:1,someview:7,somewher:[2,7],sort:[1,4],sourc:[0,1,3,4,5,6,7],space:[1,7],special:2,split:[1,7],stack:[0,2,3,4],stack_hold:0,stack_id:0,stack_nam:0,stack_view:5,stackview:[2,5],stage:4,start:3,state:2,statu:0,stderr:3,stdout:[2,3],store:2,string:[0,1,2],strip:1,style:0,subclass:4,subdirectori:4,subject:0,success:[],support:[1,2],surfac:[1,5,6,7],symbol:2,sys:3,system:[0,1,2,3],take:[1,2],task:[0,2],task_ev:0,task_event_id:0,task_run:4,tend:2,termin:2,text:[0,2,3,4],text_view:6,textview:[1,2,6],than:1,thei:[1,2],theloop:0,them:2,ther:[],thi:[0,1,2,4],thing:[2,4],those:4,three:[1,2],through:1,thun:2,tick:0,tile:2,time:[0,1,2],togeth:3,too:1,top:[1,2],toplevel:4,traceback:[0,3],track:[0,1,2],track_ratio:1,trap:2,tupl:1,two:[1,2],txt:[2,3],type:2,typic:[0,1],underlin:[1,2],until:2,updat:[0,1,2],upper:7,usabl:2,use:2,used:0,usefulness:2,user:[2,3],uses:4,using:[2,3],usual:2,valid:1,valu:2,veri:2,version:2,vertic:[1,2],viewer:[0,1,2,3],viewer_at:1,visual:[1,2],vui:[0,1,3,4,5,6,7],want:[1,2],well:2,were:2,what:2,wheel:2,when:[0,1,2],where:2,whether:1,which:[1,2,7],whole:[1,2],wide:0,wider:1,width:2,wiggl:2,window:[0,2,3],within:1,won:2,word:2,work:[],workaround:2,world:[0,1,3],would:1,write:[2,3],written:2,x11:2,yet:2,yield:1,you:[1,2,3],your:2,zero:[1,2]},titles:["Core","Display","Welcome to Joy VUI\u2019s documentation!","Main Module","Persist Task","Stack Viewer","Text Viewer","Viewer"],titleterms:{"import":[],core:0,displai:1,document:2,guid:2,how:2,indic:2,joi:2,main:3,modul:[2,3],now:2,persist:4,quick:2,screenshot:2,stack:5,start:2,structur:[],tabl:2,task:4,text:6,viewer:[5,6,7],vui:2,welcom:2,work:2}})
\ No newline at end of file
+Search.setIndex({docnames:["core","display","index","main","persist_task","stack_viewer","text_viewer","viewer"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.viewcode":1,sphinx:54},filenames:["core.rst","display.rst","index.rst","main.rst","persist_task.rst","stack_viewer.rst","text_viewer.rst","viewer.rst"],objects:{"joy.vui":{core:[0,0,0,"-"],display:[1,0,0,"-"],main:[3,0,0,"-"],persist_task:[4,0,0,"-"],stack_viewer:[5,0,0,"-"],text_viewer:[6,0,0,"-"],viewer:[7,0,0,"-"]},"joy.vui.core":{ARROW_KEYS:[0,1,1,""],AVAILABLE_TASK_EVENTS:[0,1,1,""],CommandMessage:[0,2,1,""],MOUSE_EVENTS:[0,1,1,""],Message:[0,2,1,""],ModifyMessage:[0,2,1,""],OpenMessage:[0,2,1,""],PersistMessage:[0,2,1,""],ShutdownMessage:[0,2,1,""],TASK_EVENTS:[0,1,1,""],TheLoop:[0,2,1,""],World:[0,2,1,""],open_viewer_on_string:[0,4,1,""],push:[0,4,1,""]},"joy.vui.core.TheLoop":{install_task:[0,3,1,""],loop:[0,3,1,""],remove_task:[0,3,1,""],run_task:[0,3,1,""]},"joy.vui.core.World":{handle:[0,3,1,""]},"joy.vui.display":{Display:[1,2,1,""],Track:[1,2,1,""]},"joy.vui.display.Display":{at:[1,3,1,""],broadcast:[1,3,1,""],change_viewer:[1,3,1,""],close_viewer:[1,3,1,""],dispatch_event:[1,3,1,""],done_resizing:[1,3,1,""],focus:[1,3,1,""],grow_viewer:[1,3,1,""],init_text:[1,3,1,""],iter_viewers:[1,3,1,""],open_viewer:[1,3,1,""],redraw:[1,3,1,""]},"joy.vui.display.Track":{broadcast:[1,3,1,""],change_viewer:[1,3,1,""],close_viewer:[1,3,1,""],draw:[1,3,1,""],open_viewer:[1,3,1,""],redraw:[1,3,1,""],split:[1,3,1,""],viewer_at:[1,3,1,""]},"joy.vui.main":{FileFaker:[3,2,1,""],error_guard:[3,4,1,""],init:[3,4,1,""],init_context:[3,4,1,""],load_definitions:[3,4,1,""],load_primitives:[3,4,1,""],main:[3,4,1,""]},"joy.vui.main.FileFaker":{write:[3,3,1,""]},"joy.vui.persist_task":{PersistTask:[4,2,1,""],PickledResource:[4,2,1,""],Resource:[4,2,1,""],check_filename:[4,4,1,""],init_repo:[4,4,1,""],make_repo_relative_path_maker:[4,4,1,""],open_repo:[4,4,1,""]},"joy.vui.persist_task.PersistTask":{commit:[4,3,1,""],handle:[4,3,1,""],handle_modify:[4,3,1,""],handle_open:[4,3,1,""],handle_persist:[4,3,1,""],handle_persist_new:[4,3,1,""],open:[4,3,1,""],persist:[4,3,1,""],scan:[4,3,1,""],task_run:[4,3,1,""]},"joy.vui.persist_task.Resource":{persist:[4,3,1,""]},"joy.vui.stack_viewer":{StackViewer:[5,2,1,""],fsi:[5,4,1,""]},"joy.vui.text_viewer":{TextViewer:[6,2,1,""]},"joy.vui.text_viewer.TextViewer":{at:[6,3,1,""],close:[6,3,1,""]},"joy.vui.viewer":{MenuViewer:[7,2,1,""],SomeViewer:[7,2,1,""],Viewer:[7,2,1,""]},"joy.vui.viewer.MenuViewer":{draw:[7,3,1,""]},"joy.vui.viewer.Viewer":{close:[7,3,1,""],draw:[7,3,1,""],split:[7,3,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","data","Python data"],"2":["py","class","Python class"],"3":["py","method","Python method"],"4":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:data","2":"py:class","3":"py:method","4":"py:function"},terms:{"1024x768":2,"boolean":1,"break":[1,2],"case":1,"class":[0,1,3,4,5,6,7],"default":[2,4],"function":[0,1,2,3,4],"import":2,"new":[1,2,7],"return":[1,4,6,7],"var":2,"while":1,For:0,IDs:0,Not:1,One:2,The:[0,1,2,7],Then:2,There:[1,2],These:2,__contains__:1,abl:2,accept:1,action:2,actual:[0,1],add:0,addit:2,adjust:1,after:2,again:2,aid:2,aka:2,all:[0,1,2,4],along:[1,2],alreadi:[1,2],also:2,ani:[1,2,4,6,7],anoth:[1,2],appear:2,area:1,aren:2,argument:4,around:2,arrow:0,arrow_kei:0,assign:0,auto:[2,4],automat:[1,2],avail:[1,2,7],available_task_ev:0,bar:2,base:[0,7],been:0,begin:2,blank:2,book:1,bootstrap:2,boundari:1,bracket:2,broadcast:[0,1],buggi:2,bunch:0,button:[0,2],bypass:2,call:[1,2,3],can:[1,2],caus:1,chang:[2,4],change_view:1,chapter:[1,2],charact:6,check:[2,4],check_filenam:4,class_:1,clear:[1,2],click:[0,2],clock:[0,2,3],close:[0,1,2,6,7],close_view:1,code:[2,3],color:0,column:6,command:[0,1,2],commandmessag:0,commit:4,configur:2,constant:0,contain:0,content:[0,1,2,4],content_id:[0,4],context:[0,1],coord:1,coordin:[1,6,7],copi:[1,2],core:2,corner:1,coupl:1,cover:[1,2],creat:[1,2,3,4],crude:2,current:2,cursor:2,cut:2,dai:2,data:[2,4],deal:[0,4],defin:[0,1],definit:[2,3],delet:2,depend:[2,4],detail:0,develop:2,dict:1,dictionari:[0,2,3],differ:2,dir:[2,4],direct:2,directli:1,directori:[1,2,4],dispatch:[0,4],dispatch_ev:1,displai:[0,2,3],divid:2,docsi:[],docstr:2,doe:[1,4],doesn:4,don:1,done:1,done_res:1,dosen:2,down:0,drag:[1,2],draw:[1,7],dulwich:[2,4],dunno:[],dure:2,each:[1,2],edit:2,editor:2,effect:4,effici:1,els:1,end:2,enough:2,entir:2,environ:2,error_guard:3,escap:0,etc:[1,6,7],eval:3,evalu:3,event:[0,1,2,3],ever:2,everi:0,everyth:3,except:[1,3,4],execut:2,exist:[1,4],exit:0,expos:[1,2],facilit:1,fals:[1,4],feedback:2,feel:2,few:2,field:0,file:[1,2,3,4],filefak:3,filenam:[1,4],fill:2,first:2,fix:2,flag:0,focu:1,follow:2,foo:4,format:5,forth:2,four:1,framer:0,free:2,freed:1,from:3,frozenset:0,fsi:5,full:2,fullscreen:2,further:2,gain:1,get:[1,2,7],git:[2,4],give:0,given:[1,4,6],going:[1,2],good:[],grab:2,graphic:2,group:0,grow:[1,2],grow_view:1,gui:2,guid:[],hackili:1,handi:2,handl:[0,1,4],handle_foo:4,handle_modifi:4,handle_open:4,handle_persist:4,handle_persist_new:4,handler:[1,2,3],happen:1,has:2,have:[0,1,2],height:[1,7],help:2,helper:[0,1,4],hidden:[1,2],hide:1,highest:2,highlight:2,hold:[0,1],home:[2,3,4],horizont:2,how:[],idea:[],immedi:2,impair:2,implement:1,index:2,indic:1,inform:1,init:[2,3,4],init_context:[2,3],init_repo:4,init_text:1,initi:[3,4],insid:7,instal:[0,2],install_task:0,instead:[1,2,3],intend:2,interact:2,interest:2,interfac:2,interpret:2,invers:1,isn:4,item:[0,2,5],iter:1,iter_view:1,its:[0,1,2,4,7],joi:[0,1,3,4,5,6,7],joy_hom:[2,4],joyhom:1,joypi:[],just:[2,3],keep:[0,2],kei:[0,2],kind:2,languag:2,larger:1,last:1,layout:2,least:1,leav:2,left:[1,2],less:2,let:[2,3],librari:[2,3],like:2,line:[2,4,6],list:[2,4],littl:2,load:3,load_definit:3,load_primit:3,locat:[1,2],log:[0,2,3],look:[2,4],lookup:1,loop:[0,2,3],loos:1,lost:2,lower:7,machineri:[0,1,2],main:[0,2],mainloop:0,maintain:0,make_repo_relative_path_mak:4,manag:[0,1],mani:0,marker:2,mask:3,menu:[2,3],menuview:[1,7],messag:[0,1,3,4],method:[0,1,4],middl:2,millisecond:0,model:[1,2],modifi:0,modifymessag:0,modul:[0,1,4],more:[1,2,3],mous:[0,1,2],mouse_ev:0,mouse_up:1,mousemot:1,move:2,much:2,must:[1,7],name:[0,1,2,4],name_spac:3,neighbor:1,new_i:1,non:2,none:[1,4],note:2,notgitrepositori:4,notifi:0,now:7,nowher:2,number:[1,2],oberon:[0,1,2],object:[0,1,2,3,4],old:1,one:[1,2],ones:1,onli:[1,2],onto:[0,1,7],open:[0,1,2,3,4],open_repo:4,open_resource_at_good_loc:2,open_view:1,open_viewer_on_str:0,openmessag:0,option:2,order:1,other:2,otherwis:[1,4],out:2,output:2,outsid:2,outstand:4,overlai:1,page:2,paramet:1,pars:2,part:[1,7],pass:[0,1,2],path:4,paus:2,per:2,persist:2,persist_task:4,persistmessag:0,persisttask:[2,3,4],pickl:[0,3,4],pickledresourc:4,pixel:[1,2],plai:2,point:2,pop:2,possibl:0,present:1,press:[0,2],pretend:3,pretti:2,previou:2,primit:[2,3],print:[2,3],program:2,project:[1,2],provid:2,pull:3,pump:0,push:0,pygam:[0,1,2,3],python:[2,3],queue:0,quickli:2,quot:2,rais:4,ratio:1,realli:2,record:2,recov:2,rect:1,redirect:3,redraw:1,redrawn:7,refer:[0,1],regist:[1,2,3],rel:[1,4,7],releas:[2,6,7],remain:7,remov:0,remove_task:0,repo:4,repo_dir:4,repo_relative_filenam:4,repositori:4,reset:2,reset_log:2,resiz:[1,2],resolut:2,resourc:[0,2,4,6,7],rest:2,restart:2,restor:1,result:4,retain:1,retri:3,reus:[1,2],reveal:1,right:2,row:6,run:[0,2,3],run_task:0,runtim:2,same:[1,2],saniti:4,save:[2,4],scan:4,scratch:3,screen:[1,2,3,6],script:2,scroll:2,search:2,see:2,see_resourc:2,seem:2,select:2,send:[1,2],sender:[0,1],set:[0,1,2,3],share:2,shift:2,shine:0,should:[1,2],show:[0,2],shut:0,shutdownmessag:0,signal:0,simpl:[1,2],sit:2,size:[1,2],small:1,some:[0,1,2,3],someth:1,someview:7,somewher:[2,7],sort:[1,4],sourc:[0,1,3,4,5,6,7],space:[1,7],special:2,specif:2,split:[1,7],stack:[0,2,3,4],stack_hold:0,stack_id:0,stack_nam:0,stack_view:5,stackview:[2,5],stage:4,start:3,state:2,statu:0,stderr:3,stdout:[2,3],store:2,string:[0,1,2],strip:1,style:0,subclass:4,subdirectori:4,subject:0,success:[],support:[1,2],surfac:[1,5,6,7],symbol:2,sys:3,system:[0,1,2,3],take:[1,2],task:[0,2],task_ev:0,task_event_id:0,task_run:4,tend:2,termin:2,text:[0,2,3,4],text_view:6,textview:[1,2,6],than:1,thei:[1,2],theloop:0,them:2,ther:[],thi:[0,1,2,4],thing:[2,4],those:4,three:[1,2],through:1,thun:2,tick:0,tile:2,time:[0,1,2],togeth:3,too:1,top:[1,2],toplevel:4,traceback:[0,3],track:[0,1,2],track_ratio:1,trap:2,tupl:1,two:[1,2],txt:[2,3],type:2,typic:[0,1],underlin:[1,2],until:2,updat:[0,1,2],upper:7,usabl:2,use:2,used:0,usefulness:2,user:[2,3],uses:4,using:[2,3],usual:2,valid:1,valu:2,veri:2,version:2,vertic:[1,2],viewer:[0,1,2,3],viewer_at:1,visual:[1,2],vui:[0,1,3,4,5,6,7],want:[1,2],well:2,were:2,what:2,wheel:2,when:[0,1,2],where:2,whether:1,which:[1,2,7],whole:[1,2],wide:0,wider:1,width:2,wiggl:2,window:[0,2,3],within:1,won:2,word:2,work:[],workaround:2,world:[0,1,2,3],would:1,write:[2,3],written:2,x11:2,yet:2,yield:1,you:[1,2,3],your:2,zero:[1,2]},titles:["Core","Display","Welcome to Joy VUI\u2019s documentation!","Main Module","Persist Task","Stack Viewer","Text Viewer","Viewer"],titleterms:{"import":[],core:0,displai:1,document:2,guid:2,how:2,indic:2,joi:2,main:3,modul:[2,3],now:2,persist:4,quick:2,screenshot:2,sequenc:2,stack:5,start:2,structur:[],tabl:2,task:4,text:6,viewer:[5,6,7],vui:2,welcom:2,work:2}})
\ No newline at end of file
index 7adeebc..528549c 100644 (file)
@@ -152,6 +152,21 @@ Modules
    persist_task\r
 \r
 \r
+Start Up Sequence\r
+------------------------------\r
+\r
+PersistTask is the first (non-PyGame-specific) object created.\r
+\r
+The ``screen``, ``clock``, and ``pt`` are created in ``init()`` and passed\r
+into ``main()``, which calls ``init_context()`` and then starts\r
+the main loop.\r
+\r
+During ``init_context()`` a few text viewers are opened on files\r
+in the home dir with the help of the ``pt``.  Then the main loop\r
+is started and the ``pt`` task is installed and ``pt`` and ``world``\r
+handlers are registered.\r
+\r
+\r
 Indices and tables\r
 ------------------\r
 \r