-If you use another operating system or want to use the an older version of WUDSN or want to install assemblers,
-compilers and emulators more selectively, read the descriptions of the installation steps below.
-In case something is not correct or not working, please contact me.
+ The recommended way to install WUDSN IDE is the If you use another operating system, want to use an older version
+ of WUDSN, or wish to install assemblers, compilers, and emulators more
+ selectively, read the descriptions of the installation steps below. In
+ case something is not correct or not working, please get in touch with
+ me.
Before version 1.7.2, so-called "zero installation distributions" were been provided for Windows. They contain the Eclipse Platform, the Java Runtime Environment, the latest stable version of the WUDSN IDE plugin,
-all supported compilers, and an emulator for each supported platform. All paths to folders, compilers, and emulators
-are pre-configured. Unpack the content of this archive to the directory "C:\jac\wudsn" and click the "WUDSN IDE-64
-bit" link. Eclipse will open with the predefined workspace that contains "Hello World" examples for different platforms.
+Before version 1.7.2, so-called "zero installation distributions"
+ were provided for Windows. They contain the Eclipse Platform, the Java
+ Runtime Environment, the latest stable version of the WUDSN IDE plugin,
+ all supported compilers, and an emulator for each platform. All paths
+ to folders, compilers, and emulators are pre-configured. Unpack the
+ content of this archive to the directory "C:\jac\wudsn" and click the
+ "WUDSN IDE-64 bit" link. Eclipse will open with the predefined
+ workspace that contains "Hello World" examples for different platforms.
When I was thinking about creating tutorials, I decided not to simply write text but to create short videos instead.
- They are best viewed in full-screen mode and in HD video resolution. I think this is the best way to show how things
- are intended to be used. On the other hand, these tutorials cannot tackle every detail of a supported feature. So
- please also check the features section. All videos are also available for download on
- Pigwa
+
+ When thinking about creating tutorials, I decided not to write text but
+ to create short videos. They are best viewed in full-screen mode and HD
+ video resolution. For me, videos are the best way to show how things
+ are intended to be used. On the other hand, these tutorials cannot
+ tackle every detail of a supported feature. So please also check the
+ features section. All videos are also available for download on Pigwa.
+
Date: Sun, 27 Aug 2023 14:49:19 +0200
Subject: [PATCH 11/27] Update HTML documentation
---
.../help/ide-credits.section.html | 323 ++--
com.wudsn.ide.lng/help/ide-faq.section.html | 767 +++-----
.../help/ide-features.section.html | 1648 +++++++----------
.../help/ide-installation.section.html | 489 ++---
.../help/ide-releases.section.html | 467 ++---
.../help/ide-tutorials-videos.html | 2 +-
.../help/ide-tutorials.section.html | 169 +-
.../src/com/wudsn/ide/lng/Texts.properties | 4 +-
.../src/com/wudsn/ide/lng/Texts_de.properties | 2 +-
9 files changed, 1381 insertions(+), 2490 deletions(-)
diff --git a/com.wudsn.ide.lng/help/ide-credits.section.html b/com.wudsn.ide.lng/help/ide-credits.section.html
index 15453fe4..c4424d9b 100644
--- a/com.wudsn.ide.lng/help/ide-credits.section.html
+++ b/com.wudsn.ide.lng/help/ide-credits.section.html
@@ -1,180 +1,147 @@
-A project like WUDSN IDE is not possible and not worth anything
- without the contributions provided by others. So here's the list of
- credits of all involved people and related projects.
+A project like WUDSN IDE is not possible and not worth anything without the contributions provided by others. So here's the list of credits of all involved people and related projects.
-
-
- Aseembler / Compiler |
- Contributor |
-
-
- ACME |
- Marco Baye (Mac Bacon), Krzysztof Dabrowski (BruSH/ElysiuM) |
-
-
- ATASM |
- M. Schmelzenbach (schmelze) |
-
-
- DASM |
- Matthew Dillon, Olaf Seibert (Rhialto), Andrew Davie, Peter
- H. Froehlich (pfh), the DASM team |
-
-
- KickAss |
- Mads Nielsen (Slammer) |
-
-
- MADS and Mad Pascal |
- Tomasz Biela (tebe) |
-
-
- XASM |
- Piotr Fusik (fox) |
-
-
- Linux compiling |
- Carsten Strohmann (cas) |
-
-
- Mac OS X compiling |
- Spookt |
-
-
-
-
- Graphic Library or Tool |
- Contributor |
-
-
- RECOIL |
- Piotr Fusik (fox) |
-
-
- Grafx2 |
- Adrien Destugues (PulkoMandy), Yves Rizoud (yrizoud) |
-
-
- Â |
- Â |
-
-
- Sound Library |
- Contributor |
-
-
- ASAP |
- Piotr Fusik (fox) |
-
-
- JSIDPLAY2 |
- Ken Händel (kenchis) |
-
-
-
-
- File system library |
- Contributor |
-
-
- AppleCommander |
- Robert Greene (robgreene) |
-
-
- Â |
- Â |
-
-
- Emulator |
- Contributor |
-
-
- AppleWin (Apple II) |
- Nick Westgate (sicklittlemonkey) |
-
-
- Altirra (Atari 8-bit) |
- Avery Lee (phaeron) |
-
-
- Atari800Win (Atari
- 8-bit) |
- Marcin Lewandowski (jaskier) |
-
-
- CCS64 (C64) |
- HÃ¥kan Sundell (phs) |
-
-
- JACE (Apple II) |
- Brendan Robert (BLuRry) |
-
-
- Stella (Atari VCS) |
- Stephen Anthony, Bradford Mott, Eckhard Stolberg, Brian
- Watson |
-
-
- Virtu (Apple II) |
- Sean Fausett (fool), Nick Westgate (sicklittlemonkey) |
-
-
-
-
- Eclipse plugin or library |
- Contributor |
-
-
- Eclipse |
- Eclipse Foundation |
-
-
- x86 ASM Plugin |
- Andy Reek, Daniel Mitte |
-
-
- Rhino JavaScript engine |
- Mozilla Foundation |
-
-
- Eclipse Hex Editor Plugin (used as
- inspiration) |
- Marcel Palko (randallco) |
-
-
- Java Hex Editor &
- Plugin |
- Pordi Estaqual (pestatije) |
-
-
- Java
- Expression Language Parser |
- Aaron Gadberry (aaron) |
-
-
+
+
+Aseembler / Compiler |
+Contributor |
+
+
+ACME |
+Marco Baye (Mac Bacon), Krzysztof Dabrowski (BruSH/ElysiuM) |
+
+
+ATASM |
+M. Schmelzenbach (schmelze) |
+
+
+DASM |
+Matthew Dillon, Olaf Seibert (Rhialto), Andrew Davie, Peter H. Froehlich (pfh), the DASM team |
+
+
+KickAss |
+Mads Nielsen (Slammer) |
+
+
+MADS and Mad Pascal |
+Tomasz Biela (tebe) |
+
+
+XASM |
+Piotr Fusik (fox) |
+
+
+Linux compiling |
+Carsten Strohmann (cas) |
+
+
+Mac OS X compiling |
+Spookt |
+
+
+
+
+Graphic Library or Tool |
+Contributor |
+
+
+RECOIL |
+Piotr Fusik (fox) |
+
+
+Grafx2 |
+Adrien Destugues (PulkoMandy), Yves Rizoud (yrizoud) |
+
+
+Â |
+Â |
+
+
+Sound Library |
+Contributor |
+
+
+ASAP |
+Piotr Fusik (fox) |
+
+
+JSIDPLAY2 |
+Ken Händel (kenchis) |
+
+
+
+
+File system library |
+Contributor |
+
+
+AppleCommander |
+Robert Greene (robgreene) |
+
+
+Â |
+Â |
+
+
+Emulator |
+Contributor |
+
+
+AppleWin (Apple II) |
+Nick Westgate (sicklittlemonkey) |
+
+
+Altirra (Atari 8-bit) |
+Avery Lee (phaeron) |
+
+
+Atari800Win (Atari 8-bit) |
+Marcin Lewandowski (jaskier) |
+
+
+CCS64 (C64) |
+HÃ¥kan Sundell (phs) |
+
+
+JACE (Apple II) |
+Brendan Robert (BLuRry) |
+
+
+Stella (Atari VCS) |
+Stephen Anthony, Bradford Mott, Eckhard Stolberg, Brian Watson |
+
+
+Virtu (Apple II) |
+Sean Fausett (fool), Nick Westgate (sicklittlemonkey) |
+
+
+
+
+Eclipse plugin or library |
+Contributor |
+
+
+Eclipse |
+Eclipse Foundation |
+
+
+x86 ASM Plugin |
+Andy Reek, Daniel Mitte |
+
+
+Rhino JavaScript engine |
+Mozilla Foundation |
+
+
+Eclipse Hex Editor Plugin (used as inspiration) |
+Marcel Palko (randallco) |
+
+
+Java Hex Editor & Plugin |
+Pordi Estaqual (pestatije) |
+
+
+Java Expression Language Parser |
+Aaron Gadberry (aaron) |
+
+
\ No newline at end of file
diff --git a/com.wudsn.ide.lng/help/ide-faq.section.html b/com.wudsn.ide.lng/help/ide-faq.section.html
index 0962f3c1..90918e10 100644
--- a/com.wudsn.ide.lng/help/ide-faq.section.html
+++ b/com.wudsn.ide.lng/help/ide-faq.section.html
@@ -1,557 +1,218 @@
-Here, you can find the answers to frequently asked questions. If
- your question is unanswered, please review the video tutorials or
- contact me.
+Here, you can find the answers to frequently asked questions. If your question is unanswered, please review the video tutorials or contact me.
Installation
-
How do I install Java?
-
- I recommend you visit OpenJDK
- and follow the instructions to download and install the latest
- version. Make sure the Java version, the Eclipse version, and your
- operating system have the same architecture. Newer versions of Java
- only support 64-bit architectures.
-
-
-
Nothing happens When I try to start a .jar file via
- double-click. What is wrong?
-
You probably have the wrong Java version installed or set a
- default. Open a shell window and enter "java -jar
- <yourfile.jar>". If this works, then you have the wrong program
- or Java version associated with the ".jar" file extension in the
- registry. You can fix that by setting the path to the correct Java
- installation folder using "REGEDIT.EXE" for
- "Compute\HKEY_CLASSES_ROOT\jarfile\shell\open".
-
-
-
-
If starting from the command line does not work, you should see
- a more detailed error message about why.
-
-
-
How do I install Eclipse?
-
- If you are unfamiliar with Eclipse, ensure you have installed the Eclipse
- platform distribution without Java or J2EE tools. This distribution
- is much smaller (typically around 60-80 MB instead of 170 MB) and
- will not confuse you with many features and buttons you do not need.
- See the "Installing Eclipse" section for the required steps on the "
- Installation " tab. If you use Windows, you can use one of the zero
- installation distributions of WUDSN IDE, which are linked on the tab
- "Installation". They are ".zip" archives containing Eclipse and
- everything else."
-
-
-
-
When I try to start Eclipse, I get an error like "Failed to
- load the JNI shared library 'C:\Program Files
- (x86)\Java\jre6\bin\client\jvm.dll'". What is wrong?
-
The Eclipse version and the Java version on your system are not
- compatible. The Eclipse is not pure Java but uses platform-specific
- native libraries to run and debug Java efficiently. For example, you
- must install the 64-bit version of Java (JRE or JDK) if you want to
- use the 64-bit version of Eclipse. This is a frequent issue under
- Windows 7 because, by default, only the 32-bit version of Java is
- installed. See the "Installing Eclipse" section for the required
- steps on the " Installation " tab.
-
-
-
How do I use Eclipse at?
-
Start the built-in help of Eclipse via the "Help/Help Content"
- menu and read the "Workbench User Guide" section.
-
-
-
-
Why is WUDSN IDE not available via the update site?
-
You likely typed in the wrong update site URL, for example,
- using "wusdn" instead of "wudsn". The correct URL is
- "http://www.wudsn.com/update". In addition, you should uncheck the
- checkbox "Hide items that are already installed" to see what is
- there. See the "Installing WUDSN IDE" section for the required steps
- on the " Installation " tab.
-
-
-
-
Why do I get "Unable to read repository at ... Read timed
- out" when accessing the update site?
-
This error message indicates the Eclipse program is somehow
- blocked from accessing the site. If you are behind a proxy server,
- check the general proxy server settings in the Eclipse preferences.
- If you use a firewall or internet security tool, make sure
- "Eclipse.exe", "java.exe", "javaw.exe," or the corresponding program
- on your host platform are allowed to cannot to the internet. Maybe
- you have to change the settings so you are prompted to allow access
- interactively.
-
-
-
Why do I get "Cannot complete the install because one or more
- required items could not be found" when updating the plugin from the
- update site?
-
- This error message indicates that the Eclipse version you are running
- is too old. Check the releases page for the
- required minimum Eclipse version for every WUDSN IDE release.
-
-
-
-
Why is the "Assembler" section not visible in the
- preferences?
-
- If the WUDSN IDE sections and features are not visible after a
- successful installation, you probably use an outdated Java version.
- For example, Java 1.6 has been out of maintenance
- since 2013/02. This seems to be a common problem on Mac OS X, even
- in Mavericks (10.9), which still uses Java 1.6 by default. Ensure you
- have at least the Java version mentioned in the installation section
- for the IDE installed and that Eclipse has started using that
- version.
-
-
-
Configuration
-
-
Why do I see wrong messages in the "Problems" view?
-
The default configuration of the "Problems" view shows all
- errors from all files in the current project. While this is a good
- default for Java programming, it is unsuitable for compiling single
- independent assembler files. Therefore, you have to configure the
- "Problems" view accordingly. See the "Installing Eclipse" section for
- the required steps on the " Installation " tab.
-
-
-
How do I associate my source file extensions with the correct
- editor?
-
- The IDE supports many different compilers and provides a specialized
- editor for each. Typically, you have some preferred source file
- extension (".asm" or ".a") and a preferred compiler. The procedure to
- associate the file extension with the editor via the preferences is
- described in this video tutorial WUDSN IDE
- Tutorial 3: Setting up Editors and File Extensions correctly.
-
-
-
-
Why must I put ";@com.wudsn.ide.lng.hardware=..." in the
- source file?
-
The association with the file extension with your compiler's
- editor (done in the preferences; see before) does not determine which
- platform you want to create output. Therefore, this additional
- annotation in the main source file must tell the IDE, which is the
- target platform. It is used to find the correct compiler and emulator
- settings, which can differ per platform. Every compiler has a default
- platform (see the online help in the IDE), but it can also be used on
- every other platform. Therefore, you must specify the target platform
- in the main source file if you use a non-default platform.
-
-
Editing
-
-
Why is editing sometimes slow, or is everything blocked,
- showing the wait cursor?
-
The core of WUDSN IDE uses the Eclipse Platform Runtime only
- and does not require any additional plugins. It starts quickly and
- dashes with that configuration, and I use it daily. So, if you
- experience performance problems, try to download and run the zero
- installation distribution of WUDSN IDE. Performance problems are very
- likely caused by additional plugins or themes installed. Often, these
- plugins are not only slow but broken. Check the ".metadata/.log" file
- in the workspace folder. In some Eclipse versions, this is available
- via "Window/Show View.../Error Log".
-
-
-
Is there support for source version control?
-
Yes, several plugins are available to connect Eclipse to CVS or
- subversion. Also, the "Local History" feature is installed by
- default. You can configure it in the preferences. It automatically
- records all changes to the source file and lets you compare versions
- in place.
-
-
-
-
Is there support for a block selection mode?
-
Yes, a toolbar button and the shortcut "ALT+SHIFT+A" to toggle
- block selection mode in all text editors. This can be useful for
- adding and removing common prefixes such as line numbers.
-
-
If the toolbar button is not visible, you have to set it to
- visible via the menu entry "Customize Perspective" in the context
- menu of the main toolbar. In the customizing dialog, you must
- activate the "Editor Presentation" command group and the toolbar
- entries you want to see.
-
-
-
-
Why does "CTRL-Space" not open content assist?
-
There is a known keyboard assignment conflict when using
- Messenger Plus Live! v4.85.0.386 with Microsoft Messenger 2009 on
- Windows 7 Ultimate. This may also occur in other versions, of course.
- Justin Payne has provided the following description of the solution.
-
- - Startup and log into MS Messenger.
- - From the main window, hit the ALT key to bring up the main
- menu and select "Plus! | Preferences & Options".
- - From the Preferences windows, Select the Messenger tab and
- uncheck "Activate Messenger Lock with a system-wide shortcut" OR
- change the value in its text box to something other than "CTRL +
- Space".
- - Press the "OK" button.
-
-
-
Why do CTRL-SHIFT-0/9 and other key combinations not work?
-
You probably have another program outside of Eclipse that has
- already captured these keys or key combinations. A frequent problem
- is the Windows Input Methods Editor (IME), which is used to switch
- keyboard layouts. For example, if you use multiple keyboard layouts,
- the CTRL-Space is mapped to allow you to cycle between the different
- keyboard regional keyboard layouts. You should be aware of how to
- turn the feature off since you're probably using this feature, but
- if you don't...
-
Windows 7
-
- - Within "Windows Control Panel", open "Region and Settings".
- - Select the "Keyboard and Languages" tab and "Change
- Keyboards...".
- - In the "Text Services and Input Languages" windows, select
- "Advanced Key Settings".
- - In the "Hot Keys for input languages" list box, select
- "Between input languages" and then select "Change Key Sequence..."
- - In the "Change Key Sequence" window, choose another radio
- button other than the one next to CTRL+Shift. At best, you choose
- "(None)".
- - Click OK until you close all popup windows.
-
-
Windows 10
-
- - Open "Control Panel\Clock, Language, and
- Region\Language\Advanced settings.
- - Click the "Change Language bar hot keys".
- - Set all key sequences to "(None)".
- - Click OK until you close all popup windows.
-
-
- Of course, this is Windows 7/10, and we know how Microsoft loves to
- change its layouts and names, but this option is available back to
- Windows XP.
-
-
-
Compiling
-
-
Why is MADS the primary compiler?
-
When I started with WUDSN IDE, ATASM was the first supported
- compiler. The reason was simple: 90% of my sources are in ATASM
- format. ATASM is very comprehensive and fast. Its capabilities to
- define constants and byte sequences are extensive (".BYTE", ".WORD",
- ".DBYTE", ".FLOAT", ".SBYTE" for ATASCII, ".CBYTE" for terminated
- strings, separate offset for all constants). Over time, additional
- platform compilers have been added, and their support will be
- completed step by step. When the support for MADS was relatively
- complete, I found it the most powerful compiler I have ever seen and
- used. The support for ".PROC/.ENDPROC" has revolutionized how I
- write assembler code. It allows logical structuring and visibility
- control without any runtime overhead. At the same time, MADS is
- compatible with MAC/65 and XASM, and even ATASM sources can be
- adapted to MADS with a few minor changes described below. Therefore,
- MADS has been the primary compiler since WUDSN IDE version 1.6.0.
-
-
-
Why do I get the error "No ORG defined" when compiling the
- example from the tutorial?
-
Since WUDSN IDE version 1.6.0 MADS is the primary compiler
- registered for the file extensions ".asm" upon installation. You are
- trying to run the code example for version 1.5.0 or before, which is
- in ATASM format. Therefore, you can either.
-
-
-
-
Why are the errors and warnings from an included file
- assigned to the primary source file in the problems view?
-
You use a case-insensitive file system and have used different
- upper or lower-case writing in the statement than in the actual file
- system. For example, you have written "ICL 'example.asm'" for a file
- named "Example.asm" on the file system. In Eclipse, the file names
- of all resources are treated as case-sensitive, even if the
- underlying file system is case-insensitive. Therefore, the file name
- issued by the compiler will not match the file name. The IDE assigns
- the error message to the primary source file as a fallback. To fix
- this, you must adapt the spelling of the file name in the source
- include statement.
-
-
-
How do I convert from ATASM format to MADS format?
-
Because both ATASM's and MADS's syntax are based on the MAC/65
- syntax. There are not many differences. Therefore, manual conversion
- using "Find/Replace (CTRL-F)" is easy.
-
- - Replace the origin definition "* = address" with "ORG
- address".
- - Replace ".INCLUDE" with "ICL" for source includes.
- - Replace ".INCBIN" with "INS" for binary includes.
- - Replace "* = $2E0; .WORD address" with "RUN address" to
- specify the run address.
- - Replace "* = $2E2; .WORD address" with "INI address" to
- specify the initialization address.
- - Check the quotes of ".BYTE" and "DTA" statements. In MADS,
- single quotes result in ASCII codes and double quotes in ATARI
- screen codes.
- - Remove all ".BANK" statements. While ATASM sorts and merges
- all segments within one bank statement, MADS uses the order of
- segments defined in the source file. Every "ORG" statement
- automatically generates a new file segment.
-
-
-
-
How does ATASM generate segments in executable files?
-
A helpful feature for small projects is that, by default,
- ATASM sorts the segments by address and warns if the same address is
- overwritten by code or data. Since version 1.05, the ".BANK"
- directive is available, which allows you to create COM files with
- "INITAD" segments and arbitrary segment counts. If you don't use the
- ".BANK" directive, ATASM will sort the segments by their address and
- put consecutive blocks into a single segment by default. While this
- saves some bytes, it might be unclear if you are used to other
- assemblers. Note that you must use the ".SET 6" directive to set the
- assembler origin offset in every bank if you use it in one of the
- banks.
-
- ; Bank 0
.bank
.set 6,0
* = $8000
start
- lda #0
jmp *
; Bank 1
.bank .set 6,0
*
- = $2e0
.word start;
; Bank 2
.bank
.set
- 6,$4300-$C000
* = $C000
lda #1
sta label+1
label
- lda #2
jmp *
-
-
-
-
How do I compile into ROM images?
-
Plain ROM Images do not have header bytes by default, or at
- least they do not have the same header bytes as executable files.
- Compiler-specific options must be used to create raw object files
- without headers. Some cases are listed below. See the manual of the
- specific compiler for more details.
-
- - ACME: Use the compiler parameter " -f plain "
- instead of "-f cbm" (default) to switch to "plain" mode without a
- header
-
- - ATASM: Extend the compiler parameter "-o${outputFilePath}"
- to " -r -o${outputFilePath}" to switch to "raw" mode without
- header
-
- - MADS: Use " OPT h-f+ " at the very beginning of the
- source file to turn off the COM header and enable "fill" mode,
- i.e., no segments are created if there are gaps in the object code
-
-
-
-
-
How do I compile into disk images?
-
Atari 8-bit
-
- For Atari 8-bit, the ATASM compiler has a dedicated parameter to
- write the executable file directly into ".ATR" or ".XFD" disk
- images. The disk image must be formatted with Atari DOS 2.0S, DOS
- 2.5, or a compatible DOS. All Atari 8-bit disk formats can be
- created using the "dir2atr.exe" tool of the AtariSIO tools by Matthias Reichl
- (hias). The command line tool can create a complete disk image with
- arbitrary DOS (Atari DOS 2.5, MyDos, SpartaDOS) and size based on a
- folder that contains "DOS.SYS", "DUP.SYS" (or the equivalent files
- of the respective DOS) and all other files requires. I have packaged
- an example, including the "dir2atr" tool, a batch script to call the
- command line tool and emulator, and this archive's "files" folder.
- Unpack the archive to your output folder. Double-click
- "makefile.bat" to see how the disk image is created and started.
- Read the section "How to run a
- makefile script instead of an emulator?" for the details on
- configuring the call to "makefile.bat". For productive usage, you
- should put the "hias" folder into a central location and use the
- most recent version from Matthias Reichl's website. For MacOS X
- users, the download also contains a "makefile.sh" script and MacOS X
- binaries of Matthias Reichl's tools. The binaries have been provided
- by Fredrick Holst (freetz), and you can find the latest versions on
- his website.
-
-
Apple II
-
- For Apple II, WUDSN IDE automatically generates a bootable AppleDos
- 3.3 disk image with the extension ".dsk" if one of the predefined
- emulators is used for execution. If you want to use another DOS or
- disk size or if you're going to put more files onto the disk after
- compilation, you can use the command line version of AppleCommander to
- achieve this. Create and configure a makefile script as described in
- "How to run a makefile script instead
- of an emulator?". In the case of Apple Disk images, always remember
- to use the correct file content/load/run address. The IDE needs to
- know the load address of an executable file to store this
- information in the directory entry. The IDE evaluates the file
- extension to detect the load address from the executable file.
- Supported extensions are ".b", ".prg," and ".xex". Here's the logic
- for the built-in disk image creation:
-
-
- - File extension ".b"
// AppleDos 3.3 binary file:
- start-lo, start-hi, length-lo, length-hi, data
address =
- getWord(outputFileContent, 0);length = length - 4;content =
- getData(outputFileContent, 4);
-
- - File extension ".prg" and length > 2
// C64
- program file: start-lo, start-hi, data
address =
- getWord(outputFileContent, 0);length = length - 2;content =
- getData(outputFileContent, 2);
-
- - File extension ".xex" and length > 6 and
- (getWord(outputFileContent, 0) & 0xffff) == 0xffff)
//
- AtariDOS 2.5 binary file:$ff, $ff, start-lo, start-hi, end-lo,
- end-hi, data
address = getWord(outputFileContent, 2);length
- = length - 6;content = getData(outputFileContent, 6);
-
-
-
Other hardware
-
- If you find a tool similar to "dir2atr.exe" for the Atari 8-bit or
- "AppleCommander" for the Apple II, you can create your script and
- run it as described in "How to run a
- makefile script instead of an emulator?".
-
-
-
-
How can I run a makefile or script instead of an emulator?
-
- Sometimes, running a makefile script instead of the emulator is
- helpful, for example, if the output file is combined with other
- files into a single ATR file. To execute such a script, select "User
- Defined Application" as the "Default Application to open Output
- File". Specify the path to the shell as "Path to Application". On
- the command line, you can then use the standard variables to start
- the command shell and pass the script's name and the file path of
- the compiled output file. Since the working directory during
- execution is the compiler's output folder, you must place the script
- file there or specify the script file with its absolute path. If you
- are using Windows and "cmd.exe" as your shell, you must add "/c"
- before the name of the script to prevent "cmd.exe" from remaining as
- a process after the script has finished. The resulting command line
- is "${runnerExecutablePath} /c makefile.bat ${outputFilePath}",
- assuming "makefile.bat" is located in the output folder". See
- section "How do I compile into disk
- images?" for the description of how to use this for compiling
- complete disk images.
-
-
-
-
Emulation
-
-
How can I use other emulators?
-
You can "re-use" the existing tabs and specify another
- emulator's executable. Using "User Defined Application", you can
- select whatever you want. When using "User Defined Application", no
- disk image is created or updated. You can use this setting to have
- your script, which puts the executable file onto a disk image of
- your choice, using additional tools like "dir2atr.exe" or
- "AppleCommander," for example.
-
-
-
\ No newline at end of file
+How do I install Java?
+I recommend you visit OpenJDK and follow the instructions to download and install the latest version. Make sure the Java version, the Eclipse version, and your operating system have the same architecture. Newer versions of Java only support 64-bit architectures.
+
+
+
Nothing happens When I try to start a .jar file via double-click. What is wrong?
+
You probably have the wrong Java version installed or set a default. Open a shell window and enter "java -jar <yourfile.jar>". If this works, then you have the wrong program or Java version associated with the ".jar" file extension in the registry. You can fix that by setting the path to the correct Java installation folder using "REGEDIT.EXE" for "Compute\HKEY_CLASSES_ROOT\jarfile\shell\open".
+
+
If starting from the command line does not work, you should see a more detailed error message about why.
+
+
+
How do I install Eclipse?
+
If you are unfamiliar with Eclipse, ensure you have installed the Eclipse platform distribution without Java or J2EE tools. This distribution is much smaller (typically around 60-80 MB instead of 170 MB) and will not confuse you with many features and buttons you do not need. See the "Installing Eclipse" section for the required steps on the "Installation" tab.Â
+
+
+
When I try to start Eclipse, I get an error like "Failed to load the JNI shared library 'C:\Program Files (x86)\Java\jre6\bin\client\jvm.dll'". What is wrong?
+
The Eclipse and Java versions on your system are incompatible. The Eclipse is not pure Java but uses platform-specific native libraries to run and debug Java efficiently. For example, you must install the 64-bit version of Java (JRE or JDK) if you want to use the 64-bit version of Eclipse. This is a frequent issue under Windows 7 because, by default, only the 32-bit version of Java is installed. See the "Installing Eclipse" section for the required steps on the " Installation " tab.
+
+
+
How do I use Eclipse at?
+
Start the built-in help of Eclipse via the "Help/Help Content" menu and read the "Workbench User Guide" section.
+
+
+
Why is WUDSN IDE not available via the update site?
+
You likely typed in the wrong update site URL, for example, using "wusdn" instead of "wudsn". The correct URL is "http://www.wudsn.com/update". In addition, you should uncheck the checkbox "Hide items that are already installed" to see what is there. See the "Installing WUDSN IDE" section for the required steps on the " Installation " tab.
+
+
+
Why do I get "Unable to read repository at ... Read timed out" when accessing the update site?
+
This error message indicates the Eclipse program is somehow blocked from accessing the site. If you are behind a proxy server, check the general proxy server settings in the Eclipse preferences. If you use a firewall or internet security tool, make sure "Eclipse.exe", "java.exe", "javaw.exe," or the corresponding program on your host platform are allowed to cannot to the internet. Maybe you have to change the settings so you are prompted to allow access interactively.
+
+
+
Why do I get "Cannot complete the install because one or more required items could not be found" when updating the plugin from the update site?
+
This error message indicates that the Eclipse version you are running is too old. Check the releases page for the required minimum Eclipse version for every WUDSN IDE release.
+
+
+
Why is the "Assembler" section not visible in the preferences?
+
If the WUDSN IDE sections and features are not visible after a successful installation, you probably use an outdated Java version. For example, Java 1.6 has been out of maintenance since 2013/02. This seems to be a common problem on Mac OS X, even in Mavericks (10.9), which still uses Java 1.6 by default. Ensure you have at least the Java version mentioned in the installation section for the IDE installed and that Eclipse has started using that version.
+
+Configuration
+
+
Why do I see wrong messages in the "Problems" view?
+
The default configuration of the "Problems" view shows all errors from all files in the current project. While this is a good default for Java programming, it is unsuitable for compiling single independent assembler files. Therefore, you have to configure the "Problems" view accordingly. See the "Installing Eclipse" section for the required steps on the " Installation " tab.
+
+
+
How do I associate my source file extensions with the correct editor?
+
The IDE supports many compilers and provides specialized editors. Typically, you have some preferred source file extension (".asm" or ".a") and a preferred compiler. The procedure to associate the file extension with the editor via the preferences is described in this video tutorial WUDSN IDE Tutorial 3: Setting up Editors and File Extensions correctly.
+
+
+
Why must I put ";@com.wudsn.ide.lng.hardware=..." in the source file?
+
The association with the file extension with your compiler's editor (done in the preferences; see before) does not determine which platform you want to create output. Therefore, this additional annotation in the main source file must tell the IDE, which is the target platform. It is used to find the correct compiler and emulator settings, which can differ per platform. Every compiler has a default platform (see the online help in the IDE), but it can also be used on every other platform. Therefore, you must specify the target platform in the main source file if you use a non-default platform.
+
+
+Editing
+
+
Why is editing sometimes slow, or is everything blocked, showing the wait cursor?
+
The core of WUDSN IDE uses the Eclipse Platform Runtime only and does not require any additional plugins. It starts quickly and dashes with that configuration, and I use it daily. So, if you experience performance problems, try to download and run the zero installation distribution of WUDSN IDE. Performance problems are very likely caused by additional plugins or themes installed. Often, these plugins are not only slow but broken. Check the ".metadata/.log" file in the workspace folder. In some Eclipse versions, this is available via "Window/Show View.../Error Log".
+
+
+
Is there support for source version control?
+
Several plugins are available to connect Eclipse to CVS or subversion. Also, the "Local History" feature is installed by default. You can configure it in the preferences. It automatically records all changes to the source file and lets you compare versions in place.
+
+
+
Is there support for a block selection mode?
+
A toolbar button and the shortcut "ALT+SHIFT+A" to toggle block selection mode in all text editors. This can be useful for adding and removing common prefixes such as line numbers.
+
+
If the toolbar button is not visible, you have to set it to visible via the menu entry "Customize Perspective" in the context menu of the main toolbar. In the customizing dialog, you must activate the "Editor Presentation" command group and the toolbar entries you want to see.
+
+
+
Why does "CTRL-Space" not open content assist?
+
There is a known keyboard assignment conflict when using Messenger Plus Live! v4.85.0.386 with Microsoft Messenger 2009 on Windows 7 Ultimate. This may also occur in other versions, of course. Justin Payne has provided the following description of the solution.
+
+- Startup and log into MS Messenger.
+- From the main window, hit the ALT key to bring up the main menu and select "Plus! | Preferences & Options".
+- From the Preferences windows, Select the Messenger tab and uncheck "Activate Messenger Lock with a system-wide shortcut" OR change the value in its text box to something other than "CTRL + Space".
+- Press the "OK" button.
+
+
+
+
Why do CTRL-SHIFT-0/9 and other key combinations not work?
+
You probably have another program outside of Eclipse that has already captured these keys or key combinations. A frequent problem is the Windows Input Methods Editor (IME), which is used to switch keyboard layouts. For example, if you use multiple keyboard layouts, the CTRL-Space is mapped to allow you to cycle between the different keyboard regional keyboard layouts. You should be aware of how to turn the feature off since you're probably using this feature, but if you don't...
+
Windows 7
+
+- Within "Windows Control Panel", open "Region and Settings".
+- Select the "Keyboard and Languages" tab and "Change Keyboards...".
+- In the "Text Services and Input Languages" windows, select "Advanced Key Settings".
+- In the "Hot Keys for input languages" list box, select "Between input languages" and then select "Change Key Sequence..."
+- In the "Change Key Sequence" window, choose another radio button other than the one next to CTRL+Shift. At best, you choose "(None)".
+- Click OK until you close all popup windows.
+
+
Windows 10
+
+- Open "Control Panel\Clock, Language, and Region\Language\Advanced settings.
+- Click the "Change Language bar hot keys".
+- Set all key sequences to "(None)".
+- Click OK until you close all popup windows.
+
+
Of course, this is Windows 7/10, and we know how Microsoft loves to change its layouts and names, but this option is available back to Windows XP.
+
+Building
+
+
Why is MADS the primary assembler?
+
When I started with WUDSN IDE, ATASM was the first supported compiler. The reason was simple: 90% of my sources are in ATASM format. ATASM is very comprehensive and fast. Its capabilities to define constants and byte sequences are extensive (".BYTE", ".WORD", ".DBYTE", ".FLOAT", ".SBYTE" for ATASCII, ".CBYTE" for terminated strings, separate offset for all constants). Over time, additional platform compilers have been added, and their support will be completed step by step. When the support for MADS was relatively complete, I found it the most powerful compiler I have ever seen and used. The support for ".PROC/.ENDPROC" has revolutionized how I write assembler code. It allows logical structuring and visibility control without any runtime overhead. At the same time, MADS is compatible with MAC/65 and XASM, and even ATASM sources can be adapted to MADS with a few minor changes described below. Therefore, MADS has been the primary compiler since WUDSN IDE version 1.6.0.
+
+
+
Why do I get the error "No ORG defined" when compiling the example from the tutorial?
+
Since WUDSN IDE version 1.6.0 MADS is the primary compiler registered for the file extensions ".asm" upon installation. You are trying to run the code example for version 1.5.0 or before, which is in ATASM format. Therefore, you can either.
+
+
+
+
Why are the errors and warnings from an included file assigned to the primary source file in the problems view?
+
You use a case-insensitive file system and have used different upper or lower-case writing in the statement than in the actual file system. For example, you have written "ICL 'example.asm'" for a file named "Example.asm" on the file system. In Eclipse, the file names of all resources are treated as case-sensitive, even if the underlying file system is case-insensitive. Therefore, the file name issued by the compiler will not match the file name. The IDE assigns the error message to the primary source file as a fallback. To fix this, you must adapt the spelling of the file name in the source include statement.
+
+
+
How do I convert from ATASM format to MADS format?
+
Because ATASM's and MADS's syntax are based on the MAC/65 syntax. There are not many differences. Therefore, manual conversion using "Find/Replace (CTRL-F)" is easy.
+
+- Replace the origin definition "* = address" with "ORG address".
+- Replace ".INCLUDE" with "ICL" for source includes.
+- Replace ".INCBIN" with "INS" for binary includes.
+- Replace "* = $2E0; .WORD address" with "RUN address" to specify the run address.
+- Replace "* = $2E2; .WORD address" with "INI address" to specify the initialization address.
+- Check the quotes of ".BYTE" and "DTA" statements. In MADS, single quotes result in ASCII codes and double quotes in ATARI screen codes.
+- Remove all ".BANK" statements. While ATASM sorts and merges all segments within one bank statement, MADS uses the order of segments defined in the source file. Every "ORG" statement automatically generates a new file segment.
+
+
+
+
How does ATASM generate segments in executable files?
+
A helpful feature for small projects is that, by default, ATASM sorts the segments by address and warns if the same address is overwritten by code or data. Since version 1.05, the ".BANK" directive is available, which allows you to create COM files with "INITAD" segments and arbitrary segment counts. If you don't use the ".BANK" directive, ATASM will sort the segments by their address and put consecutive blocks into a single segment by default. While this saves some bytes, it might be unclear if you are used to other assemblers. Note that you must use the ".SET 6" directive to set the assembler origin offset in every bank if you use it in one of the banks.
+
; Bank 0
.bank
.set 6,0
* = $8000
start lda #0
jmp *
; Bank 1
.bank .set 6,0
* = $2e0
.word start;
; Bank 2
.bank
.set 6,$4300-$C000
* = $C000
lda #1
sta label+1
label lda #2
jmp *
+
Â
+
+
+
How do I compile into ROM images?
+
Plain ROM Images do not have header bytes by default, or at least they do not have the same header bytes as executable files. Compiler-specific options must be used to create raw object files without headers. Some cases are listed below. See the manual of the specific compiler for more details.
+
+- ACME: Use "
-f plain
" instead of "-f cbm
" (default) as an assembler parameter to switch to "plain" mode without a header.
+- ATASM: Extend the "
-o${outputFilePath}
"Â assembler parameter to " -r -o${outputFilePath}
" to switch to "raw" mode without a header.
+- MADS: Add "
OPT h-f+
" at the beginning of the source file to turn off the COM header and enable "fill" mode, i.e., no segments are created if there are gaps in the object code.
+
+
+
+
How do I compile into disk images?
+
Atari 8-bit
+
For Atari 8-bit, the ATASM compiler has a dedicated parameter to write the executable file directly into ".ATR" or ".XFD" disk images. The disk image must be formatted with Atari DOS 2.0S, DOS 2.5, or a compatible DOS. All Atari 8-bit disk formats can be created using the "dir2atr.exe" tool of the AtariSIO tools by Matthias Reichl (hias). The command line tool can create a complete disk image with arbitrary DOS (Atari DOS 2.5, MyDos, SpartaDOS) and size based on a folder that contains "DOS.SYS", "DUP.SYS" (or the equivalent files of the respective DOS) and all other files requires. I have packaged an example, including the "dir2atr" tool, a batch script to call the command line tool and emulator, and this archive's "files" folder. Unpack the archive to your output folder. Double-click "makefile.bat
" to see how the disk image is created and started. Read the section "How to run a makefile script instead of an emulator?" for the details on configuring the call to "makefile.bat
". For productive usage, you should put the "hias" folder into a central location and use the most recent version from Matthias Reichl's website. For MacOS X users, the download also contains a "makefile.sh
" script and MacOS X binaries of Matthias Reichl's tools. The binaries have been provided by Fredrick Holst (freetz), and you can find the latest versions on his website.
+
Apple II
+
For Apple II, WUDSN IDE automatically generates a bootable AppleDos 3.3 disk image with the extension ".dsk" if one of the predefined emulators is used for execution. If you want to use another DOS or disk size or if you're going to put more files onto the disk after compilation, you can use the command line version of AppleCommander to achieve this. Create and configure a makefile script as described in "How to run a makefile script instead of an emulator?". In the case of Apple Disk images, always remember to use the correct file content/load/run address. The IDE needs to know the load address of an executable file to store this information in the directory entry. The IDE evaluates the file extension to detect the load address from the executable file. Supported extensions are ".b", ".prg," and ".xex". Here's the logic for the built-in disk image creation:
+
+File extension ".b"
// AppleDos 3.3 binary file: start-lo, start-hi, length-lo, length-hi, data
address = getWord(outputFileContent, 0);length = length - 4;content = getData(outputFileContent, 4);
+File extension ".prg" and length > 2
// C64 program file: start-lo, start-hi, data
address = getWord(outputFileContent, 0);length = length - 2;content = getData(outputFileContent, 2);
+File extension ".xex" and length > 6 and (getWord(outputFileContent, 0) & 0xffff) == 0xffff)
// AtariDOS 2.5 binary file:$ff, $ff, start-lo, start-hi, end-lo, end-hi, data
address = getWord(outputFileContent, 2);length = length - 6;content = getData(outputFileContent, 6);
+
+
Other hardware
+
If you find a tool similar to "dir2atr.exe" for the Atari 8-bit or "AppleCommander" for the Apple II, you can create your script and run it as described in "How to run a makefile script instead of an emulator?".
+
+
+
How can I run a makefile or script instead of an emulator?
+
Sometimes, running a makefile script instead of the emulator is helpful, for example, if the output file is combined with additional files into a single ATR file. To execute such a script, select "User Defined Application" as the "Default Application to open Output File". Specify the path to the shell as "Path to Application". On the command line, you can then use the standard variables to start the command shell and pass the script's name and the file path of the compiled output file. Since the working directory during execution is the compiler's output folder, you must place the script file there or specify the script file with its absolute path. If you are using Windows and "cmd.exe" as your shell, you must add "/c" before the name of the script to prevent "cmd.exe" from remaining as a process after it is finished. The resulting command line is "${runnerExecutablePath} /c makefile.bat ${outputFilePath}", assuming "makefile.bat" is located in the output folder". See section "How do I compile into disk images?" for the description of how to use this for compiling complete disk images.
+
+Emulation
+
+
How can I use other emulators?
+
You can "re-use" the existing tabs and specify another emulator's executable. Using "User Defined Application", you can select whatever you want. When using "User Defined Application", no disk image is created or updated. You can use this setting to have your script, which puts the executable file onto a disk image of your choice, using additional tools like "dir2atr.exe" or "AppleCommander," for example.
+
+
diff --git a/com.wudsn.ide.lng/help/ide-features.section.html b/com.wudsn.ide.lng/help/ide-features.section.html
index 403f6c18..4afffe47 100644
--- a/com.wudsn.ide.lng/help/ide-features.section.html
+++ b/com.wudsn.ide.lng/help/ide-features.section.html
@@ -1,1032 +1,670 @@
The latest version contains the following features:
-
- General IDE enhancements  » top
-
+General IDE Enhancements  » top
- - "Open Folder" context menu available for all folders and files
- - "Sort" context menu with sub-menu available for all text files
- including
-
- - Case sensitive, case insensitive, and numeric sorting
- - Sorting with and without removal of duplicates
- - Reverse ordering
-
-
- - The online help contains the entry "WUDSN IDE Guide" which
- contains multiple sections.
-
- - WUDSN IDE - mainly the documentation from the web site
-
- - Video links to the tutorial and release news
- - Features
- - Installation
- - FQA
- - Link
-
-
- - Assemblers - the information on the supported assemblers and
- their properties
-
- - General - links, syntax, and support features
- - Instructions - all supported instruction including their
- descriptions grouped by type
- - Manual - direct access to the PDF, HTML, or text manual
- file or files which are part of the compiler installation
-
-
- - Hardware - the information on the supported hardware types
- and the corresponding emulators and links
-
- - Reference documentation - Hardware specific PDF, HTML, or
- text files with CPU and customer chips reference sheets and
- programming guides
-
-
-
-
-
-
- Fully integrated assembler editor  » top
-
+The "Open Folder" context menu is available for all folders and files.
+The "Sort" context menu with sub-menu is available for all text files, including
- - The Eclipse platform contains editors like for example the
- generic text editor. Editors can support one or more content types
- identified by file extensions. One editor can be the default for a
- specific file extension. WUDSN IDE provides an assembler editor and a
- corresponding content type for every compiler. Every assembler editor
- has a default compiler associated which in turn defines via the
- preferences which application is used to run the output file.
-
-
- - New content types and file associations for Atari 2600
- compilers
-
- - DASM Source File (*.asm)
-
-
- - New content types and file associations for Atari 8-bit
- compilers
-
- - ATASM Source File (*.asm)
- - MADS Source File (*.asm, default)
- - XASM Source File (*.asx, default)
-
-
- - New content types and file associations for C64 compilers
-
- - ACME Source File (*.a, default)
-
-
- - New content types and file associations for NES compilers
-
- - ASM6 Source File (*.asm)
-
-
- - The default editor for an extension can be configured in
- section "File Associations" of the preferences with the button
- "Default"
-
- - Syntax highlighting colors and styles for comments,
- directives, all types of identifiers, legal opcodes, illegal opcodes,
- pseudo opcodes, and strings
- - Single line comments for the current line selection can be
- toggled using "CTRL-7" or the editor context menu entry "Toggle
- Comment"
- - Configurable support for 16-bit opcodes of 65816
- - Built-in support for ATASM assembler, MADS assembler, XASM assembler, ACME assembler
- - Built-in support for running compiler output files with the
- operating system default application without configuration effort
- - Built-in support for Altirra emulator, Atari800Win emulator, Atari800MacX emulator, Atari++ emulator
- - Adding support for new compilers and application is possible
- via Eclipse extension points
-
- - Build or build and run with a single keystroke or via the menu
- - Toolbar button for "Build and Run" which adapts to the
- hardware of the currently opened editor, for example, it will show a
- C64 icon when using the "ACME (C64)" editor
- - The toolbar button for "Build and Run" offers a pulldown menu
- that allows running the output file with any of the applications
- configured in the preferences. This way you can run the output file
- easily with different emulators without changing the preferences. That
- can be very helpful if one emulator shows different behavior than
- another or in case you have specified a build script as a user-defined
- application in the preferences
-
- - Open source and output folder directly from the menu
- - Open compiler help directly from the menu if the documentation
- is available in the default folder structure of the compiler
- executable
-
- - Complete list of compiler error and warning messages in the
- problems view
- - Direct navigation to the source location of the via double
- click on the problem message
- - Problem markers in the scroll area including tooltip with
- problem message
-
- - German localization for all Eclipse plugin texts. The original
- compiler messages are not translated but some are mapped automatically
-
-
- - ATASM ".bank" warnings are mapped to info messages
-
-
- - Console view with original compiler output opens automatically
- in the background after compiling which useful in cases where the
- plugin is not yet complete. The "Compiler Console" is automatically
- brought to front when the compiler starts. This prevents the compiler
- output from being hidden behind other consoles in the console view
-
-
+- Case-sensitive, case-insensitive, and numeric sorting
+- Sorting with and without removal of duplicates
+- Reverse ordering
-
- Content outline and source folding  » top
-
+
+The online help contains the "WUDSN IDE Guide" with the following multiple sections.
- - Activated via the standard menu "Window/Show View/Outline"
- - Automated asynchronous parsing while typing
- - Automated recursive parsing of source includes and merge with
- the current outline
- - Positioning in the content outline remains stable while typing
- unless structure changes appear
- - Folding is activated automatically when the outline is visible
- - Folding for if/else/endif blocks
- - Outline and folding for definition section and implementation
- sections
- - Outline for equate definitions (including defining
- expression), label definitions, and variable definitions
- - Outline and folding for enum and struct definitions
- - Outline and folding for macros definitions
- - Outline and folding for repeat sections
- - Outline and folding for procedure definitions
- - Outline and folding for local sections
- - Outline for source includes and binary includes
- - Type-specific outline icons
- - Nested folding with tooltip for folded sections
- - Line end comment is used as a short description
- - Toolbar with a button to toggle the sorting order of the
- sections and labels. The state of the button is persisted
- automatically along with the respective source file. For files that do
- not have a setting yet, the setting from the currently opened file
- will be used
-
-
-
- Content assist and code completion  » top
-
+WUDSN IDE
This is the documentation from the website.
- - Content assist by pressing CTRL-Space for directives, legal
- opcode, illegal opcodes, and pseudo opcodes
- - The content assist also recognizes if there is already an
- instruction in the current line and suggests the available identifiers
- instead if this is the case. This is the first version and it supports
- global identifiers in the current source file and source file included
- from there. Scoped identifiers of the form "a.b" are not yet supported
- - Completion proposal auto-activation without pressing
- CTRL-Space after typing compiler dependent characters, for example "."
- in ATASM, "." or "#" in MADS and "!" in ACME
- - Type-specific icon and mnemonic highlighting
- - Progressive filtering as you type
- - Automatic detection of lower case / upper case based on
- current input
- - Default case configurable in preferences
- - Illegal opcodes can be hidden via preferences
- - 16-bit opcodes of 65816 can be hidden via preferences
-
- - Multi-line content completion and explicit cursor positioning,
- for example ".MA" becomes ".MACRO <cursor is here>
- <newline> .ENDM"
-
+- Video links to the tutorial and release news
+- Features
+- Installation
+- FQA
+- Link
-
- Hyperlink navigation  » top
-
+
+Assemblers
This is the information on the supported assemblers and their properties.
- - Hyperlink navigation via CTRL-click to source includes and
- binary includes
- - Support for relative and absolute file paths
- - Source files are always opened with the same assembler editor,
- irrespective of the extension
- - The ".asm" extension for "ICL" source includes is appended
- automatically in MADS, if it is missing
- - The ".asx" extension for "ICL" source includes is appended
- automatically in XASM, if it is missing
- - Option for binary includes for opening the file with
-
- - the built-in hex editor
- - the built-in graphics editor
- - the default Eclipse editor (e.g. a text editor)
- - system editor (e.g. an emulator or a paint program)
-
-
- - Hyperlink navigation via CTRL-click to labels equates, local
- definitions, macro definitions, and procedure definitions. In case
- there is only one target, direct navigation takes place. In case there
- is more than one possible target, the type and line number of the
- target are displayed in a hyperlink popup. All included source files
- are also taken into account like in the content outline. In case there
- are targets from different files, the file name is also displayed as a
- differentiator in the hyperlink popup.
-
+- General
Links, syntax, and support features.
+- Instructions
All supported instructions, including their descriptions, are grouped by type.
+- Manual
Direct access to the PDF, HTML, or text manual files or files that are part of the installation.
-
- Hex Editor  » top
-
+
+Hardware Platforms
The information on the supported hardware platforms and the corresponding emulators and links.
- - Read-only hex editor to inspect arbitrary files
- - Available via context menu including multi-file-selection to
- open several files at once
-
- - The "Open With Hex Editor" menu entry closes an existing
- editor in case the file is already opened and thereby forces the file
- to be opened with the hex editor. In addition, the hex editor is set
- as the default editor for this file. As a consequence double-clicking
- the file in the package explorer will open it automatically with the
- hex editor, no matter which type of file is actually is. This saves
- you from always using the context menu, just because the file has no
- known file type. You can change the default editor again by just using
- the "Open With" context menu entry
- - Available via hyperlink navigation for binary includes
- - Context menu to copy parts of the file into the clipboard in
- different formats:
-
- - hex values (".byte $01,$02,...")
- - decimal values (".byte 1,2,...")
- - ASCII string
-
This is very helpful to turn parts of a file into source code. The
- possibility to copy/paste into the binary file itself in order to
- modify is prepared but not working yet and will be completed later.
-
-
- - Support for binary files, Atari COM files, and Atari Disk
- Images
-
- - The possible file modes for a binary file are computed
- automatically and used as default when opening the file
- - Unsupported file modes are detected and cannot be used
- - Files with a block structure get an outline in the outline
- view
- - Files with a corrupted block structure are detected and
- displayed as good as possible
-
+- Reference documentation - Hardware-specific PDF, HTML, or text files with CPU and customer chips reference sheets and programming guides
-
- Graphics Editor  »
-
+
+
+
+
+Fully Integrated Assembler Editor  » top
- - Viewer for binary files and 8-bit image files.
The
- most suitable supported converter and the corresponding default
- parameters are computed based on the file content, size, and
- extension.
The converters for the Atari standard image formats
- are based on RECOIL fka. FAIL, the
- excellent First Atari Image Library created by Piotr Fusik and Adrian
- Matoga.
-
-
-
- Platform |
- File Extension |
- File Format |
-
-
- Atari 8-bit |
- AP3 |
- 80x192, 256 colors, interlaced |
-
-
- Atari 8-bit |
- APC |
- Any Point, Any Color, 80x96, 256 colors, interlaced |
-
-
- Atari 8-bit |
- CHR |
- 8x8 charset, mono or multicolor |
-
-
- Atari 8-bit |
- CCI |
- Champions' Interlace, 160x192, compressed |
-
-
- Atari 8-bit |
- CIN |
- Champions' Interlace, 160x192 |
-
-
- Atari 8-bit |
- CHG |
- Gephard Hires Graphics, up to 320x200, mono |
-
-
- Atari 8-bit |
- CPR |
- Trzmiel, 320x192, mono, compressed |
-
-
- Atari 8-bit |
- FNT |
- Standard 8x8 font, mono |
-
-
- Atari 8-bit |
- GR8 |
- Standard 320x192, mono |
-
-
- Atari 8-bit |
- GR9 |
- Standard 80x192, grayscale |
-
-
- Atari 8-bit |
- HIP |
- Hard Interlace Picture, 160x200, grayscale |
-
-
- Atari 8-bit |
- HR |
- Hires 256x239, 3 colors, interlaced |
-
-
- Atari 8-bit |
- HR2 |
- Hires 320x200, 5 colors, interlaced |
-
-
- Atari 8-bit |
- ILC |
- APAC 80x192, 256 colors interlaced |
-
-
- Atari 8-bit |
- INP |
- Interlace Picture 160x200, 7 colors, interlaced |
-
-
- Atari 8-bit |
- INT |
- INT95a, up to 160x239, 16 colors, interlaced |
-
-
- Atari 8-bit |
- MCP |
- McPainter, 160x200, 16 colors, interlaced |
-
-
- Atari 8-bit |
- MIC |
- Micropainter 160x192, 4 colors |
-
-
- Atari 8-bit |
- PIC |
- Koala MicroIllustrator, 160x192, 4 colors, compressed |
-
-
- Atari 8-bit |
- PLM |
- Plama 256, 80x96, 256 colors |
-
-
- Atari 8-bit |
- RIP |
- Rocky Interlace Picture, up to 160x239 |
-
-
- Atari 8-bit |
- SXS |
- 16x16 font, mono |
-
-
- Atari 8-bit |
- TIP |
- Taquart Interlace Picture, up to 160x119 |
-
-
- C64 |
- 64C |
- Charset, mono or multi color |
-
-
- C64 |
- SPR |
- Sprite, mono or multi color |
-
-
-
-
- - Viewer for GIF/JPG/BMP/PNG images
- - Available via context menu including multi-file-selection to
- open several files at once
-
- - The "Open With Graphics Editor" menu entry closes an existing
- editor in case the file is already opened and thereby forces the file
- to be opened with the graphics editor. In addition, the graphics
- editor is set as the default editor for this file. As a consequence
- double-clicking the file in the package explorer will open it
- automatically with the graphics editor, no matter which type of file
- it actually is. This saves you from always using the context menu,
- just because the file has no known file type. You can change the
- default editor again by just using the "Open With" context menu entry
- - Available via hyperlink navigation for binary includes
- - Conversion from binary files or 8-bit images files to
- GIF/JPG/BMP/PNG images
-
- - Up to different 3 source files depending on the converter
- - Configurable start offset for every source file, useful for
- extracting character sets
- - Configurable palette via the Image Palette view
- - Configurable number of rows and columns
- - Configurable spacing width for and spacing color to separate
- tiles and unused areas
- - Separate aspect ratio for display and saving the image file
-
-
- - Conversion from GIF/JPG/BMP/PNG images to binary files or
- 8-bit images using JavaScript.
-
- - Separate aspect ratio for loading and displaying the image
- file
- - Default scripts are included. They can be adjusted and saved
- along with the other parameters
-
-
- - The image palette view associated with the graphics editor
- displays the palette entries and the color histogram. It supports
- filtering of unused colors, sorting by index and color frequencies,
- pre-settings, and editing the palette when displaying 8-bit images
-
-
- - Conversion files with extension ".cnv" are used to save the
- conversion direction and all conversion parameters
- - Support for relative file paths. If the file path is in the
- same folder as the ".cnv" file, it is automatically converted to a
- relative file path when the file name is defaulted or picked from the
- file browser dialog. This allows to move the ".cnv" file and the
- referenced source files around together without breaking the saved
- paths
-
-
- Preferences for editing  » top
-
+The Eclipse platform contains editors like, for example, the generic text editor. Editors can support one or more content types identified by file extensions. One editor can be the default for a specific file extension. WUDSN IDE provides an assembler editor and a corresponding content type for every compiler. Every assembler editor has an associated default compiler, which defines via the preferences which application is used to run the output file.
+Content types and file associations for Atari 2600 compilersÂ
- - Available via entry "Preferences" from the menu "Window" (in
- Windows and Linux) or the menu "Eclipse" (in Mac OS X)
- - Configuration of syntax highlighting colors and styles for
- comments, directives, all types of identifiers, legal opcodes, illegal
- opcodes, numbers, pseudo opcodes, and strings
- - For non-unique identifiers, the syntax highlighting will try
- to be the best guess
- - Configuration of default case in content assist
-
+- DASM Source File (*.asm)
-
- Preferences for compiling  » top
-
+
+Content types and file associations for Atari 8-bit compilers
- - Available via entry "Preferences" from the menu "Window" (in
- Windows and Linux) or the menu "Eclipse" (in Mac OS X)
- - Separate compiler preferences page for every type of hardware,
- i.e. Atari 8-bit and C64; Apple 2 support is in development by Nick
- Westgate
- - Preferences can be maintained for all compilers in parallel
- - Upon opening the compiler preferences, the tab for the
- compiler of the active editor is activated automatically
- - Configuration of illegal opcodes and 65816 opcodes support in
- syntax highlighting and content assist
The configuration is
- offered only if the compiler supports the respective feature
-
- - Download links, configurable paths, and default parameters for
- all compilers
- - The default file extension filter is set to "*.exe" on Windows
- and "*.*" on all other operating systems
- - The button "Apply Defaults" does explicitly not reset the
- paths to the executables
- - Configuration of parameters per compiler including predefined
- defaults to run out-of-the-box
Possible variables are:
-
- - {$sourceFolderPath} The absolute path to the source folder
- - {$sourceFilePath} The absolute path to the source file
- - {$outputFolderPath} The absolute path to the output folder
- - {$outputFilePath} The absolute path to the output file
- - {$outputFileName} The name of the output file including its
- extension, for example "TestFile123.asm"
- - {$outputFileNameWithoutExtension} The name of the output
- file without extension, for example "TestFile123"
- - {$outputFileNameShortWithoutExtension} The name of the
- output file without extension shortened to 8 alphanumeric
- characters, for example "TESTFILE"
-
Make sure that you don't remove parameters when you specify your own
- values
If not, either creating the label definition file or
- parsing the compiler log may fail
-
- - ATASM requires the "-s" parameter to be present"
- - MADS requires the "-p" parameter to be present
- - ACME requires the "!to" directive in the source to be
- commented out to ensure the output file name from the command line
- is used
-
-
- - Preferences can be maintained for all possible applications of
- all compilers in parallel
-
- - Possibility to use the "Operating System Default
- Application" of the platform to open the output file
For
- Windows and Mac OS X choosing the "Operating System Default
- Application" means that for ".xex" file the emulator will be started
- automatically without any further configuration
-
- - Possibility to use one of the pre-defined applications and
- optionally change the command line
- - Possibility to use a user-defined application to open the
- output file
- - Possible variables are:
-
- - {$runnerExecutablePath} The absolute path to the
- executable of the application
- - {$sourceFolderPath} The absolute path to the source folder
- - {$sourceFilePath} The absolute path to the source file
- - {$outputFolderPath} The absolute path to the output folder
- - {$outputFilePath} The absolute path to the output file
- - {$outputFileName} The name of the output file including
- its extension, for example "TestFile123.asm"
- - {$outputFileNameWithoutExtension} The name of the output
- file without extension, for example "TestFile123"
- - {$outputFileNameShortWithoutExtension} The name of the
- output file without extension shortened to 8 alphanumeric
- characters, for example "TESTFILE"
-
-
-
-
- - Download links, configurable paths, and default command lines
- for Atari++, Atari800Win, Atari800MacX emulators per compiler
- - The default file extension filter is set to "*.exe" on Windows
- and "*.*" on all other operating systems
-
+- ATASM Source File (*.asm)
+- MADS Source File (*.asm, default)
+- XASM Source File (*.asx, default)
-
- Annotations for compiling  » top
-
+
+Content types and file associations for C64 compilers
- - For most use-cases, the defaults provided for the compilers
- and in the preferences are sufficient. But if you want to develop in
- parallel in multiple projects, for different platforms (Apple II and
- Atari 8-bit) or in different output formats (".XEX" and ".BIN") with
- the same compiler it may become cumbersome to change the preferences
- every time. Therefore WUDSN IDE offers annotations that you can put
- into the source code files. These annotations override the defaults
- and the preferences.
- - All language annotations start with the prefix
- "@com.wudsn.ide.lng." followed by the lower case name of the
- annotation, an equals sign, and the unquoted value. Example:
- "@com.wudsn.ide.lng.hardware=ATARI8BIT"
- - In earlier versions of WUDSN, language annotations started
- with the prefix "@com.wudsn.ide.asm.". While they are still evaluated,
- it is strongly recommended to adapt to the new prefix.
- - All annotations can be placed in comment lines at the
- beginning of a source file. Some of the annotations are only relevant
- for the main source file, some are only relevant in include source
- files, some are relevant for all source files.
- - @com.wudsn.ide.lng.hardware
-
- - Defines the target hardware for which the preferences shall
- be evaluated, in particular, which emulator is used to run the
- output file.
- - Allowed values are "APPLE2", "ATARI2600", "ATARI7800",
- "ATARI8BIT", "C64", "NES".
- - This annotation is relevant for all source files.
- - This annotation is only evaluated when a file is opened. So
- if you add this annotation or change its value, you have to close
- and re-open the file once.
- - Example: @com.wudsn.ide.lng.hardware=ATARI8BIT
-
-
- - @com.wudsn.ide.lng.mainsourcefile
-
- - Defines the main source file to which the current include
- source file belongs. When the "Compile" action is executed, the main
- source file is compiler instead of the current file.
- - Allowed values are file paths relative to the folder of the
- current include source file and absolute file paths.
- - This annotation is only relevant in include source files.
- - Example: @com.wudsn.ide.lng.mainsourcefile=ExampleMain.asm
-
-
- - @com.wudsn.ide.lng.outputfoldermode
-
- - Overrides the "Output Folder Mode" from the preferences.
- - Allowed values are "SOURCE_FOLDER", "TEMP_FOLDER",
- "FIXED_FOLDER".
- - This annotation is only relevant in the main source file.
- - Example: @com.wudsn.ide.lng.outputfoldermode=SOURCE_FOLDER
-
-
- - @com.wudsn.ide.lng.outputfolder
-
- - Overrides the "Output Folder" from the preferences and the
- "@com.wudsn.ide.lng.outputfoldermode" annotation.
- - Allowed values are file paths relative to the folder of the
- main source file and absolute file paths.
- - This annotation is only relevant in the main source file.
- - Example: @com.wudsn.ide.lng.outputfolder=..\out
-
-
- - @com.wudsn.ide.lng.outputfileextension
-
- - Overrides the "Output File Extension" from the preferences.
- - Allowed values have to start with a period.
- - This annotation is only relevant in the main source file.
- - Example: @com.wudsn.ide.lng.outputfileextension=.bin
-
-
- - @com.wudsn.ide.lng.outputfile
-
- - Overrides the "Output Folder", "Output File Extension" from
- the preferences and the automatic computation of the out file name
- based on the main source file name.
- - Allowed values are file paths relative to the folder of the
- main source file and absolute file paths.
- - This annotation is only relevant in the main source file.
- - Example: @com.wudsn.ide.lng.outputfile=..\out\output.bin
-
-
+- ACME Source File (*.a, default)
-
- Known bugs  » top
-
+
+New content types and file associations for NES compilers
+
+- ASM6 Source File (*.asm)
+
+
+The default editor for a file extension can be configured in the "File Associations" section of the preferences with the "Default " button.
+Syntax highlighting provides colors and styles for comments, directives, different types of identifiers, legal opcodes, illegal opcodes, pseudo opcodes, and strings.
+Single-line comments for the current line selection can be toggled using "CTRL-7" or the editor context menu entry "Toggle Comment".
+Support for illegal opcodes of the 6502 CPU is configurable.
+Support for 16-bit opcodes of the WDC 65816 CPU is configurable.
+Built-in support for ATASM assembler, MADS assembler, XASM assembler, ACME assembler
+Built-in support for running compiler output files with the operating system default application without configuration effort
+Built-in support for Altirra emulator, Atari800Win emulator, Atari800MacX emulator, Atari++ emulator
+Adding support for new compilers and applications is possible via Eclipse extension points.
+Build or build and run with a single keystroke or via the menu.
+Toolbar button for "Build and Run", which adapts to the hardware of the currently opened editor. For example, it will show a C64 icon when using the "ACME (C64)" editor.
+The toolbar button for "Build and Run" offers a pulldown menu that allows running the output file with any of the applications configured in the preferences. You can run the output file quickly with different emulators without changing the preferences. That can be very helpful if one emulator shows another behavior or if you have specified a build script as a user-defined application in the preferences.
+The "Open Source Folder" and "Open Output Folder" entries the respective folder directly from the menu.
+The "Language Help" entry opens the language-specific help from the menu if the documentation is available in the default folder structure of the assembler/compiler executable.
TODO: Note that the images below are outdated and must be updated.
+The complete list of assembler/compiler errors and warning messages in the problems view.
+Direct navigation to the source location is supported by double-clicking the problem message.
+Problem markers in the scroll area, including the tooltip with the problem message.
+German localization is available for all Eclipse plugin texts. The original compiler messages are not translated, but some are mapped automatically.
+
+- ATASM ".bank" warnings are mapped to info messages.
+
+
+The console view with compiler output opens automatically in the background after compiling, which is helpful in cases where the plugin is incomplete. The "Console" window is automatically brought to the front when the assembler/compiler starts. This prevents the compiler output from being hidden behind other consoles in the console view.
+
+Content Outline and Source Folding  » top
+The content outline and the folder of source code sections are two of the most helpful features of WUDSN IDE. They help you navigate and manage even huge source files efficiently. The standard menu "Window / Show View / Outline" activates the content outline. Source folding requires the content outline to be active. The content outline has the following features.
+
+- Nesting.
+- Type-specific icons.
+- Automated asynchronous parsing while typing.
+- Automated recursive parsing of source includes and merges with the current outline.
+- Positioning in the content outline remains stable while typing unless structure changes appear.
+- Outline is supported for
+
+- equate definitions (including equates from defining expression)
+- labels
+- and variable definitions
+- source includes
+- binary includes
+
+
+- Outline and folding are supported for
+
+- definition section
+- implementation sections
+- enum definition
+- struct definitions
+- macro definitions
+- repeat sections
+- procedure definitions
+- local sections.
+
+
+- The line-end comment is a short description in the outline.
+- The toolbar has a button to toggle the sorting order of the sections and labels. The state of the toggle button is persisted automatically along with the respective source file. The setting from the currently opened file will be used for files that do not have a value set yet.
+- Folding is activated automatically when the outline is visible.
+- Folding is nested with a tooltip for folded sections.
+- Folding is supported for if/else/endif blocks.
+
+Content Assistance and Code Completion  » top
+Content assistance provides proposals as you type and lets you enter code more efficiently. Content assistance is activated by pressing "CTRL-Space" or automatically by typing special characters. The content assistance has the following features.
+
+- Content assistance for directives, legal, illegal, and pseudo-opcodes.
+- Recognizes if there is already an instruction in the current line and suggests the available identifiers instead if this is the case. It supports global identifiers in the active source file and source files included from there.Â
+- Completion proposal auto-activation without pressing "CTRL-Space" after typing compiler-dependent characters, for example, "." in ATASM, "." or "#" in MADS, and "!" in ACME
+- Type-specific icon and mnemonic highlighting.
+- Progressive filtering as you type.
+- Automatic detection of lower-case/upper-case based on current input.
+- Configurable default case (lower-case, upper-case) via preferences.
+- Multi-line content completion and explicit cursor positioning, for example, ".MA" becomes "
.MACRO <cursor is here> <newline>.ENDM
".
+
+Hyperlink Navigation  » top
+The source code editor provides detection for different types of links in the source code. You can navigate to other parts of the file, other files, or websites via these links. You activate the hyperlink navigation by pressing "CTRL". The hyperlink navigation has the following features.
+
+- Hyperlink navigation via CTRL-click to source includes and binary includes.
+- Support for relative and absolute file paths.
+- Source files are always opened with the same assembler editor, irrespective of the extension.
+- Missing file extensions for source include statements are appended automatically where possible.
+- Option for binary include statements opening the file with:
+
+- The built-in hex editor
+- The built-in graphics editor
+- The default Eclipse editor (e.g., a text editor)
+- The system editor (e.g., an emulator or a paint program)
+
+
+- Hyperlink navigation via CTRL-click to labels equates, local definitions, macro definitions, and procedure definitions. In case there is only one target, direct navigation takes place. In case there is more than one possible target, the type and line number of the target are displayed in a hyperlink popup. All included source files are also considered, like in the content outline. If targets are from different files, the file name is also displayed as a differentiator in the hyperlink popup.
+
+Hex Editor  » top
+The Hex Editor allows inspection of arbitrary files on the binary level. It has the following features.
+
+- It is available via the context menu, including a multi-file selection to open several files simultaneously.
+- The "Open With Hex Editor" menu entry closes an existing editor in case the file is already opened, forcing the file to be opened with the hex editor. In addition, the hex editor is set as the default editor for this file. Consequently, double-clicking the file in the package explorer will open it automatically with the hex editor, no matter which file type. This saves you from always using the context menu just because the file has no known file type. Using the "Open With" context menu entry, you can change the default editor again.
+- It is available via hyperlink navigation for binary include statements.
+- The content offers a context menu to copy parts of the file into the clipboard in different formats:
+
+- hex values (".byte $01,$02,...")
+- decimal values (".byte 1,2,...")
+- ASCII string
+
+This is very helpful to turn parts of a file into source code. The possibility to copy/paste into the binary file to modify is prepared but not working yet and will be completed later.
+- It detects and supports the type of the file. For example, binary files, Atari COM files, Atari Disk Images, and several other file types.
+- The possible file modes for a binary file are computed automatically and used as default when opening the file.
+- Unsupported file modes are detected and cannot be used.
+- Files with a block structure get an outline in the outline view.
+- Files with a corrupted block structure are detected and displayed as well as possible.
+
+Graphics Conversion Editor  »
+The Graphics Conversion Editor views and converts many binary and image file formats. It has the following features.
+
+- Viewer for binary files and 8-bit image files.
The most suitable supported converter and the corresponding default parameters are computed based on the file content, size, and extension.
The converters for the Atari standard image formats are based on RECOIL fka. FAILÂ is the excellent First Atari Image Library created by Piotr Fusik and Adrian Matoga.
+
+
+
+Platform |
+File Extension |
+File Format |
+
+
+Atari 8-bit |
+AP3 |
+80x192, 256 colors, interlaced |
+
+
+Atari 8-bit |
+APC |
+Any Point, Any Color, 80x96, 256 colors, interlaced |
+
+
+Atari 8-bit |
+CHR |
+8x8 charset, mono or multi-color |
+
+
+Atari 8-bit |
+CCI |
+Champions' Interlace, 160x192, compressed |
+
+
+Atari 8-bit |
+CIN |
+Champions' Interlace, 160x192 |
+
+
+Atari 8-bit |
+CHG |
+Gephard Hires Graphics, up to 320x200, mono |
+
+
+Atari 8-bit |
+CPR |
+Trzmiel, 320x192, mono, compressed |
+
+
+Atari 8-bit |
+FNT |
+Standard 8x8 font, mono |
+
+
+Atari 8-bit |
+GR8 |
+Standard 320x192, mono |
+
+
+Atari 8-bit |
+GR9 |
+Standard 80x192, grayscale |
+
+
+Atari 8-bit |
+HIP |
+Hard Interlace Picture, 160x200, grayscale |
+
+
+Atari 8-bit |
+HR |
+Hires 256x239, three colors, interlaced |
+
+
+Atari 8-bit |
+HR2 |
+Hires 320x200, five colors, interlaced |
+
+
+Atari 8-bit |
+ILC |
+APAC 80x192, 256 colors interlaced |
+
+
+Atari 8-bit |
+INP |
+Interlace Picture 160x200, seven colors, interlaced |
+
+
+Atari 8-bit |
+INT |
+INT95a, up to 160x239, 16 colors, interlaced |
+
+
+Atari 8-bit |
+MCP |
+McPainter, 160x200, 16 colors, interlaced |
+
+
+Atari 8-bit |
+MIC |
+Micropainter 160x192, 4 colors |
+
+
+Atari 8-bit |
+PIC |
+Koala MicroIllustrator, 160x192, 4 colors, compressed |
+
+
+Atari 8-bit |
+PLM |
+Plama 256, 80x96, 256 colors |
+
+
+Atari 8-bit |
+RIP |
+Rocky Interlace Picture, up to 160x239 |
+
+
+Atari 8-bit |
+SXS |
+16x16 font, mono |
+
+
+Atari 8-bit |
+TIP |
+Taquart Interlace Picture, up to 160x119 |
+
+
+C64 |
+64C |
+Charset, mono or multi-color |
+
+
+C64 |
+SPR |
+Sprite, mono or multi-color |
+
+
+
+
+- Viewer for GIF/JPG/BMP/PNG images.
+- Available via context menu including multi-file-selection to open several files simultaneously.
TODO: This is no longer the case. This part of the documentation must be tested and updated.
+- The "Open With Graphics Editor" menu entry closes an existing editor in case the file is already opened, forcing the file to be opened with the graphics editor. In addition, the graphics editor is set as the default editor for this file. Consequently, double-clicking the file in the package explorer will open it automatically with the graphics editor, no matter which file type. This saves you from always using the context menu just because the file has no known file type. Using the "Open With" context menu entry, you can change the default editor again.
+- Available via hyperlink navigation for binary include statements.
+- Conversion from binary or 8-bit image files to GIF/JPG/BMP/PNG images.
+
+- Up to three source files, depending on the converter.
+- A configurable start offset for every source file helps extract character sets.
+- A configurable palette via the Image Palette view.
+- A configurable number of rows and columns.
+- Configurable spacing width and color to separate tiles and unused areas.
+- Separate aspect ratio for displaying and saving the image file.
+
+
+- Conversion from GIF/JPG/BMP/PNG images to binary files or 8-bit images using JavaScript.
+
+- Separate aspect ratio for loading and displaying the image file
+- Default scripts are included. They can be adjusted and saved along with the other parameters.
+
+
+- The image palette view associated with the graphics editor displays the palette entries and the color histogram. It supports filtering unused colors, sorting by index and color frequencies, pre-settings, and editing the palette when displaying 8-bit images.
+- Conversion files with the extension ".cnv" save the conversion direction and parameters.
+- Support for relative file paths. If the file path is in the same folder as the ".cnv" file, it is automatically converted to a relative file path when the file name is defaulted or picked from the file browser dialog. This allows us to move the ".cnv" and referenced source files together without breaking the saved paths.
+
+Preferences for Editing  » top
+The WUDSN IDE editor is configurable via language-specific preferences. They are available via the entry "Preferences" from the menu "Window" (under Windows and Linux) or the menu "Eclipse" (under macOS) and include the following.
+
+- Configuration of syntax highlighting colors and styles for comments, directives, all types of identifiers, legal opcodes, illegal opcodes, numbers, pseudo opcodes, and strings.
+- For non-unique identifiers, the syntax highlighting will try to be the best guess.
+- Configuration of default case in content assistance.
+
+Preferences for Building and Running  » top
+The build process of WUDSN IDE is configurable via language and assembler/compiler-specific preferences. They are available via the entry "Preferences" from the menu "Window" (under Windows and Linux) or the menu "Eclipse" (under macOS)
+
+- Download links, configurable paths, and default parameters are provided for all assemblers and compilers.
+- The path to the downloaded executable file can be configured in the language preferences once for all target platforms.
+- If no path is configured, WUDSN IDE will look for the executable file in the "Tools" folder of the installation.
+- The default file extension filter for selecting executable files is "*.exe" on Windows and "*.*" on all other operating systems.
+- The "Apply Defaults" button explicitly does not reset the paths to the executable files.
+- Building preferences can be maintained for all assemblers/compilers where an executable file is configured.
+- The active editor's language and assembler/compiler tabs are activated automatically upon opening the language preferences.
+- Via the "Target" option, you can activate the support for illegal opcodes of the 6502 CPU and 16-bit opcodes of the WDC 65816 CPU in syntax highlighting and content assistance.
The selection is offered only if the assembler supports the respective feature.
+- Build parameters can be specified per assembler/compiler. If no explicit values are specified, predefined defaults to run out-of-the-box are displayed and used.
+- Variables provide access to the project or file-specific paths in parameters:
+
+- {$sourceFolderPath}
The absolute path to the source folder.
+- {$sourceFilePath}
The absolute path to the source file.
+- {$outputFolderPath}
The absolute path to the output folder.
+- {$outputFilePath}
The absolute path to the output file.
+- {$outputFileName}
The name of the output file, including its extension, for example, "TestFile123.asm".
+- {$outputFileNameWithoutExtension}
The name of the output file without an extension, for example, "TestFile123".
+- {$outputFileNameShortWithoutExtension}
The name of the output file without extension is shortened to 8 alphanumeric characters, for example, "TESTFILE".
+
+Make sure that you don't remove parameters when you specify your values.
If not, creating the label definition file or parsing the compiler log may fail.
+
+- ATASM requires the "-s" parameter to be present".
+- MADS requires the "-p" parameter to be present.
+- ACME requires the "!to" directive in the source to be commented out to ensure the output file name from the command line is used.
+
+
+
+In addition, the application to run the outcome of the build process, typically an emulator, can be configured. Download links for every supported application are offered in the preferences.
+
+- The path to the downloaded application executable file can be configured in the language preferences once for all target platforms.
+- If no path is configured, WUDSN IDE will look for the executable file in the "Tools" folder of the installation.
+- The default file extension filter for selecting executable files is "*.exe" on Windows and "*.*" on all other operating systems.
+
+The preferences for the applications to run the result of the build process can be maintained for all assemblers/compilers in parallel. They include:
+
+- Selection of the application to run the outcome of the build process:
+
+- Use the "Operating System Default Application" of the platform.
For Windows and macOS, choosing the "Operating System Default Application" means that for the ".xex" file extension, the emulator will be started automatically without any further configuration.
+- Use one of the predefined applications and optionally change the command line.
+- Use a user-defined application to open the output file.
+
+
+- Run parameters per assembler/compiler and application can be specified. If no explicit values are specified, predefined defaults to run out-of-the-box are displayed and used.
+- Variables provide access to the project or file-specific paths in parameters:
+
+- {$runnerExecutablePath}
The absolute path to the executable of the application.
+- {$sourceFolderPath}
The absolute path to the source folder.
+- {$sourceFilePath}
The absolute path to the source file.
+- {$outputFolderPath}
The absolute path to the output folder.
+- {$outputFilePath}
The absolute path to the output file.
+- {$outputFileName}
The name of the output file, including its extension, for example, "TestFile123.asm".
+- {$outputFileNameWithoutExtension}
The name of the output file without an extension, for example, "TestFile123".
+- {$outputFileNameShortWithoutExtension}
The name of the output file without extension is shortened to 8 alphanumeric characters, for example, "TESTFILE".
TODO: Note that the images below are outdated and must be updated.
+
+
+
+Annotations for Building  » top
+
+- For most use cases, the defaults provided for the compilers and in the preferences are sufficient. But suppose you want to develop in parallel in multiple projects for different platforms (e.g., Apple II and Atari 8-bit) or various output formats (".XEX" and ".BIN") with the same assembler/compiler. In that case, changing the preferences every time may become cumbersome. Therefore, WUDSN IDE offers annotations to put into the source code files. These annotations override the defaults and the settings from the preferences.
+- All language annotations start with the prefix "@com.wudsn.ide.lng." followed by the lower-case name of the annotation, an equals sign, and the unquoted value. Example: "@com.wudsn.ide.lng.hardware=ATARI8BIT"
+- In earlier versions of WUDSN, language annotations started with the prefix "@com.wudsn.ide.asm.". While they are still evaluated, adapting to the new prefix is strongly recommended.
+- All annotations can be placed in comment lines at the beginning of a source file. Some annotations are only relevant for the main source file. Some are only relevant in include source files. Some are relevant for all source files.
+- @com.wudsn.ide.lng.hardware
+
+- Defines the target hardware for which the preferences shall be evaluated, mainly which emulator runs the output file.
+- Allowed values are "APPLE2", "ATARI2600", "ATARI7800", "ATARI8BIT", "C64", "NES".
+- This annotation is relevant for all source files.
+- This annotation is only evaluated when a file is opened. So, if you add this annotation or change its value, you must close and re-open the file once.
+- Example: @com.wudsn.ide.lng.hardware=ATARI8BIT
+
+
+- @com.wudsn.ide.lng.mainsourcefile
+
+- Defines the main source file to which the current source file belongs. When executing the "Compile" action, the primary source file is compiled instead of the active file.
+- Allowed values are file paths relative to the current folder, including source file and absolute file paths.
+- This annotation is only relevant in include source files.
+- Example: @com.wudsn.ide.lng.mainsourcefile=ExampleMain.asm
+
+
+- @com.wudsn.ide.lng.outputfoldermode
+
+- Overrides the "Output Folder Mode" from the preferences.
+- Allowed values are "SOURCE_FOLDER", "TEMP_FOLDER", and "FIXED_FOLDER".
+- This annotation is only relevant in the main source file.
+- Example: @com.wudsn.ide.lng.outputfoldermode=SOURCE_FOLDER
+
+
+- @com.wudsn.ide.lng.outputfolder
+
+- Overrides the "Output Folder" from the preferences and the "@com.wudsn.ide.lng.outputfoldermode" annotation.
+- Allowed values are file paths relative to the folder of the main source file and absolute file paths.
+- This annotation is only relevant in the main source file.
+- Example: @com.wudsn.ide.lng.outputfolder=..\out
+
+
+- @com.wudsn.ide.lng.outputfileextension
+
+- Overrides the "Output File Extension" from the preferences.
+- Allowed values have to start with a period.
+- This annotation is only relevant in the main source file.
+- Example: @com.wudsn.ide.lng.outputfileextension=.bin
+
+
+- @com.wudsn.ide.lng.outputfile
+
+- Overrides the "Output Folder" and "Output File Extension" values from the preferences and the automatic computation of the out file name based on the primary source file name.
+- Allowed values are file paths relative to the folder of the primary source file and absolute file paths.
+- This annotation is only relevant in the main source file.
+- Example: @com.wudsn.ide.lng.outputfile=..\out\output.bin
+
+
+
+Planned Features  » top
+
+- Planned features are listed as issues of category "enhancement" on GitHub. There, you can also request new features.
+- The table below shows the current core feature set that depends on the compiler.
Features not supported by the compiler itself and hence cannot be supported by the IDE are marked as "n/a".
+
+
+
+Compiler |
+Default Hardware |
+Auto-Completion Activation |
+Single-Line Comments |
+Block Comments |
+Strings |
+Opcodes |
+Directives |
+Compile Log Parsing |
+Content Outline |
+Label Definition File Format |
+
+
+ACME |
+C64 |
+Yes: ! |
+Yes: ;| |
+n/a |
+Yes: " |
+Yes |
+Partly |
+Yes |
+Partly |
+ACME |
+
+
+ATASM |
+Atari 8-bit |
+Yes: . |
+Yes: ; |
+n/a |
+Yes: " |
+Yes |
+Yes |
+Yes |
+Yes |
+XASM 3.0.1 |
+
+
+MADS |
+Atari 8-bit |
+Yes: . # |
+Yes: ; * // |
+Yes |
+Yes: ' " |
+Yes |
+Yes |
+Yes |
+Yes |
+MADS |
+
+
+XASM |
+Atari 8-bit |
+n/a |
+Yes: ; * | |
+n/a |
+Yes: ' " |
+Yes |
+Yes |
+Yes |
+Yes |
+XASM 3.0.1 |
+
+
+
+
+
+
+Known Bugs  » top
Open bugs:
- - If you find any, please report them on github
- or contact me directly
-
+- If you find any, please report them on GitHub or contact me directly
-Fixed bugs:
+Fixed bugs per release:
- - 1.7.2 and newer See github.
-
-
-
-
- 1.6.5
-
- - Automatic creation of ".DSK" disk images for Apple II now
- works correctly
- - The dirty indicator in Graphics Editor is now updated
- correctly
-
-
- - 1.6.4
-
-
- - 1.6.3
-
- - The first character of numbers is now correctly highlighted
- in #123
- - Source file includes via "INCSRC" are now correctly detected
- for ASM6
-
-
- - 1.6.2
-
- - Typing a "." to trigger the automatic content assist no
- longer locks-up
- - The default color for illegal opcodes changed to red as it
- was intended
- - German localization for the graphics editor is finally
- completed
- - Sorting of application in the preferences now is "Default,
- A...Z, User Defined" also in non-English localizations
-
-
- - 1.6.1
-
- - Clicking in the outline always positions the cursor
- correctly in the source, not only the first time
- - All names of content types are now translated correctly in
- the preferences
- - "Open Folder" command now also works for objects which are
- no resource or file themselves but can be adapted to one of these
- types. For example project explorer entries for Java classes
-
-
- - 1.6.0
-
- - Hyperlink navigation now also works for labels that contain
- an underscore
- - The key binding for the "Compile" menu is now "Shift-Ctrl-9"
- because it turned out that "Ctrl-0" is not available in all cases
- - The HexEditor is now also detecting the situation that the
- first block of a COM file is incorrect and display this correctly
- - Content assist has now correct new lines when inserting #IF,
- #WHILE and .TEST
- - Fonts and colors resources are disposed of correctly now
- - Resetting to default syntax colors in the preferences works
- now
- - Elements of .ENUM are recognized as equates now also if they
- do not start of position 0
- - Elements of .STRUCT are recognized as labels now also if
- they do not start of position 0
- - The cursor is now positioned to the first character of an
- equate or label also if it is not defined starting at position 0
- - The cursor is now positioned to the first character of an
- equate or label also if it is not defined starting at position 0
-
-
- - 1.5.0
-
- - Syntax highlighting remains active now also after "Save
- as..."
- - The cursor is now placed correctly by content assist
- - The key binding for the "Compile" menu is now "Ctrl-0"
- instead of "Ctrl-Alt-0", so entering "}" is now possible again
- - XASM editor now correctly detects the "ORG" directive
- - The assembler editor toolbar contribution now also displays
- the label "Assembler" in the customizing dialog for the perspective
-
-
- - 1.4.4
-
- - The directive ".LOCAL" in ATASM is a normal directive now
- and does not start a folding section while in MADS it is really is a
- folding section from ".LOCAL" to ".ENDL"
- - "SIN()" and "RND()" in MADS are now recognized correctly
- even if there are no spaces before or after the directive
- - ".EN" and ."END" in MADS are now recognized correctly
- - Labels in "ORG" lines are now recognized correctly and
- rendered as separate tree entries
- - Preferences for lower/upper case instructions in content
- assist are now also evaluated if for directives that do not start
- with letters like ".end"
- - When opening a file that is located outside of the
- workspace, the actions to open folders and to compile the file are
- now not doing anything and will not cause exceptions. They will also
- be disabled once the new Eclipse version is mandatory
- - The 16 bytes per row in the hex editor are now separated by
- a space
-
-
- - 1.4.3
-
- - The output file is not opened anymore in case it has been
- there before but was not updated by the compiler due to compiler
- errors
- - The scroll bar and cursor in the editor are now stable also
- in the cases when the outline is changed by the latest user input
- - The hex editor now gets the focus correctly also when
- clicking on already opened files
-
-
- - 1.4.2
-
- - The folder which contains the output file and the symbols
- file is refreshed automatically after compiling to ensure that the
- Eclipse resource cache is in sync with the file system
- - Line end comments are now used as a description for source
- and binary includes in the content outline
- - The "Open Folder" context menu entry works again, a bug was
- introduced in version 1.4.0
-
-
- - 1.4.0
-
- - The "Assembler" menu is visible now only if an Assembler
- editor is active. The contained entries and their short cuts are now
- disabled if no Assembler editor is active
- - The output file is not deleted anymore before the compiler
- is started, instead, it is only checked for being writeable. This
- allows for direct compilation into an existing ATR image
- - The name of the application used to open the output file is
- now included in the info message
-
-
- - 1.3.2
-
- - The content outline sometimes only found the first macro
- definition
- - Folding did not show up in all situations
- - Under Mac OS X, the file select dialog can now choose an
- "*.app" application-like "Atari800MacX.app" since this is a folder.
- The solution is a workaround to the general Eclipse problem under
- MacOS X, see BUG
- 82155
-
-
-
- - Before 1.3.2
-
- - The "OK" and "Apply" buttons in the preferences are now
- always enabled, irrespective of the specified compiler and emulator
- paths
- - The focus is not back in the editor window after compiling
- - The syntax highlighting of illegal opcodes fixed, now also
- uses the preferences setting
- - On German operating systems, the properties for the correct
- locale are now found
-
-
+-
+
+- 1.7.2 and newer can be found on GitHub.
+- 1.6.5
+
+- Automatic creation of ".DSK" disk images for Apple II works correctly.
+- The dirty indicator in Graphics Editor is now updated correctly.
-
- Planned features  » top
-
+
+- 1.6.4
+
+- 1.6.3
+
+- The first character of numbers is now correctly highlighted in "#123".
+- Source files included via "INCSRC" are now correctly detected for ASM6.
+
+
+- 1.6.2
+
+- Typing a "." to trigger the automatic content assistance no longer locks up.
+- The default color for illegal opcodes changed to red as it was intended.
+- German localization for the graphics editor is finally completed.
+- The sorting of applications in the preferences now is "Default, A...Z, User Defined" in non-English localizations.
+
+
+- 1.6.1
+
+- Clicking in the outline always positions the cursor correctly in the source, not only the first time.
+- All names of content types are now translated correctly in the preferences.
+- The "Open Folder" command now works for objects that can be adapted to resources or files - for example, project explorer entries for Java classes.
+
+
+- 1.6.0
+
+- Hyperlink navigation now works for labels containing an underscore.
+- The key binding for the "Compile" menu is now "Shift-Ctrl-9" because it turned out that "Ctrl-0" is not available in all cases.
+- The HexEditor also detects that the first block of a COM file is incorrect and displays this correctly.
+- Content assistance now correctly inserts new lines when inserting "#IF", "#WHILE", or ".TEST".
+- Fonts and color resources are disposed of correctly now.
+- Resetting to default syntax colors in the preferences works now.
+- Elements of ".ENUM" definitions are also recognized as equates if they do not start at position 0.
+- Elements of ".STRUCT" definitions are also recognized as labels if they do not start at position 0.
+- The cursor is now positioned to the first character of an equate or label if it is not defined starting at position 0.
+- The cursor is now positioned to the first character of an equate or label if it is not defined starting at position 0.
+
+
+- 1.5.0
+
+- Syntax highlighting remains active now also after "Save as...".
+- The cursor is now placed correctly by content assistance.
+- The key binding for the "Compile" menu is now "Ctrl-0" instead of "Ctrl-Alt-0", so entering "}" is now possible again.
+- XASM editor now correctly detects the "ORG" directive.
+- The assembler editor toolbar contribution now also displays the label "Assembler" in the customizing dialog for the perspective.
+
+
+- 1.4.4
+
+- The ".LOCAL" in ATASM does not start a folding section, while in MADS, it is a folding section from ".LOCAL" to ".ENDL".
+- "SIN()" and "RND()" in MADS are now recognized correctly, even if there are no spaces before or after the directive.
+- ".EN" and ."END" in MADS are now recognized correctly.
+- Labels in "ORG" lines are now recognized correctly and rendered as separate tree entries.
+- Preferences for lower-case/upper-case instructions in content assistance are now evaluated for directives that do not start with letters like ".end".
+- When opening a file from outside the workspace, the actions to open folders and compile the file do nothing and will not cause exceptions. They will also be disabled once the new Eclipse version is mandatory.
+- A space now separates the 16 bytes per row in the hex editor.
+
+
+- 1.4.3
+
+- The output file is not opened anymore in case it has been there before but was not updated by the compiler due to errors.
+- The editor's scroll bar and cursor are now stable when the latest user input changes the outline.
+- The hex editor gets the focus correctly when clicking on already-opened files.
+
+
+- 1.4.2
+
+- The folder containing the output and symbols files is refreshed automatically after compiling to ensure that the Eclipse resource cache is in sync with the file system.
+- Line end comments are now used as a description for source and binary include nodes in the content outline.
+- The "Open Folder" context menu entry works again. This fixes a bug introduced in version 1.4.0.
+
+
+- 1.4.0
+
+- The "Assembler" menu is only visible if an Assembler editor is active. The contained entries and shortcuts are now disabled if no Assembler editor is active.
+- The output file is not deleted before the compiler is started. Instead, it is only checked for being writeable. This allows for direct compilation into an existing ATR image.
+- The application name used to open the output file is now included in the info message.
+
+
+- 1.3.2
+
+- The content outline sometimes only finds the first macro definition.
+- Folding did not show up in all situations.
+- Under macOS, the file select dialog can now choose an "*.app" folder because apps like "Atari800MacX.app" are folders. The solution is a workaround to the general Eclipse problem under macOS. See BUG 82155.
+
+
+- Before 1.3.2
+
+- The "OK" and "Apply" buttons in the preferences are now always enabled, irrespective of the specified compiler and emulator paths.
+- The focus is not back in the editor window after compiling.
+- The syntax highlighting of illegal opcodes fixed now also uses the preferences setting.
+- The properties for the correct locale are now found on German operating systems.
+
+
+
+
\ No newline at end of file
diff --git a/com.wudsn.ide.lng/help/ide-installation.section.html b/com.wudsn.ide.lng/help/ide-installation.section.html
index 7600bd45..93b974b2 100644
--- a/com.wudsn.ide.lng/help/ide-installation.section.html
+++ b/com.wudsn.ide.lng/help/ide-installation.section.html
@@ -1,358 +1,157 @@
-
- The recommended way to install WUDSN IDE is the WUDSN IDE Installer. It
- is available for Windows 64-bit, macOS and Linux.
-
-If you use another operating system, want to use an older version
- of WUDSN, or wish to install assemblers, compilers, and emulators more
- selectively, read the descriptions of the installation steps below. In
- case something is not correct or not working, please get in touch with
- me.
+The recommended way to install WUDSN IDE is the WUDSN IDE Installer. It is available for Windows 64-bit, macOS and Linux.
+If you use another operating system, want to use an older version of WUDSN, or wish to install assemblers, compilers, and emulators more selectively, read the descriptions of the installation steps below. In case something is not correct or not working, please get in touch with me.
-
- Installing Eclipse  » top
-
+Installing Eclipse  » top
- - Download Eclipse from https://www.eclipse.org/downloads.
-
- - If you don't know which version to take, use Eclipse 4.12 Platform
- Runtime Binary (81 MB) for WUDSN IDE 1.7.1 and newer. Use Eclipse 4.3.2 Platform
- Runtime Binary (61 MB) for WUDSN IDE 1.7.0 and older.Â
This
- minimum-size installation does not include the Java
- Development Toolkit (JDT). WUDSN IDE does not depend on the JDT but
- on the Java Runtime Environment (JRE). Ensure you also have the 64-bit
- version of the JRE installed if you want to use the 64-bit version of
- Eclipse.
-
- - Unzip the downloaded archive file and store the " eclipse "
- folder where you want Eclipse to be located on your local hard drive.
- - Start the Eclipse executable from that folder.
- - Upon the first start, you are prompted to specify the folder
- where the workspace shall be located.
- - Normally, a start link is created to this end. You can use the
- parameter "-nl" to specify the locale. Use "en_US" for English or
- "de_DE" for German. Example: "C:\Program
- Files\Eclipse\4.12\eclipse\eclipse.exe" -Xmx512M -nl en_US"
- - Creating the workspace folder in your home directory is
- recommended.
- - After you have read the welcome page and got familiar with the
- Eclipse UI, switch to the Resource perspective.
- - Open the view "Problems" via the menu "Window/Show
- View/Problems" and then click the entry "Configure Contents..." from
- its view menu.
-
-
- - Select the configuration "All Errors", the radio button "On
- selected element and its children", and the checkboxes "Error",
- "Warning", and "Info".
-
-
- - Now Eclipse is ready, and you can proceed with Installing WUDSN IDE.
-
+- Download Eclipse from https://www.eclipse.org/downloads.
+- If you don't know which version to take, use Eclipse 4.12 Platform Runtime Binary (81 MB) for WUDSN IDE 1.7.1 and newer. Use Eclipse 4.3.2 Platform Runtime Binary (61 MB) for WUDSN IDE 1.7.0 and older.Â
This minimum-size installation does not include the Java Development Toolkit (JDT). WUDSN IDE does not depend on the JDT but on the Java Runtime Environment (JRE). Ensure you also have the 64-bit version of the JRE installed if you want to use the 64-bit version of Eclipse.
+- Unzip the downloaded archive file and store the " eclipse " folder where you want Eclipse to be located on your local hard drive.
+- Start the Eclipse executable from that folder.
+- Upon the first start, you are prompted to specify the folder where the workspace shall be located.
+- Normally, a start link is created to this end. You can use the parameter "-nl" to specify the locale. Use "en_US" for English or "de_DE" for German. Example: "C:\Program Files\Eclipse\4.12\eclipse\eclipse.exe" -Xmx512M -nl en_US"
+- Creating the workspace folder in your home directory is recommended.
+- After you have read the welcome page and got familiar with the Eclipse UI, switch to the Resource perspective.
+- Open the view "Problems" via the menu "Window/Show View/Problems" and then click the entry "Configure Contents..." from its view menu.
+- Select the configuration "All Errors", the radio button "On selected element and its children", and the checkboxes "Error", "Warning", and "Info".
+- Now Eclipse is ready, and you can proceed with Installing WUDSN IDE.
-
- Installing WUDSN IDE  » top
-
+Installing WUDSN IDE  » top
- - Start Eclipse
- - Select the entry "Install New Software..." from the menu
- "Help".
- - Enter "https://www.wudsn.com/update/stable" in the "Work with"
- field and press ENTER.
- - Select the latest version of the feature "WUDSN IDE" for in
- and press "Next".
You don't need to install the "General
- Eclipse Enhancements" feature as it is already included in the "WUDSN
- IDE" feature".
-
- - Review the installation details and press the button "Next".
- - Read the license agreement, choose "I accept..." and press the
- " Finish " button.
- - If you get a security warning that the content is unsigned,
- confirm the alert by pressing the " OK " button.
- - When prompted to restart Eclipse now, press the " Yes "
- button.
- - As always, with updates, the update may fail for whatever
- reason, or the installed version has severe issues. For example, the
- required Java version might not be available on your machine. In this
- case, uninstall it via the link "What is already installed" in the
- "Install New Software..." dialog and restart the IDE. Then, you can
- reinstall the latest version from
- "https://www.wudsn.com/update/stable" or previously released versions
- from the locations listed on the Releases page.
-
-
-
+- Start Eclipse
+- Select the entry "Install New Software..." from the menu "Help".
+- Enter "https://www.wudsn.com/update/stable" in the "Work with" field and press ENTER.
+- Select the latest version of the feature "WUDSN IDE" for in and press "Next".
You don't need to install the "General Eclipse Enhancements" feature as it is already included in the "WUDSN IDE" feature".
+- Review the installation details and press the button "Next".
+- Read the license agreement, choose "I accept..." and press the " Finish " button.
+- If you get a security warning that the content is unsigned, confirm the alert by pressing the " OK " button.
+- When prompted to restart Eclipse now, press the " Yes " button.
+- As always, with updates, the update may fail for whatever reason, or the installed version has severe issues. For example, the required Java version might not be available on your machine. In this case, uninstall it via the link "What is already installed" in the "Install New Software..." dialog and restart the IDE. Then, you can reinstall the latest version from "https://www.wudsn.com/update/stable" or previously released versions from the locations listed on the Releases page.
-
- Installing assemblers and compilers like ATASM, MADS, XASM...  » top
-
+Installing Assemblers and Compilers like ATASM, MADS, XASM...  » top
- - Start Eclipse
- - Select the entry "Preferences" from the menu "Window" (in
- Windows and Linux) or the menu "Eclipse" (in Mac OS X)
- - Open the preferences page "Languages/Assembler/Atari 8-bit
- Assemblers" or the respective page for your platform.
- - Select the tab for the assembler or compiler of your choice.
- The following assemblers and compilers are or will be supported:
-
-
-
- Language |
- Tool |
- Default Target Platform |
-
-
- Assembler |
- ACME |
- C64 |
-
-
- Assembler |
- ASM6 |
- NES |
-
-
- Assembler |
- ATASM |
- Atari 8-bit |
-
-
- Assembler |
- DASM |
- Atari 2600 |
-
-
- Assembler |
- KickAss |
- C64 |
-
-
- Assembler |
- MADS |
- Atari 8-bit |
-
-
- Assembler |
- XASM |
- Atari 8-bit |
-
-
- Assembler |
- TASS |
- C64 (in preparation) |
-
-
- Pascal |
- MadPascal |
- Atari 8-bit |
-
-
-
-
- - There are three ways to download the assemblers/compilers:
-
-
- - Follow the instructions on the download site to install the
- assembler/compiler in the folder of your choice.
- - In the section "Browse..." button for the field "Path to
- Compiler" to locate the executable.
- - The default parameters are used if no explicit
- assembler/compiler parameters are specified.
- - The default parameters are ignored if explicit
- assembler/compiler parameters are specified.
- - The absolute path to the source file replaces the variable
- "${sourceFilePath}".
The absolute path to the output file
- replaces the variable "${outputFilePath}".
For more variables,
- see the "Preferences for assembling and compiling" section on the
- "Features" page.
-
- - Choose if you want to use the source or temporary folders as
- the output folder.
- - Choose the file extension for the output file, for example,
- ".xex" or ".bin".
- - Press the button "OK".
- - All values are reset using the "Restore Defaults" button,
- except for the paths to the assembler/compilers.
-
-
-
- - Using the button "Default" in the "File Associations"
- preferences, you can set the default editor for a file extension, for
- example, "MADS" for "*.asm".
-
-
+- Start Eclipse
+- Select the entry "Preferences" from the menu "Window" (in Windows and Linux) or the menu "Eclipse" (in Mac OS X)
+- Open the preferences page "Languages/Assembler/Atari 8-bit Assemblers" or the respective page for your platform.
+- Select the tab for the assembler or compiler of your choice. The following assemblers and compilers are or will be supported:
+
+
+
+Language |
+Tool |
+Default Target Platform |
+
+
+Assembler |
+ACME |
+C64 |
+
+
+Assembler |
+ASM6 |
+NES |
+
+
+Assembler |
+ATASM |
+Atari 8-bit |
+
+
+Assembler |
+DASM |
+Atari 2600 |
+
+
+Assembler |
+KickAss |
+C64 |
+
+
+Assembler |
+MADS |
+Atari 8-bit |
+
+
+Assembler |
+XASM |
+Atari 8-bit |
+
+
+Assembler |
+TASS |
+C64 (in preparation) |
+
+
+Pascal |
+MadPascal |
+Atari 8-bit |
+
+
+
+
+- There are three ways to download the assemblers/compilers:
+
-
- Installing Altirra, Atari800, and other emulators  » top
-
-
- - Start Eclipse.
- - Select the entry "Preferences" from the menu "Window" (for
- Windows and Linux) or "Eclipse" (for Mac OS X).
- - Open the preferences page "Languages/Assembler/Atari 8-bit
- Assemblers" and select the tab for your assembler.
- - The field "Default Application to open Output File" is
- defaulted to "Operating System Default Application".
-
- - Suppose you have the emulator registered as the default
- application for the extension of the output file, for example,
- "Altirra", "Atari800," or "Atari800MacX" for ".xex". In that case,
- you don't need to configure anything in addition and can skip the
- steps below.
- - If your operating system, like, for example, Linux, does not
- support default applications or if you need a particular output file
- extension and particular parameters to open the output file in the
- emulator, you can choose the emulator in the field "Application to
- open Output File" and configure the command line on the
- corresponding tab.
- - You can also use the "User Defined Application" to open the
- output file with an arbitrary application like a script, linker, or
- whatever.
-
-
- - Suppose you have not yet downloaded the corresponding
- emulator. In that case, you can use the download link on the tab of
- the emulator and follow the instructions on the download site to
- install the emulator.
- - Use the "Browse..." button for the "Path to Application" field
- to locate the executable. Specify your command line based on the
- default command line displayed.
Note: Under Mac OS-X, you must
- specify the path to the actual executable inside the ".app" folder. To
- see this path, select "Show Package Contents" in the context menu of
- the ".app" folder. For the "Stella" emulator installed in the
- "/Applications/Stella.app" folder, this means
- "/Applications/Stella.app/Contents/MacOS/Stella".
-
- - The default command line is used if no explicit command line
- is specified.
- - If an explicit command line is specified, the default command
- line is ignored.
- - The variable "${runnerExecutablePath}" is replaced by the path
- to the application executable.
The absolute path to the output
- file replaces the variable "${outputFilePath}".
For more
- variables, see the "Preferences for assembling and compiling" section
- on the "Features" page.
-
- - Press the button "OK".
- - If you also need the Atari ROM files, you can find them in the
- file PCXF380.ZIP, which is
- available at http://www.emulators.com.
-
-
+
+- Follow the instructions on the download site to install the assembler/compiler in the folder of your choice.
+- In the section "Browse..." button for the field "Path to Compiler" to locate the executable.
+- The default parameters are used if no explicit assembler/compiler parameters are specified.
+- The default parameters are ignored if explicit assembler/compiler parameters are specified.
+- The absolute path to the source file replaces the variable "${sourceFilePath}".
The absolute path to the output file replaces the variable "${outputFilePath}".
For more variables, see the "Preferences for assembling and compiling" section on the "Features" page.
+- Choose to use the source or temporary folders as the output folder.
+- Choose the file extension for the output file, for example, ".xex" or ".bin".
+- Press the button "OK".
+- All values are reset using the "Restore Defaults" button, except for the paths to the assembler/compilers.
+- Using the button "Default" in the "File Associations" preferences, you can set the default editor for a file extension, for example, "MADS" for "*.asm".
-
- Creating and compiling an example project  »
- top
-
+Installing Altirra, Atari800, and other emulators  » top
+Creating and Building the Example project  » top
- - The source code files contain the equates for hardware
- registers and operating systems for Atari 8-bit and Atari VCS in MADS format.
-
- - Atari Graphics & Arcade Game Design,
- DeRe Atari, and Mapping the Atari at AtariArchives.org
- - AtariAge forum for Atari 5200 / 8-bit
- Programming
+- Start Eclipse.
+- Select the entry "New/Project" from the menu "File".
+- Select the wizard "General/Project" and press the button "Next".
+- Enter the project name "Atari800" and press "Finish".
+- The new project will appear in the "Project Explorer".
+- Select the newly created project and open its context menu.
+- Select the entry "New/File", enter the file name "Example.asm", and press the button "Finish".
+- The new empty file will now be opened in the MADS editor.
+- Copy the following source text and paste it into the file:
; WUDSN IDE Atari Rainbow Example - MADS syntax
      org $4000 ;Start of code
