Added Navigation docs

docs/_sources/manual/navigation.rst.txt

@@ -1,3 +1,88 @@
 **********
 Navigation
-**********
+**********
+
+Porymap can seem daunting at first because it has many buttons, tabs, panes, and windows.  Let's briefly go over the different parts of the application.
+
+Map List
+--------
+
+The map list contains a hierarchical view of all of the maps in your project.  It is situated on the left side of Porymap's main window.  To switch to a different map, simply double-click or press ``Enter`` on the desired map's name.  Larger maps can take a few seconds to load the first time, so be patient.
+
+.. figure:: images/navigation/map-list-pane.png
+    :alt: Map List Pane
+
+    Map List Pane
+
+By default, the maps are organized by their map groups.  The *Sort Map List* |sort-map-list-button| button gives you some other options to organize the maps:
+
+Sort by Group
+    Organizes by map groups.
+
+Sort by Area
+    Organizes by region map section.
+
+Sort by Layout
+    Organizes by map layouts. Most layouts are only used by a single map, but layouts like the Pokemon Center are used by many maps.
+
+The *Expand All* |expand-all-button| and *Collapse All* |collapse-all-button| buttons will expand or collapse all of the map folders.
+
+Type in the filter to show maps that contain the filter text.
+
+.. figure:: images/navigation/filter-map-list.png
+    :alt: Filter Map List
+
+    Filter Map List
+
+.. |sort-map-list-button|
+   image:: images/navigation/sort-map-list-button.png
+
+.. |expand-all-button|
+   image:: images/navigation/expand-all-button.png
+
+.. |collapse-all-button|
+   image:: images/navigation/collapse-all-button.png
+
+Main Window
+-----------
+
+Most of the work you do in Porymap is in the center Main Window.  It features 4 tabbed views which each have different purposes, but they all operate within the context of the currently-opened map in the Map List.  Let's quickly summarize what each of these tabs is used for.
+
+.. figure:: images/navigation/main-window-tabs.png
+    :alt: Main Window Tabs
+
+    Main Window Tabs
+
+Map Tab
+    Paint metatiles and their collision properties to change the appearance of the map and how the player can walk around the map.  When the Map Tab is selected, the pane on the right side of the map will have two tabs: Metatiles and Collision.  You can switch between these to paint either metatiles or collision properties onto the map.
+
+Events Tab
+    Edit the interactable events on the map.  This includes things like objects, warps, script triggers, and more.
+
+Header Tab
+    Choose various gameplay properties to set for the map. This includes things like background music and weather.
+
+Connections Tab
+    Change how the map connects with surrounding maps when the player walks from one to another.
+
+Tileset Editor
+--------------
+
+The Tileset Editor can be opened with *File -> Tileset Editor*.  When the Tileset Editor is opened, it is opened in the context of the currently-opened map.  Every map has a primary and secondary tileset, so you will work with a combination of the two whenever you use the Tileset Editor.  The left-side pane shows the primary and secondary tilesets' metatiles.  The right-side panes allow you to modify the currently-selected metatile.
+
+.. figure:: images/navigation/tileset-editor.png
+    :alt: Tileset Editor
+
+    Tileset Editor
+
+Region Map Editor
+-----------------
+
+The Region Map Editor can be opened with *File -> Region Map Editor*. This window will allow you to modify the look and layout of maps on the game's region map.  You can also modify the city map images using the bottom two panes.
+
+.. figure:: images/navigation/region-map-editor.png
+    :alt: Region Map Editor
+
+    Region Map Editor
+
+We covered all of the basic views and windows of Porymap above.  Next, let's learn how to use Porymap's features to the fullest when editing map tiles.

docs/index.html

@@ -168,7 +168,13 @@
 <li class="toctree-l2"><a class="reference internal" href="manual/introduction.html#getting-started">Getting Started</a></li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="manual/navigation.html">Navigation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="manual/navigation.html">Navigation</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="manual/navigation.html#map-list">Map List</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/navigation.html#main-window">Main Window</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/navigation.html#tileset-editor">Tileset Editor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="manual/navigation.html#region-map-editor">Region Map Editor</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="manual/editing-map-tiles.html">Editing Map Tiles</a></li>
 <li class="toctree-l1"><a class="reference internal" href="manual/editing-map-events.html">Editing Map Events</a></li>
 </ul>

