Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions docs/development/agents/DesignDogma.md
Original file line number Diff line number Diff line change
Expand Up @@ -295,8 +295,8 @@ create performance bottlenecks.

## Use an IDE like VisualSoar

Write your Soar code using VisualSoar. If so, maintain and use your VisualSoar
data map!
Write your Soar code using [VisualSoar][VSIDE].
If so, maintain and use your [VisualSoar][VSIDE] data map!

### Example

Expand All @@ -306,7 +306,7 @@ N/A

Much like comments on code, VisualSoar's enforced structure and
data map is exceptionally helpful for people who are examining code they have
not themselves written. VisualSoar provides helpful functionality like syntax
not themselves written. [VisualSoar][VSIDE] provides helpful functionality like syntax
highlighting and identifier completion. It also helps you catch bugs in your
code by watching for rules that match unspecified WMEs. Such bugs (particularly
typos involving nearly identical letters like l and 1) can sometimes require
Expand Down Expand Up @@ -368,3 +368,5 @@ sp {xxyyzz
By violating the intent of the Soar language you will likely
achieve undesirable results. There is almost certainly a better way of doing
what you are trying to do.

[VSIDE]: ../../downloads/agent_development_tools/visualsoar.md
4 changes: 4 additions & 0 deletions docs/downloads/agent_development_tools/soaride.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ Tags:

# SoarIDE

???+ warning "Warning"
This project is no longer actively maintained, instead use
[VisualSoar](./visualsoar.md).

The SoarIDE is an advanced editor for the Soar programming language based on the
Eclipse platform, developed by Soar Technology. As an Eclipse plugin, the SoarIDE
leverages all of the core features of Eclipse including a flexible UI, update manager,
Expand Down
10 changes: 6 additions & 4 deletions docs/downloads/soar/latest.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The current version of Soar is {{ soar_version }}.
<!-- markdown-link-check-disable-next-line -->
* [Soar Manual PDF](https://github.com/SoarGroup/Soar/releases/download/releases%2F{{soar_version}}/SoarManual.pdf)
<!-- markdown-link-check-disable-next-line -->
* [VisualSoar Manual PDF](https://github.com/SoarGroup/Soar/releases/download/releases%2F{{soar_version}}/VisualSoar_UsersManual.pdf)
* [[VisualSoar][VSIDE] Manual PDF](https://github.com/SoarGroup/Soar/releases/download/releases%2F{{soar_version}}/VisualSoar_UsersManual.pdf)

If you would like to build Soar from the current source code, you'll need to
acquire the source from our git repository [on GitHub](https://github.com/SoarGroup/Soar).
Expand Down Expand Up @@ -71,7 +71,7 @@ Tcl 9)

### Project Stability Improvements

* Newly designed JSON format for VisualSoar projects combining the datamap, operator
* Newly designed JSON format for [VisualSoar][VSIDE] projects combining the datamap, operator
hierarchy/project layout, and comment files into one file ([#38](https://github.com/SoarGroup/VisualSoar/issues/38),
[#5](https://github.com/SoarGroup/VisualSoar/issues/5))
* Far less likely to be corrupted
Expand All @@ -80,7 +80,7 @@ hierarchy/project layout, and comment files into one file ([#38](https://github.
* More robust to collaboration (no non-deterministic output, fewer git conflicts,
easier to resolve if they do occur)
* Handles arbitrary enum strings, attribute and operator names, etc.
* VisualSoar will write your project in the new format automatically, but
* [VisualSoar][VSIDE] will write your project in the new format automatically, but
will ask you to delete the old project files yourself. Effort was taken to
eliminate any chance of data loss or other unwanted surprises.
* Read/write project and config files atomically
Expand All @@ -96,7 +96,7 @@ saving everything without confirmation!)

### CLI Support

VisualSoar can now run project datamap validation from the command line by passing
[VisualSoar][VSIDE] can now run project datamap validation from the command line by passing
the arguments `--check productionsAgainstDatamap --project <path>`, where `<path>`
is the path to your project `.vsa` or `.vsa.json`.

Expand Down Expand Up @@ -155,3 +155,5 @@ lines getting commented
* Parameters are now parsed with the `commons-cli` library
* `--help` and incorrect parameters now show CLI parameter documentation,
so users don't have to go to the website

[VSIDE]: ../../downloads/agent_development_tools/visualsoar.md
4 changes: 3 additions & 1 deletion docs/home/QuickStart.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,13 @@ and extract to the location of your choice.
- Linux/Mac users can run `./SoarJavaDebugger.sh` from the terminal

The other included applications are used in the tutorial, which is included under
`documentation/`. The manuals for Soar and VisualSoar can be found there, as
`documentation/`. The manuals for Soar and [VisualSoar][VSIDE] can be found there, as
well.

You can also build Soar from [source](https://github.com/SoarGroup/Soar) if
you'd like to work with the latest version or make changes to it.

Once you have Soar running, you can follow the
[Soar Tutorial](../tutorials/soar_tutorial/index.md) to learn how to use it.

[VSIDE]: ../downloads/agent_development_tools/visualsoar.md
4 changes: 3 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ If you are looking for help or discussion, please see our
<!-- markdown-link-check-disable-next-line -->
* [**Soar 9.6.4 available for download**](https://github.com/SoarGroup/Soar/releases/download/releases%2F{{soar_version}}/SoarSuite_{{soar_version}}-Multiplatform.zip):
This release of Soar contains lots of stability and ergonomics improvements to
VisualSoar and the Soar debugger, as well as newly-added support for LTI aliases.
[VisualSoar][VSIDE] and the Soar debugger, as well as newly-added support for LTI aliases.
* This year's Soar workshop (45th) held on May 5, 2025 was a success! We had broad
participation from various projects using Soar, including a remarkable presentation
from our guest speaker
Expand All @@ -33,3 +33,5 @@ available on GitHub.
* [**Engineer's Guide to Soar**](https://github.com/SoarGroup/Engineers-Guide-to-Soar):
A 14-part course on programming Soar for engineers, by Bryan Stearns is now
available on GitHub.

[VSIDE]: ../docs/downloads/agent_development_tools/visualsoar.md
12 changes: 7 additions & 5 deletions docs/reference/VisualSoarKeyboardAndMouseControls.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ key in the shortcuts below.

* <kbd>ESC</kbd> Close open dialog
* <kbd>Ctrl</kbd>+<kbd>Q</kbd> Quit VisualSoar
* <kbd>Ctrl</kbd>+<kbd>,</kbd> Open the VisualSoar preferences
* <kbd>Ctrl</kbd>+<kbd>,</kbd> Open the [VisualSoar][VSIDE] preferences
* <kbd>Ctrl</kbd>+<kbd>=</kbd> Increase font size
* <kbd>Ctrl</kbd>+<kbd>-</kbd> Decrease font size

### Project Level Actions

* <kbd>Ctrl</kbd>+<kbd>N</kbd> Open a new VisualSoar project
* <kbd>Ctrl</kbd>+<kbd>O</kbd> Open an existing VisualSoar project
* <kbd>Ctrl</kbd>+<kbd>N</kbd> Open a new [VisualSoar][VSIDE] project
* <kbd>Ctrl</kbd>+<kbd>O</kbd> Open an existing [VisualSoar][VSIDE] project
* <kbd>Ctrl</kbd>+<kbd>F</kbd> Open a text file
* <kbd>Alt</kbd>+<kbd>X</kbd> Save all open documents and close VisualSoar
* <kbd>Ctrl</kbd>+<kbd>T</kbd> Tile windows horizontally
Expand All @@ -33,7 +33,7 @@ key in the shortcuts below.

### Editing

The VisualSoar rule editor uses all the default editing keystrokes
The [VisualSoar][VSIDE] rule editor uses all the default editing keystrokes
for area selection, clipboard operations and basic editing:

* <kbd>CTRL</kbd>+<kbd>C</kbd> Copy the selected text to the clipboard
Expand Down Expand Up @@ -75,7 +75,7 @@ and paste) as well as these keystrokes:

### Context menus

All windows in VisualSoar have context menus that
All windows in [VisualSoar][VSIDE] have context menus that
accessible by pressing and holding the right mouse
button.

Expand All @@ -96,3 +96,5 @@ button.

When using drag and drop with the datamap you should note that the
mouse cursor changes as you begin the operation (the drag part).

[VSIDE]: ../downloads/agent_development_tools/visualsoar.md
Loading