Documentation/Changelog

456.py

@@ -21,7 +21,7 @@
 
 # info
 __author__ = "instance.id"
-__copyright__ = "2020 All rights reserved. See LICENSE for more details."
+__copyright__ = "2020 All rights reserved."
 __status__ = "Prototype"
 
 current_file_path = os.path.abspath(
@@ -50,9 +50,6 @@ def get_dbconnection():
 hou.session.SETTINGS = {}
 hou.session.DBCONNECTION = DatabaseProxy()
 db = DatabaseProxy()
-settingdata = {}
-isloading = True
-tempkey = ""
 
 
 # --------------------------------------------------------- DatabaseModels

Help/searcher/changelog/index.txt

@@ -0,0 +1,31 @@
+= <font style="color:#D2A00C">Searcher</font> =
+<!-- ----------------------------------------------------------------------------------------------
+// -------------------------------------------------------------------------------- Page Config -->
+
+#display: inverted notoc
+#billboard: /images/billboards/blueprint.png
+#style: background-color: #000000; background-size: auto;
+#version: 1.00
+
+<!-- ----------------------------------------------------------------------------------------------
+// ------------------------------------------------------------------------------- Header Image -->
+== <font style="color:#D2A00C">Change Log</font> ==
+
+<!-- ----------------------------------------------------------------------------------------------
+// ---------------------------------------------------------------------------------- Main Menu -->
+<font style="color:#607FAE"> [ Main Window |/searcher/main] | [ Settings Window |/searcher/settings/] | [ Change Log |/searcher/changelog/] </font>
+
+<!-- ----------------------------------------------------------------------------------------------
+// ------------------------------------------------------------------------------ Settings Info -->
+
+:disclosure:<font style="color:#D2A00C">v1.00</font>
+
+    table width="100%">>       
+        tr>>           
+            td>> 
+                :new:
+                    * First release of Searcher!
+                :bug:
+                   :platform:Mac
+                    * Due to a discrepancy with the way MacOS handles windowing, the MacOS version of Searcher will be released at a later date.
+

Help/searcher/index.txt

@@ -1,73 +1 @@
-= Searcher =
-
-#bestbet: network parameter parameters
-#billboard: /images/billboards/blueprint.png
-#style: background-color: #303030; background-size: auto;
-
-"""How to use the network and parameter editors to work in Houdini."""
-
-*Nodes are the building blocks of the scene*. The Houdini scene is built from nodes organized in networks. Different network types control different parts of Houdini.
-
-*Using the [shelf tools|/shelf/] automatically creates nodes*. For example, when you click the [Box tool|Node:sop/box] on the __Create__ shelf tab, Houdini creates a new [Geometry container object|Node:obj/geo] with a [Box node|Node:sop/box] inside. You can also create nodes manually in the network editor. This is how advanced work is often done in Houdini. Pressing ((Tab)) in the network editor opens a menu of all nodes available in the current network type.
-
-*Some nodes can contain other nodes*. For example, a _Geometry Container object_ node lives at the scene level. It contains a network of _surface nodes_ that define the geometry of the object. See [node navigation|navigate] for information on how you move inside and out of container nodes.
-
-*Each node in a network performs a specific function*. In geometry, compositing, and CHOP networks, each node creates or modifies data passing through the node. At the scene level, nodes represent objects (such as props, bones, lights, and cameras) with transforms and parenting relationships. In the render network, nodes represent rendered outputs (images or animation), and links between the nodes define render dependencies.
-
-@subtopics
-
-:col:
-    == Networks ==
-
-    :: [nodes]
-    :: [navigate]
-    :: [wire]
-    :: [flags]
-    :: [badges]
-    :: [find]
-
-:col:
-    == Editing parameters ==
-
-    :: [parms]
-    :: [ramps]
-    :: [patterns]
-    :: [edit_interface]
-    :: [copying]
-
-~~
-
-:col:
-    == Next steps ==
-
-    :: [layout]
-    :: [organize]
-    :: [paths]
-    :: [dependencies]
-    :: [options]
-    :: [shortcuts]
-	:: [rename]
-
-:col:
-    == Expressions ==
-
-    :: [Parameter expressions|expressions]
-    :: [Expressions in filenames|/render/expressions]
-    :: [Spare parameters|spare]
-    :: [Expression cookbook|/ref/expression_cookbook]
-    :: [List of expression functions|/expressions/]
-
-~~
-
-:col:
-    == Guru level ==
-
-    :: [motioneffects]
-    :: [expression_functions]
-
-:col:
-    == Reference ==
-
-    :: [menus]
-    :: [/ref/panes/parms]
-
+#redirect: /searcher/main

Help/searcher/licenses/index.txt

@@ -0,0 +1,95 @@
+= Searcher third-party libraries and tools =
+#index: no
+
+Houdini %{HOUDINI_MAJOR_VERSION}.%{HOUDINI_MINOR_VERSION} is fully compliant with the VFX Reference Platform CY2019 specification ([http://www.vfxplatform.com]).
+
+Houdini uses the following third party libraries:
+
+table width="100%">>
+    tr>>
+        th width="33%">>Third-Party Tool
+        th width="33%">>Version
+        th>>License
+	th>>VFX Platform Compliant
+    tr>>
+	td>>[Beaker|https://pypi.org/project/Beaker]
+        td>>1.5.1
+        td>>[BSD License|http://opensource.org/licenses/bsd-license.php]
+        td>>N/A
+    tr>>
+        td>>[decorator|https://pypi.python.org/pypi/decorator]
+        td>>3.0.0
+        td>>[BSD License|http://opensource.org/licenses/bsd-license.php]
+	td>>N/A
+    tr>>
+        td>>[FormEncode|http://www.formencode.org/en/latest/]
+        td>>1.2.1
+        td>>[Python Software Foundation License|http://opensource.org/licenses/Python-2.0]
+	td>>N/A
+    tr>>
+        td>>[Mako|http://www.makotemplates.org/]
+        td>>0.2.5
+        td>>[MIT License|http://www.opensource.org/licenses/mit-license.php]
+        td>>N/A
+    tr>>
+        td>>[Pylons|http://www.pylonsproject.org/]
+        td>>0.9.7
+        td>>[BSD License|http://www.pylonsproject.org/about/license]
+	td>>N/A
+    tr>>
+        td>>[Routes|https://pypi.python.org/pypi/Routes]
+        td>>1.10.1
+        td>>[BSD License|http://opensource.org/licenses/bsd-license.php]
+	td>>N/A
+    tr>>
+	td>>[setuptools|https://pypi.org/project/setuptools]
+	td>>0.6c11
+        td>>[MIT License|http://opensource.org/licenses/MIT]
+	td>>N/A
+    tr>>
+        td>>[Six|http://pythonhosted.org/six/]
+        td>>1.13.0
+        td>>[License|six]
+        td>>N/A
+    tr>>
+        td>>[SQLAlchemy|https://www.sqlalchemy.org/]
+        td>>0.7.10
+        td>>[License|SQLAlchemy]
+        td>>N/A
+    tr>>
+        td>>[Tempita|http://pythonpaste.org/tempita/]
+        td>>0.2
+        td>>[BSD License|http://pythonpaste.org/tempita/license.html]
+	td>>N/A
+    tr>>
+        td>>[virtualenv|https://pypi.python.org/pypi/virtualenv]
+        td>>1.3.2
+        td>>[MIT License|http://opensource.org/licenses/MIT]
+	td>>N/A
+    tr>>
+        td>>[WebError|https://pypi.python.org/pypi/WebError]
+        td>>0.9.1
+        td>>[MIT License|http://opensource.org/licenses/MIT]
+	td>>N/A
+    tr>>
+        td>>[WebHelpers|https://pypi.python.org/pypi/WebHelpers/0.6.4]
+        td>>0.6.3
+        td>>[BSD License|http://opensource.org/licenses/bsd-license.php]
+	td>>N/A
+    tr>>
+        td>>[WebOb|http://pythonpaste.org]
+        td>>0.9.4
+        td>>[MIT License|http://www.opensource.org/licenses/mit-license.php]
+        td>>N/A
+    tr>>
+        td>>[WebTest|https://pypi.python.org/pypi/WebTest]
+        td>>1.1
+        td>>[MIT License|http://opensource.org/licenses/MIT]
+	td>>N/A
+    tr>>
+        td>>[WSGIref|https://pypi.python.org/pypi/wsgiref]
+        td>>0.1.2
+        td>>[Python Software Foundation License|http://opensource.org/licenses/Python-2.0]
+	td>>N/A
+
+

Help/searcher/main.txt

@@ -1,73 +1,107 @@
-= Searcher =
+= <font style="color:#D2A00C">Searcher</font> =
 
-#bestbet: network parameter parameters
+#display: inverted notoc
 #billboard: /images/billboards/blueprint.png
-#style: background-color: #303030; background-size: auto;
+#style: background-color: #000000; background-size: auto;
+#version: 1.00
+
+<!-- ----------------------------------------------------------------------------------------------
+// ------------------------------------------------------------------------------- Header Image -->
+[Image:/searcher/images/searcher.png]
+
+<!-- ----------------------------------------------------------------------------------------------
+// ---------------------------------------------------------------------------------- Main Menu -->
+== <font style="color:#D2A00C">Main Window</font> ==
+table width="100%">>
+    tr>>
+        td>> 
+           <font style="color:#607FAE"> [ Main Window |/searcher/main] | [ Settings Window |/searcher/settings/] | [ Change Log |/searcher/changelog/] </font>
+    tr>>
+        td>> 
+            <font style="color:#607FAE">[ Menu Items |#menu] | [ Search Box |#searchbox] | [ Results Box |#resultsbox] | [ Hotkeys |#hotkeys]</font>
+
+
+
+<!-- ----------------------------------------------------------------------------------------------
+// --------------------------------------------------------------------------------- Menu Items -->
+
+table width="100%">>
+    tr>>
+        td colspan="2">>
+            ==== <font style="color:#D2A00C">Menu Items</font> ====
+            #id: menu           
+    tr>>           
+        td width="65%">> 
+            # Collapse or expand the top level items of the search results
+            # Show/Hide the context column of the search results
+            # Show this help menu 
+            # Pin the Searcher window so as not to close when window loses focus
+            # Show the settings menu
+        td colspan="1">> 
+            [Image:/searcher/images/menu.png]
+
+<!-- ----------------------------------------------------------------------------------------------
+// --------------------------------------------------------------------------------- Search Box -->
+
+table width="100%">>
+    tr>>
+        td>>
+            ===  <font style="color:#D2A00C">Search Box</font> ===
+            #id: searchbox    
+    tr>>
+        td width="40%">> 
+            The search box accepts both fuzzy and abbreviated input  
+
+            Ex. If looking for 'Network Preferences' you can type 'net pref' and get the appropriate results       
+    tr>> 
+        td colspan="1" style="text-align: right;">> 
+            [Image:/searcher/images/searchb.png]
+
+<!-- ----------------------------------------------------------------------------------------------
+// -------------------------------------------------------------------------------- Results Box -->
+
+table width="100%">>
+    tr>>
+        td colspan="2">>
+            === <font style="color:#D2A00C">Results Box</font> ===
+            #id: resultsbox
+    tr>>
+        td>>
+            Your seach results appear in the box below the search bar. 
+
+            You can either double-click the item you would like to try and activate or press the tab key and use the arrow keys to 
+            navigate and press enter to activate. If the item has a hotkey assigned to it, it will display it in the right third column.
+
+            TIP:
+                You can still attempt to activate an item if it does not have a hotkey assigned to it. If action is capable of being performed
+                in the current context, it will. 
+    tr>>
+        td colspan="1" style="text-align: right;">> 
+            [Image:/searcher/images/resultsbox.png]    
+    tr>>
+        td colspan="1">> 
+           :platform:Mac
+                Due to a discrepancy with the way MacOS handles windowing, the MacOS version of Searcher will be released at a later date.
+
+
+<!-- ----------------------------------------------------------------------------------------------
+// ------------------------------------------------------------------------------------ Hotkeys -->
+
+table width="100%">>
+    tr>>
+        td colspan="2">>
+            === <font style="color:#D2A00C">Hotkeys</font> ===
+            #id: hotkeys
+    tr>>
+        td>> ((Ctrl)) ((S)) 
+        td>> Open settings menu
+    tr>>
+        td>> ((Ctrl)) ((W))
+        td>> Expand/collapse search results
+    tr>>
+        td>> ((Ctrl)) ((Tab))
+        td width="75%">> With the Mouse over a Houdini pane, show available commands/hotkeys for that pane  
+
 
-"""How to use the network and parameter editors to work in Houdini."""
 
-*Nodes are the building blocks of the scene*. The Houdini scene is built from nodes organized in networks. Different network types control different parts of Houdini.
-
-*Using the [shelf tools|/shelf/] automatically creates nodes*. For example, when you click the [Box tool|Node:sop/box] on the __Create__ shelf tab, Houdini creates a new [Geometry container object|Node:obj/geo] with a [Box node|Node:sop/box] inside. You can also create nodes manually in the network editor. This is how advanced work is often done in Houdini. Pressing ((Tab)) in the network editor opens a menu of all nodes available in the current network type.
-
-*Some nodes can contain other nodes*. For example, a _Geometry Container object_ node lives at the scene level. It contains a network of _surface nodes_ that define the geometry of the object. See [node navigation|navigate] for information on how you move inside and out of container nodes.
-
-*Each node in a network performs a specific function*. In geometry, compositing, and CHOP networks, each node creates or modifies data passing through the node. At the scene level, nodes represent objects (such as props, bones, lights, and cameras) with transforms and parenting relationships. In the render network, nodes represent rendered outputs (images or animation), and links between the nodes define render dependencies.
-
-@subtopics
-
-:col:
-    == Networks ==
-
-    :: [nodes]
-    :: [navigate]
-    :: [wire]
-    :: [flags]
-    :: [badges]
-    :: [find]
-
-:col:
-    == Editing parameters ==
-
-    :: [parms]
-    :: [ramps]
-    :: [patterns]
-    :: [edit_interface]
-    :: [copying]
-
-~~
-
-:col:
-    == Next steps ==
-
-    :: [layout]
-    :: [organize]
-    :: [paths]
-    :: [dependencies]
-    :: [options]
-    :: [shortcuts]
-	:: [rename]
-
-:col:
-    == Expressions ==
-
-    :: [Parameter expressions|expressions]
-    :: [Expressions in filenames|/render/expressions]
-    :: [Spare parameters|spare]
-    :: [Expression cookbook|/ref/expression_cookbook]
-    :: [List of expression functions|/expressions/]
-
-~~
-
-:col:
-    == Guru level ==
-
-    :: [motioneffects]
-    :: [expression_functions]
-
-:col:
-    == Reference ==
-
-    :: [menus]
-    :: [/ref/panes/parms]