Skip to content
franks42 edited this page May 2, 2012 · 5 revisions

File Menu

Clojure Namespace Browser

New Browser (with selection/FQN)

Choosing this menu item will bring up a new browser window.

When no text is selected in the doc-panel of the current browser, then the new browser will select the same FQN as the current one.

However, if text was selected in the doc-panel of the current browser, then the application will try to resolve the selected text to a namespace, var or class, and select that one in the new browser.

Edit Menu

Clojure Namespace Browser

Copy Selection/FQN

Choosing this menu item will copy the current selection in the doc-panel to the clipboard. When there is no selection, it will copy the current FQN. When there is no selection and no current FQN, it will do nothing.

Paste - FQN from clipboard

Choosing this menu item will attempt to resolve any clipboard text-content to a namespace, var or class, and select the result.

FQN from selection

Choosing this menu item will attempt to resolve any selection in the doc-panel to a namespace, var or class, and select the result.

This is a poor-man's feature of implementing clickable links for references to other names or fqn's.

Open URL from selection

Choosing this item will attempt to interpret any selection in the doc-panel as a URL and spawn off the default internet-browser with that URL.

Previous FQN

The application maintains a history list of selected FQNs per browser window.

Choosing this menu item will select the previous FQN on the history list for that browser.

Namespaces Menu

Clojure Namespace Browser

Require

Choosing this item while an unloaded namespace is selected will attempt to require/load that namespace.

Menu item is only enabled when the unloaded namespaces are listed and one is selected.

If the require succeeded, that namespace will be selected as a loaded one.

In some rare cases, the require will fail for some kind of namespaces. In that case an alert message will inform you of that case. It's unclear why this happens for some namspaces...

Trace/Untrace NS

Choosing the "Trace NS" menu item will put a trace on every traceable var in the selected namespace.

Choosing the "Untrace NS" menu item will remove a trace on any traced var in the selected namespace.

See also the Tracing Vars section for more details.

Vars Menu

Clojure Namespace Browser

Trace/Untrace Var

Choosing the "Trace Var" menu item will put a trace on the selected var, while "Untrace Var" will remove the trace.

Note that the menu item will only be enabled for traceable vars (functions), and will change from "Trace" to "Untrace" based on the trace-state of the selected var.

See also the Tracing Vars section for more details.

Categorize Listing

Choosing the "Categorize Listing" menu item will group the vars and list them by macro/function/multimethod/namespace/class/etc.

The display implementation is still "experimental". Probably a hierarchical list option like used in Eclipse' counterclockwise would be nicer. Stay tuned.

FQN Listing

Toggles the var-list display between local names and fully qualified names.

Note that FQNs will always be used when multiple namespaces are selected.

Search Docs Also

The regular expression filters normally work on only the displayed var-list names (or FQNs). By toggling this option, the docs-strings will also be included in the search.

Docs Menu

Clojure Namespace Browser

ClojureDocs Update local repo

Choosing this menu item will download the latest&greatest ClojureDocs repo to a local copy on your HD for offline usage now or later.

Especially when you're browsing&searching extensively and you internet connection is not superfast, you will appreciate working with a locally cached ClojureDocs repo copy.

ClojureDocs Online/Offline

This option will make you work either with the online ClojureDocs repo on the internet or the locally cached copy.

Window Menu

Clojure Namespace Browser

Zoom In/Out

Increases/decreases the font-size for the list and document panels.

Font

Offers some different fixed-width font choices. Note that those hard-coded choices may not be available on all platforms.

Color Coding

When switched-on, the FQN-textfield background is colored based on the data-type. Green for functions, red for macros, orange for special-forms, wheat for classes/types, blanchedalmond for namespaces, light-blue for protocols, white for anything else.

Personally, I'd like alarm bells to ring and the screen to flash when using a macro to remind me that nothing may eval like you may expect... if you do not like the visual feedback, pls turn it off.

Manual/Auto-Refresh

The browser shows you a live representation of the state of you clojure-image... at that certain point in time when the window was rendered. Any new namespaces or vars you create, or values you change will only be shown when you refresh your browser window or initiate a new search.

Choosing the "Manual Refresh" menu item will force a refresh of the namespace and vars listing and the doc-panel with its shown values.

Choosing the "Auto-Refresh" menu item option will refresh the lists and doc-panel every second or so when anything changes. It adds a few % cpu usage, but allows you to see live-updates of var-values. (pretty cool actually, if I may say so myself...)

Bring All to Front

Reinstates all (hidden/minimized) browser windows.

Cycle Through Windows

Well... it cycles throught the browser windows.

Help Menu

Clojure Namespace Browser

Clj-Ns-Browser Wiki...

Will open your default internet-browser with Clojure Namespace Browser's Wiki

Clj-Ns-Browser Github...

Will open your default internet-browser with Clojure Namespace Browser's source-code repo at github

Clojure.org...

Shortcut to Clojure.org

ClojureDocs...

Shortcut to ClojureDocs.org

Clojure CheatSheet...

Will open your default internet-browser with Andy's essential CheatSheet to help you find the right function for the job.

Stackoverflow...

Will open your default internet-browser with stackoverflow with the search for clojure+"selected-local-name".

Jira...

Shortcut to Clojure's Jira site

About...

Some licensing and copyright blurb about this app.