Remove explicit keybindings from docs, plus misc docs cleanup

lethosor · lethosor · commit 5e8f85957bb6 · 2018-05-16T19:38:46.000-04:00
Closes DFHack/dfhack#988
diff --git a/adv-rumors.lua b/adv-rumors.lua
@@ -6,19 +6,20 @@ adv-rumors
 ==========
 Improves the "Bring up specific incident or rumor" menu in Adventure mode.
 
+- Moves entries into one line
+- Adds a "slew" keyword for filtering, making it easy to find your kills and not your companions'
+- Trims repetitive words
+
 ]====]
 
 --========================
 -- Author : 1337G4mer on bay12 and reddit
 -- Version : 0.2
 -- Description : A small utility based on dfhack to improve the rumor UI in adventure mode.
 --
--- Usage: Save this code as rumors.lua file in your /hack/scripts/ folder
 --      In game when you want to boast about your kill to someone. Start conversation and choose
 --      the menu "Bring up specific incident or rumor"
 --      type rumors in dfhack window and hit enter. Or do the below keybind and use that directly from DF window.
--- Optional One time setup : run below command at dfhack command prompt once to setup easy keybind for this
---          keybinding add Ctrl-A@dungeonmode/ConversationSpeak rumors
 --
 -- Prior Configuration: (you can skip this if you want)
 --      Set the three boolean values below and play around with the script as to how you like
diff --git a/gui/advfort.lua b/gui/advfort.lua
@@ -6,7 +6,7 @@ gui/advfort
 ===========
 This script allows to perform jobs in adventure mode. For more complete help
 press :kbd:`?` while script is running. It's most comfortable to use this as a
-keybinding. (e.g. ``keybinding set Ctrl-T gui/advfort``). Possible arguments:
+keybinding (see below for the default binding). Possible arguments:
 
 :-a, --nodfassign:  uses different method to assign items.
 :-i, --inventory:   checks inventory for possible items to use in the job.
@@ -718,7 +718,7 @@ function isSuitableItem(job_item,item)
             print(v)
         end
         --]]
-        
+
         return false,"matinfo"
     end
     -- some bonus checks:
@@ -914,7 +914,7 @@ function AssignJobItems(args)
     -- first find items that you want to use for the job
     local job=args.job
     local its=EnumItems_with_settings(args)