docs/manual/navigation.html

@@ -83,7 +83,13 @@
               <p class="caption"><span class="caption-text">User Manual</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li>
-<li class="toctree-l1 current"><a class="current reference internal" href="#">Navigation</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Navigation</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#map-list">Map List</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#main-window">Main Window</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#tileset-editor">Tileset Editor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#region-map-editor">Region Map Editor</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="editing-map-tiles.html">Editing Map Tiles</a></li>
 <li class="toctree-l1"><a class="reference internal" href="editing-map-events.html">Editing Map Events</a></li>
 </ul>
@@ -157,6 +163,65 @@
             
   <div class="section" id="navigation">
 <h1>Navigation<a class="headerlink" href="#navigation" title="Permalink to this headline">¶</a></h1>
+<p>Porymap can seem daunting at first because it has many buttons, tabs, panes, and windows.  Let’s briefly go over the different parts of the application.</p>
+<div class="section" id="map-list">
+<h2>Map List<a class="headerlink" href="#map-list" title="Permalink to this headline">¶</a></h2>
+<p>The map list contains a hierarchical view of all of the maps in your project.  It is situated on the left side of Porymap’s main window.  To switch to a different map, simply double-click or press <code class="docutils literal notranslate"><span class="pre">Enter</span></code> on the desired map’s name.  Larger maps can take a few seconds to load the first time, so be patient.</p>
+<div class="figure" id="id1">
+<img alt="Map List Pane" src="../_images/map-list-pane.png" />
+<p class="caption"><span class="caption-text">Map List Pane</span></p>
+</div>
+<p>By default, the maps are organized by their map groups.  The <em>Sort Map List</em> <img alt="sort-map-list-button" src="../_images/sort-map-list-button.png" /> button gives you some other options to organize the maps:</p>
+<dl class="docutils">
+<dt>Sort by Group</dt>
+<dd>Organizes by map groups.</dd>
+<dt>Sort by Area</dt>
+<dd>Organizes by region map section.</dd>
+<dt>Sort by Layout</dt>
+<dd>Organizes by map layouts. Most layouts are only used by a single map, but layouts like the Pokemon Center are used by many maps.</dd>
+</dl>
+<p>The <em>Expand All</em> <img alt="expand-all-button" src="../_images/expand-all-button.png" /> and <em>Collapse All</em> <img alt="collapse-all-button" src="../_images/collapse-all-button.png" /> buttons will expand or collapse all of the map folders.</p>
+<p>Type in the filter to show maps that contain the filter text.</p>
+<div class="figure" id="id2">
+<img alt="Filter Map List" src="../_images/filter-map-list.png" />
+<p class="caption"><span class="caption-text">Filter Map List</span></p>
+</div>
+</div>
+<div class="section" id="main-window">
+<h2>Main Window<a class="headerlink" href="#main-window" title="Permalink to this headline">¶</a></h2>
+<p>Most of the work you do in Porymap is in the center Main Window.  It features 4 tabbed views which each have different purposes, but they all operate within the context of the currently-opened map in the Map List.  Let’s quickly summarize what each of these tabs is used for.</p>
+<div class="figure" id="id3">
+<img alt="Main Window Tabs" src="../_images/main-window-tabs.png" />
+<p class="caption"><span class="caption-text">Main Window Tabs</span></p>
+</div>
+<dl class="docutils">
+<dt>Map Tab</dt>
+<dd>Paint metatiles and their collision properties to change the appearance of the map and how the player can walk around the map.  When the Map Tab is selected, the pane on the right side of the map will have two tabs: Metatiles and Collision.  You can switch between these to paint either metatiles or collision properties onto the map.</dd>
+<dt>Events Tab</dt>
+<dd>Edit the interactable events on the map.  This includes things like objects, warps, script triggers, and more.</dd>
+<dt>Header Tab</dt>
+<dd>Choose various gameplay properties to set for the map. This includes things like background music and weather.</dd>
+<dt>Connections Tab</dt>
+<dd>Change how the map connects with surrounding maps when the player walks from one to another.</dd>
+</dl>
+</div>
+<div class="section" id="tileset-editor">
+<h2>Tileset Editor<a class="headerlink" href="#tileset-editor" title="Permalink to this headline">¶</a></h2>
+<p>The Tileset Editor can be opened with <em>File -&gt; Tileset Editor</em>.  When the Tileset Editor is opened, it is opened in the context of the currently-opened map.  Every map has a primary and secondary tileset, so you will work with a combination of the two whenever you use the Tileset Editor.  The left-side pane shows the primary and secondary tilesets’ metatiles.  The right-side panes allow you to modify the currently-selected metatile.</p>
+<div class="figure" id="id4">
+<img alt="Tileset Editor" src="../_images/tileset-editor.png" />
+<p class="caption"><span class="caption-text">Tileset Editor</span></p>
+</div>
+</div>
+<div class="section" id="region-map-editor">
+<h2>Region Map Editor<a class="headerlink" href="#region-map-editor" title="Permalink to this headline">¶</a></h2>
+<p>The Region Map Editor can be opened with <em>File -&gt; Region Map Editor</em>. This window will allow you to modify the look and layout of maps on the game’s region map.  You can also modify the city map images using the bottom two panes.</p>
+<div class="figure" id="id5">
+<img alt="Region Map Editor" src="../_images/region-map-editor.png" />
+<p class="caption"><span class="caption-text">Region Map Editor</span></p>
+</div>
+<p>We covered all of the basic views and windows of Porymap above.  Next, let’s learn how to use Porymap’s features to the fullest when editing map tiles.</p>
+</div>
 </div>
 
 