start lda #0 ;Disable screen DMA
      sta 559
loop  lda $d40b ;Load VCOUNT
     clc
      adc 20 ;Add counter
      sta $d40a
      sta $d01a ;Change background color
      jmp loop
      run start ;Define run address
+- Select the entry "Build and run" from the menu "Language" or press "SHIFT-CTRL-9".
+- Enjoy your famous first rainbow effect.
+- In case of problems, open the view "Problems" and the output of the "Console" view for details and post a message with the screenshots in the English AtariAge forum if you get stuck:
+
+
+
\ No newline at end of file
diff --git a/com.wudsn.ide.lng/help/ide-releases.section.html b/com.wudsn.ide.lng/help/ide-releases.section.html
index 9ab20353..8a4a18e0 100644
--- a/com.wudsn.ide.lng/help/ide-releases.section.html
+++ b/com.wudsn.ide.lng/help/ide-releases.section.html
@@ -1,275 +1,200 @@
-
- The following table lists all releases of WUDSN IDE, the required
- minimum Java
- and Eclipse
- versions, the link to the release news article, and the release news
- video. The latest stable version is always available via the update
- site "https://www.wudsn.com/update/stable". The daily and older
- versions are available via version-specific update sites listed below.
-
+The following table lists all releases of WUDSN IDE, the required minimum Java and Eclipse versions, the link to the release news article, and the release news video. The latest stable version is always available via the update site "https://www.wudsn.com/update/stable". The daily and older versions are available via version-specific update sites listed below.
-
-
- WUDSN IDE Version |
- Release Date |
- Minimum Java Version |
- Minimum Eclipse Version |
- Update Site URL |
- Release News Article |
- Release News Video |
-
-
- daily |
- updated permanently |
- Java 11 |
- 4.19 |
- https://www.wudsn.com/update/daily |
- read |
- n/a |
-
-
- 1.7.2 (stable) |
- 2021-04-01 |
- Java 11 |
- 4.19 |
- https://www.wudsn.com/update/stable |
- read |
- Planned |
-
-
- 1.7.1 |
- 2020-10-18 |
- Java 1.8 |
- 4.10 |
- https://www.wudsn.com/update/1.7.1 |
- read |
- Planned |
-
-
- 1.7.0 |
- 2019-01-01 |
- Java 1.6 |
- 4.3.1 |
- https://www.wudsn.com/update/1.7.0 |
- read |
- watch |
-
-
- 1.6.6 |
- 2014-06-11 |
- Java 1.6 |
- 4.3.1 |
- https://www.wudsn.com/update/1.6.6 |
- read |
- watch |
-
-
- 1.6.5 |
- 2014-01-02 |
- Java 1.7 |
- 4.3.1 |
- https://www.wudsn.com/update/1.6.5 |
- read |
- watch |
-
-
- 1.6.4 |
- 2013-09-13 |
- Java 1.6 |
- 3.6.0 |
- https://www.wudsn.com/update/1.6.4 |
- read |
- watch |
-
-
- 1.6.3 |
- 2012-06-09 |
- Java 1.6 |
- 3.6.0 |
- https://www.wudsn.com/update/1.6.3 |
- read |
- watch |
-
-
- 1.6.2 |
- 2012-05-16 |
- Java 1.6 |
- 3.6.0 |
- https://www.wudsn.com/update/1.6.2 |
- read |
- watch |
-
-
- 1.6.1 |
- 2012-05-12 |
- Java 1.6 |
- 3.6.0 |
- not available |
- read |
- watch |
-
-
- 1.6.0 |
- 2011-04-02 |
- Java 1.5 |
- 3.6.0 |
- https://www.wudsn.com/update/1.6.0 |
- read |
- watch |
-
-
- 1.5.0 |
- 2010-10-27 |
- Java 1.5 |
- 3.6.0 |
- not available |
- read |
- not available |
-
-
- 1.4.4 |
- 2010-09-01 |
- Java 1.5 |
- 3.3.0 |
- not available |
- read |
- not available |
-
-
- 1.4.3 |
- 2010-04-28 |
- Java 1.5 |
- 3.3.0 |
- not available |
- read |
- not available |
-
-
- 1.4.2 |
- 2009-10-11 |
- Java 1.5 |
- 3.3.0 |
- not available |
- read |
- not available |
-
-
- 1.4.0 |
- 2009-09-13 |
- Java 1.5 |
- 3.3.0 |
- not available |
- read |
- not available |
-
-
- 1.3.2 |
- 2009-07-26 |
- Java 1.5 |
- 3.3.0 |
- not available |
- read |
- not available |
-
-
- 1.2.0 |
- 2009-07-12 |
- Java 1.5 |
- 3.3.0 |
- not available |
- read |
- not available |
-
-
- 1.1.0 |
- 2009-06-28 |
- Java 1.5 |
- 3.3.0 |
- not available |
- read |
- not available |
-
-
- 1.0.0 |
- 2009-06-08 |
- Java 1.5 |
- 3.3.0 |
- not available |
- read |
- not available |
-
-
+
+
+WUDSN IDE Version |
+Release Date |
+Minimum Java Version |
+Minimum Eclipse Version |
+Update Site URL |
+Release News Article |
+Release News Video |
+
+
+daily |
+updated permanently |
+Java 11 |
+4.19 |
+https://www.wudsn.com/update/daily |
+read |
+n/a |
+
+
+1.7.2 (stable) |
+2021-04-01 |
+Java 11 |
+4.19 |
+https://www.wudsn.com/update/stable |
+read |
+planned |
+
+
+1.7.1 |
+2020-10-18 |
+Java 1.8 |
+4.10 |
+https://www.wudsn.com/update/1.7.1 |
+read |
+planned |
+
+
+1.7.0 |
+2019-01-01 |
+Java 1.6 |
+4.3.1 |
+https://www.wudsn.com/update/1.7.0 |
+read |
+watch |
+
+
+1.6.6 |
+2014-06-11 |
+Java 1.6 |
+4.3.1 |
+https://www.wudsn.com/update/1.6.6 |
+read |
+watch |
+
+
+1.6.5 |
+2014-01-02 |
+Java 1.7 |
+4.3.1 |
+https://www.wudsn.com/update/1.6.5 |
+read |
+watch |
+
+
+1.6.4 |
+2013-09-13 |
+Java 1.6 |
+3.6.0 |
+https://www.wudsn.com/update/1.6.4 |
+read |
+watch |
+
+
+1.6.3 |
+2012-06-09 |
+Java 1.6 |
+3.6.0 |
+https://www.wudsn.com/update/1.6.3 |
+read |
+watch |
+
+
+1.6.2 |
+2012-05-16 |
+Java 1.6 |
+3.6.0 |
+https://www.wudsn.com/update/1.6.2 |
+read |
+watch |
+
+
+1.6.1 |
+2012-05-12 |
+Java 1.6 |
+3.6.0 |
+not available |
+read |
+watch |
+
+
+1.6.0 |
+2011-04-02 |
+Java 1.5 |
+3.6.0 |
+https://www.wudsn.com/update/1.6.0 |
+read |
+watch |
+
+
+1.5.0 |
+2010-10-27 |
+Java 1.5 |
+3.6.0 |
+not available |
+read |
+not available |
+
+
+1.4.4 |
+2010-09-01 |
+Java 1.5 |
+3.3.0 |
+not available |
+read |
+not available |
+
+
+1.4.3 |
+2010-04-28 |
+Java 1.5 |
+3.3.0 |
+not available |
+read |
+not available |
+
+
+1.4.2 |
+2009-10-11 |
+Java 1.5 |
+3.3.0 |
+not available |
+read |
+not available |
+
+
+1.4.0 |
+2009-09-13 |
+Java 1.5 |
+3.3.0 |
+not available |
+read |
+not available |
+
+
+1.3.2 |
+2009-07-26 |
+Java 1.5 |
+3.3.0 |
+not available |
+read |
+not available |
+
+
+1.2.0 |
+2009-07-12 |
+Java 1.5 |
+3.3.0 |
+not available |
+read |
+not available |
+
+
+1.1.0 |
+2009-06-28 |
+Java 1.5 |
+3.3.0 |
+not available |
+read |
+not available |
+
+
+1.0.0 |
+2009-06-08 |
+Java 1.5 |
+3.3.0 |
+not available |
+read |
+not available |
+
+
-Before version 1.7.2, so-called "zero installation distributions"
- were provided for Windows. They contain the Eclipse Platform, the Java
- Runtime Environment, the latest stable version of the WUDSN IDE plugin,
- all supported compilers, and an emulator for each platform. All paths
- to folders, compilers, and emulators are pre-configured. Unpack the
- content of this archive to the directory "C:\jac\wudsn" and click the
- "WUDSN IDE-64 bit" link. Eclipse will open with the predefined
- workspace that contains "Hello World" examples for different platforms.
+Before version 1.7.2, so-called "zero installation distributions" were provided for Windows. They contain the Eclipse Platform, the Java Runtime Environment, the latest stable version of the WUDSN IDE plugin, all supported compilers, and an emulator for each platform. All paths to folders, compilers, and emulators are pre-configured. Unpack the content of this archive to the directory "C:\jac\wudsn" and click the "WUDSN IDE-64 bit" link. Eclipse will open with the predefined workspace that contains "Hello World" examples for different platforms.
\ No newline at end of file
diff --git a/com.wudsn.ide.lng/help/ide-tutorials-videos.html b/com.wudsn.ide.lng/help/ide-tutorials-videos.html
index d773550d..11030042 100644
--- a/com.wudsn.ide.lng/help/ide-tutorials-videos.html
+++ b/com.wudsn.ide.lng/help/ide-tutorials-videos.html
@@ -19,7 +19,7 @@
line = line +' '
line = line +' '
line = line +' '
- line = line +'