-    
+
     local item_suitability,item_counts=find_suitable_items(job,its)
     --[[while(#job.items>0) do --clear old job items
         job.items[#job.items-1]:delete()
@@ -923,7 +923,7 @@ function AssignJobItems(args)
 
     if settings.gui_item_select and #job.job_items>0 then
         local item_dialog=require('hack.scripts.gui.advfort_items')
-       
+
         if settings.quick then --TODO not so nice hack. instead of rewriting logic for job item filling i'm using one in gui dialog...
             local item_editor=item_dialog.jobitemEditor{
                 job = job,
@@ -1060,7 +1060,7 @@ function fake_linking(lever,building,slots)
     end
     item2.general_refs:insert("#",{new=df.general_ref_building_triggerst,building_id=lever.id})
     item1.general_refs:insert("#",{new=df.general_ref_building_triggertargetst,building_id=building.id})
-    
+
     lever.linked_mechanisms:insert("#",item2)
     --fixes...
     if building:getType()==df.building_type.Door then
@@ -1143,7 +1143,7 @@ function PlantGatherFix(args)
     local pos=args.pos
     --[[args.job.flags[17]=false --??
 
-    
+
     local block=dfhack.maps.getTileBlock(pos)
     local ev=get_design_block_ev(block)
     if ev==nil then
@@ -1218,7 +1218,7 @@ function usetool:update_site()
     self.current_site=site
     local site_label=self.subviews.siteLabel
     if site then
-        
+
         site_label:itemById("site").text=dfhack.TranslateName(site.name)
     else
         if settings.safe then
@@ -1404,7 +1404,7 @@ function usetool:openShopWindowButtoned(building,no_reset)
         --]]
     end
     building:fillSidebarMenu()
-    
+
     local list={}
     for id,choice in pairs(wui.choices_visible) do
         table.insert(list,{text=utils.call_with_string(choice,"getLabel"),button=choice})
@@ -1420,7 +1420,7 @@ function usetool:openShopWindowButtoned(building,no_reset)
 end
 function usetool:openShopWindow(building)
     local adv=df.global.world.units.active[0]
-    
+
     local filter_pile=workshopJobs.getJobs(building:getType(),building:getSubtype(),building:getCustomType())
     if filter_pile then
         local state={unit=adv,from_pos={x=adv.pos.x,y=adv.pos.y, z=adv.pos.z},building=building
@@ -1522,7 +1522,7 @@ function usetool:hiveActions(building)
     --CollectHiveProducts,
 end
 function usetool:operatePump(building)
-    
+
     local adv=df.global.world.units.active[0]
     makeJob{unit=adv,post_actions={AssignBuildingRef},pos=adv.pos,from_pos=adv.pos,job_type=df.job_type.OperatePump,screen=self}
 end
@@ -1537,7 +1537,7 @@ function usetool:farmPlot(building)
         end
     end
     --check if there tile is without plantseeds,add job
-    
+
     local args={unit=adv,pos=adv.pos,from_pos=adv.pos,screen=self}
     if do_harvest then
         args.job_type=df.job_type.HarvestPlants
@@ -1702,7 +1702,7 @@ function usetool:fieldInput(keys)
                     break
                 end
             end
-           
+
             --First check site
             local ok,msg=self:siteCheck() --TODO: some jobs might be possible without a site?
             if not ok then
@@ -1717,17 +1717,17 @@ function usetool:fieldInput(keys)
                     end
                 end
             end
-            
+
             if not failed then
                 local ok,msg
                 if type(cur_mode[2])=="function" then
                     ok,msg=cur_mode[2](state)
                 else
                     makeJob(state)
                     --(adv,moddedpos(adv.pos,MOVEMENT_KEYS[code]),cur_mode[2],adv.pos,cur_mode[4])
-                    
+
                 end
-                
+
                 if code=="SELECT" then
                     self:sendInputToParent("LEAVESCREEN")
                 end
@@ -1741,15 +1741,15 @@ function usetool:fieldInput(keys)
             end
         end
     end
-    
+
 end
 
 function usetool:onInput(keys)
 
     self:update_site()
 
     local adv=df.global.world.units.active[0]
-    
+
     if keys.LEAVESCREEN  then
         if df.global.cursor.x~=-30000 then --if not poiting at anything
             self:sendInputToParent("LEAVESCREEN") --leave poiting
@@ -1782,7 +1782,7 @@ function usetool:onInput(keys)
             self:fieldInput(keys)
         end
     end
-    
+
 end
 function usetool:cancel_wait()
     self.long_wait_timer=nil
diff --git a/gui/gm-editor.lua b/gui/gm-editor.lua
@@ -7,7 +7,7 @@ gui/gm-editor
 This editor allows to change and modify almost anything in df. Press :kbd:`?` for
 in-game help. There are three ways to open this editor:
 
-* Callling ``gui/gm-editor``  from a command or keybinding opens the editor
+* Calling ``gui/gm-editor``  from a command or keybinding opens the editor
   on whatever is selected or viewed (e.g. unit/item description screen)
 
 * using gui/gm-editor <lua command> - executes lua command and opens editor on
diff --git a/gui/manager-quantity.lua b/gui/manager-quantity.lua
@@ -4,11 +4,7 @@
 gui/manager-quantity
 ====================
 
-Sets the quantity of the selected manager job
-
-Sample usage::
-
-    keybinding add Alt-Q@jobmanagement gui/manager-quantity
+Sets the quantity of the selected manager job (in the j-m or u-m screens).
 
 ]====]
 
diff --git a/gui/unit-info-viewer.lua b/gui/unit-info-viewer.lua
@@ -1,5 +1,5 @@
 -- unit-info-viewer.lua
--- Displays age, birth, maxage, shearing, milking, grazing, egg laying, body size, and death info about a unit. Recommended keybinding Alt-I
+-- Displays age, birth, maxage, shearing, milking, grazing, egg laying, body size, and death info about a unit.
 -- version 1.04
 -- original author: Kurik Amudnil
 -- edited by expwnent
@@ -8,7 +8,7 @@
 gui/unit-info-viewer
 ====================
 Displays age, birth, maxage, shearing, milking, grazing, egg laying, body size,
-and death info about a unit. Recommended keybinding :kbd:`Alt`:kbd:`I`.
+and death info about a unit.
 
 ]====]
 local gui = require 'gui'