docs/searchindex.js

@@ -1 +1 @@
-Search.setIndex({docnames:["index","manual/editing-map-events","manual/editing-map-tiles","manual/introduction","manual/navigation","reference/changelog","reference/related-projects"],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:54},filenames:["index.rst","manual\\editing-map-events.rst","manual\\editing-map-tiles.rst","manual\\introduction.rst","manual\\navigation.rst","reference\\changelog.rst","reference\\related-projects.rst"],objects:{},objnames:{},objtypes:{},terms:{"0x4":3,"final":3,"function":3,Its:3,That:3,The:3,There:3,about:0,abov:3,addit:3,advanc:3,after:3,allow:3,area:3,avail:3,basic:3,befor:3,being:3,binari:3,build:3,button:3,can:[0,3],chang:3,changelog:0,choos:3,citi:3,click:3,collis:3,com:0,compil:3,connect:3,control:3,cross:3,ctrl:3,current:3,data:3,decompil:3,dialog:3,difficulti:3,displai:3,doe:3,doing:3,down:3,download:3,draw:3,edit:[0,3],editor:3,empti:3,equival:3,event:[0,3],except:3,exist:3,familiar:3,featur:3,feel:0,few:3,file:3,find:0,first:3,flower:3,floweri:3,folder:3,follow:3,found:3,from:3,game:3,gen:3,gener:3,get:0,git:3,github:0,grass:3,great:3,greet:3,hack:3,have:3,highli:3,how:3,http:0,huderlem:0,ignor:3,improv:3,instal:3,introduct:0,launch:3,learn:3,left:3,let:3,linux:3,load:3,locat:3,look:[0,3],mac:3,main:3,make:3,mani:3,manual:0,map:[0,3],metatil:3,miss:0,more:3,most:3,much:3,must:3,navig:[0,3],next:3,nodep:3,notabl:3,now:3,open:3,our:3,out:0,paint:3,panel:3,pencil:3,petalburg:3,place:3,platform:3,pleas:0,pokeemerald:3,pokemon:3,pokerubi:3,pop:3,press:3,pret:3,primari:3,project:[0,3],properti:3,provid:3,reach:0,read:3,recommend:3,redo:3,refer:0,region:3,relat:0,releas:3,respect:3,result:3,rom:3,same:3,save:3,screen:3,second:3,see:3,select:3,setup:3,shortcut:3,should:3,shouldn:3,show:3,side:3,sinc:3,some:3,someth:0,sourc:3,start:0,successfulli:3,support:3,sure:3,take:3,therefor:3,thing:3,think:3,those:3,tile:[0,3],tileset:3,time:3,tool:3,toolbar:3,tradit:3,undo:3,usabl:3,use:3,user:[0,3],using:3,variou:3,version:3,what:0,when:3,wild:3,window:3,work:3,workflow:3,write:3,you:[0,3],your:3},titles:["Porymap Documentation","Editing Map Events","Editing Map Tiles","Introduction","Navigation","Changelog","Related Projects"],titleterms:{about:3,changelog:5,document:0,edit:[1,2],event:1,get:3,introduct:3,map:[1,2],navig:4,porymap:[0,3],project:6,relat:6,start:3,tile:2}})
+Search.setIndex({docnames:["index","manual/editing-map-events","manual/editing-map-tiles","manual/introduction","manual/navigation","reference/changelog","reference/related-projects"],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:54},filenames:["index.rst","manual\\editing-map-events.rst","manual\\editing-map-tiles.rst","manual\\introduction.rst","manual\\navigation.rst","reference\\changelog.rst","reference\\related-projects.rst"],objects:{},objnames:{},objtypes:{},terms:{"0x4":3,"23asdf":[],"default":4,"final":3,"function":3,"switch":4,Its:3,That:3,The:[3,4],There:3,about:0,abov:[3,4],addit:3,advanc:3,after:3,all:4,allow:[3,4],also:4,anoth:4,appear:4,applic:4,area:[3,4],around:4,asdfasdf:[],avail:3,background:4,basic:[3,4],becaus:4,befor:3,being:3,between:4,binari:3,blah:[],bottom:4,breifli:[],briefli:4,build:3,button:[3,4],can:[0,3,4],center:4,chang:[3,4],changelog:0,choos:[3,4],citi:[3,4],click:[3,4],collaps:4,collis:[3,4],com:0,combin:4,compil:3,connect:[3,4],contain:4,context:4,control:3,cover:4,cross:3,ctrl:3,current:[3,4],data:3,daunt:4,decompil:3,desir:4,dialog:3,differ:4,difficulti:3,displai:3,doe:3,doing:3,doubl:4,down:3,download:3,draw:3,each:4,edit:[0,3,4],editor:[0,3],either:4,empti:3,enter:4,equival:3,event:[0,3,4],everi:4,except:3,exist:3,expand:4,familiar:3,featur:[3,4],feel:0,few:[3,4],file:[3,4],filter:4,find:0,first:[3,4],flower:3,floweri:3,folder:[3,4],follow:3,found:3,from:[3,4],fullest:4,game:[3,4],gameplai:4,gen:3,gener:3,get:0,git:3,github:0,give:4,grass:3,great:3,greet:3,group:4,hack:3,has:4,have:[3,4],header:4,hierarch:4,highli:3,how:[3,4],http:0,huderlem:0,ignor:3,imag:4,improv:3,includ:4,instal:3,interact:4,introduct:0,larger:4,launch:3,layout:4,learn:[3,4],left:[3,4],let:[3,4],like:4,linux:3,list:0,load:[3,4],locat:3,look:[0,3,4],mac:3,main:[0,3],make:3,mani:[3,4],manual:0,map:[0,3],metatil:[3,4],miss:0,modifi:4,more:[3,4],most:[3,4],much:3,music:4,must:3,name:4,navig:[0,3],next:[3,4],nodep:3,notabl:3,now:3,object:4,one:4,onli:4,onto:4,open:[3,4],oper:4,option:4,organ:4,other:4,our:3,out:0,over:4,paint:[3,4],pane:4,panel:3,part:4,patient:4,pencil:3,petalburg:3,place:3,platform:3,player:4,pleas:0,png:[],pokeemerald:3,pokemon:[3,4],pokerubi:3,pop:3,porymap:4,press:[3,4],pret:3,primari:[3,4],project:[0,3,4],properti:[3,4],provid:3,purpos:4,quickli:4,reach:0,read:3,recommend:3,redo:3,refer:0,region:[0,3],relat:0,releas:3,respect:3,result:3,right:4,rom:3,same:3,save:3,screen:3,script:4,second:[3,4],secondari:4,section:4,see:3,seem:4,select:[3,4],set:4,setup:3,shortcut:3,should:3,shouldn:3,show:[3,4],side:[3,4],simpli:4,sinc:3,singl:4,situat:4,some:[3,4],someth:0,sort:4,sourc:3,start:0,successfulli:3,summar:4,support:3,sure:3,surround:4,tab:4,take:[3,4],text:4,thei:4,therefor:3,thi:4,thing:[3,4],think:3,those:3,tile:[0,3,4],tileset:[0,3],time:[3,4],tool:3,toolbar:3,tradit:3,trigger:4,two:4,type:4,undo:3,usabl:3,use:[3,4],used:4,user:[0,3],using:[3,4],variou:[3,4],version:3,view:4,walk:4,warp:4,weather:4,what:[0,4],when:[3,4],whenev:4,which:4,wild:3,window:[0,3],within:4,work:[3,4],workflow:3,write:3,you:[0,3,4],your:[3,4]},titles:["Porymap Documentation","Editing Map Events","Editing Map Tiles","Introduction","Navigation","Changelog","Related Projects"],titleterms:{about:3,changelog:5,document:0,edit:[1,2],editor:4,event:1,get:3,introduct:3,list:4,main:4,map:[1,2,4],navig:4,porymap:[0,3],project:6,region:4,relat:6,start:3,tile:2,tileset:4,window:4}})

docsrc/manual/navigation.rst

@@ -1,3 +1,88 @@
 **********
 Navigation
-**********
+**********
+
+Porymap can seem daunting at first because it has many buttons, tabs, panes, and windows.  Let's briefly go over the different parts of the application.
+
+Map List
+--------
+
+The map list contains a hierarchical view of all of the maps in your project.  It is situated on the left side of Porymap's main window.  To switch to a different map, simply double-click or press ``Enter`` on the desired map's name.  Larger maps can take a few seconds to load the first time, so be patient.
+
+.. figure:: images/navigation/map-list-pane.png
+    :alt: Map List Pane
+
+    Map List Pane
+
+By default, the maps are organized by their map groups.  The *Sort Map List* |sort-map-list-button| button gives you some other options to organize the maps:
+
+Sort by Group
+    Organizes by map groups.
+
+Sort by Area
+    Organizes by region map section.
+
+Sort by Layout
+    Organizes by map layouts. Most layouts are only used by a single map, but layouts like the Pokemon Center are used by many maps.
+
+The *Expand All* |expand-all-button| and *Collapse All* |collapse-all-button| buttons will expand or collapse all of the map folders.
+
+Type in the filter to show maps that contain the filter text.
+
+.. figure:: images/navigation/filter-map-list.png
+    :alt: Filter Map List
+
+    Filter Map List
+
+.. |sort-map-list-button|
+   image:: images/navigation/sort-map-list-button.png
+
+.. |expand-all-button|
+   image:: images/navigation/expand-all-button.png
+
+.. |collapse-all-button|
+   image:: images/navigation/collapse-all-button.png
+
+Main Window
+-----------
+
+Most of the work you do in Porymap is in the center Main Window.  It features 4 tabbed views which each have different purposes, but they all operate within the context of the currently-opened map in the Map List.  Let's quickly summarize what each of these tabs is used for.
+
+.. figure:: images/navigation/main-window-tabs.png
+    :alt: Main Window Tabs
+
+    Main Window Tabs
+
+Map Tab
+    Paint metatiles and their collision properties to change the appearance of the map and how the player can walk around the map.  When the Map Tab is selected, the pane on the right side of the map will have two tabs: Metatiles and Collision.  You can switch between these to paint either metatiles or collision properties onto the map.
+
+Events Tab
+    Edit the interactable events on the map.  This includes things like objects, warps, script triggers, and more.
+
+Header Tab
+    Choose various gameplay properties to set for the map. This includes things like background music and weather.
+
+Connections Tab
+    Change how the map connects with surrounding maps when the player walks from one to another.
+
+Tileset Editor
+--------------
+
+The Tileset Editor can be opened with *File -> Tileset Editor*.  When the Tileset Editor is opened, it is opened in the context of the currently-opened map.  Every map has a primary and secondary tileset, so you will work with a combination of the two whenever you use the Tileset Editor.  The left-side pane shows the primary and secondary tilesets' metatiles.  The right-side panes allow you to modify the currently-selected metatile.
+
+.. figure:: images/navigation/tileset-editor.png
+    :alt: Tileset Editor
+
+    Tileset Editor
+
+Region Map Editor
+-----------------
+
+The Region Map Editor can be opened with *File -> Region Map Editor*. This window will allow you to modify the look and layout of maps on the game's region map.  You can also modify the city map images using the bottom two panes.
+
+.. figure:: images/navigation/region-map-editor.png
+    :alt: Region Map Editor
+
+    Region Map Editor
+
+We covered all of the basic views and windows of Porymap above.  Next, let's learn how to use Porymap's features to the fullest when editing map tiles.