6502
/
wudsn-ide
mirror of https://github.com/peterdell/wudsn-ide.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update documentation for "WUDSN_LANGUAGE".

This commit is contained in:
Peter Dell 2023-08-30 20:43:50 +02:00
parent 33b726f793
commit 6472440284
3 changed files with 19 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
com.wudsn.ide.lng/help/ide-faq.section.html
View File

@ -11,6 +11,7 @@
<li><a href="#FAQWUDSNInstallationUpdateSiteRequiredItems">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?</a></li>
<li><a href="#FAQEclipseUserGuide">How do I use Eclipse?</a></li>
<li><a href="#FAQWUDSNInstallationPreferencesNotVisible">Why is the "Assembler" section not visible in the preferences?</a></li>
<li><a href="#FAQWUDSNSelectTranslation">How do I select the translation for the menus and messages?</a></li>
</ul>
</li>
<li><a href="#Configuration">Configuration</a>
@ -86,6 +87,10 @@
<h4>Why is the "Assembler" section not visible in the preferences?</h4>
<p>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 <a href="http://www.oracle.com/technetwork/java/eol-135779.html" target="_blank" rel="noopener noreferrer">out of maintenance since 2013/02</a>. 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.</p>
</div>
<div id="FAQWUDSNSelectTranslation">
<h4>How do I select the translation for the menus and messages?</h4>
<p>The WUDSN IDE installer installs English and German translations for Eclipse and WUDSN IDE by default. When you start WUDSN IDE, the translation for the primary language of your operating system is used. Use can override this selection by setting the environment variable "WUDSN_LANGUAGE" to "en" "de".</p>
</div>
<h3 id="Configuration">Configuration</h3>
<div id="FAQProblemsView">
<h4>Why do I see wrong messages in the "Problems" view?</h4>
@ -99,7 +104,6 @@
<h4>Why must I put ";@com.wudsn.ide.lng.hardware=..." in the source file?</h4>
<p>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.</p>
</div>
<h3 id="Editing">Editing</h3>
<div id="FAQEclipseSpeed">
<h4>Why is editing sometimes slow, or is everything blocked, showing the wait cursor?</h4>
@ -149,7 +153,7 @@
<h3 id="Building">Building</h3>
<div id="FAQPrimaryAssembler">
<h4>Why is MADS the primary assembler?</h4>
<p>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.</p>
<p>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 potent 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.</p>
</div>
<div id="FAQPrimaryAssemblerExample">
<h4>Why do I get the error "No ORG defined" when compiling the example from the tutorial?</h4>
@ -214,5 +218,4 @@
<div id="FAQOtherEmulators">
<h4>How can I use other emulators?</h4>
<p>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.</p>
</div>
</div>

1
com.wudsn.ide.lng/help/ide-features.section.html
View File

@ -15,6 +15,7 @@
</ul>
<h5 id="IDE">General IDE Enhancements</h5>
<ul>
<li>The environment variable "WUDSN_LANGUAGE" can be set to "en" or "de" to override the default locale of the IDE used for all menu and message texts.</li>
<li>The "Open Folder" context menu is available for all folders and files.</li>
<li>The "Sort" context menu with sub-menu is available for all text files, including <br />
<ul>

15
com.wudsn.ide.lng/help/ide-installation.section.html
View File

@ -24,6 +24,7 @@
</ul>
<h5 id="InstallingWUDSNIDE">Installing WUDSN IDE</h5>
<ul>
<ul>
<li>Start Eclipse</li>
<li>Select the entry "Install New Software..." from the menu "Help".</li>
<li>Enter "https://www.wudsn.com/update/stable" in the "Work with" field and press ENTER.</li>
@ -32,8 +33,14 @@
<li>Read the license agreement, choose "I accept..." and press the " Finish " button.</li>
<li>If you get a security warning that the content is unsigned, confirm the alert by pressing the " OK " button.</li>
<li>When prompted to restart Eclipse now, press the " Yes " button.</li>
<li>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 <a href="https://www.wudsn.com/index.php/ide/releases">Releases</a> page. <br /><img src="productions/java/ide/installation/ide-installation-steps.gif" alt="IDE installation steps" /></li>
<li>Updates 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 <a href="https://www.wudsn.com/index.php/ide/releases">Releases</a> page. <br /><img src="productions/java/ide/installation/ide-installation-steps.gif" alt="IDE installation steps" /></li>
</ul>
</ul>
<h5 id="InstallingAssemblersAndCompilers">Installing Language Packs</h5>
<ul>
<ul>The Eclipse runtime is, by default, installed with the English language pack. Additional language packs can be downloaded from</ul>
</ul>
<p><a target="_blank&gt;">. The WUDSN IDE plugin contains English and German translations. The WUDSN IDE installer automatically installs the German Language Pack for Eclipse. This way, English and German translations are always complete in an installation.</a></p>
<h5 id="InstallingAssemblersAndCompilers">Installing Assemblers and Compilers like ATASM, MADS, XASM...</h5>
<ul>
<li>Start Eclipse</li>
@ -107,10 +114,10 @@
<li>The default parameters are used if no explicit assembler/compiler parameters are specified.</li>
<li>The default parameters are ignored if explicit assembler/compiler parameters are specified.</li>
<li>The absolute path to the source file replaces the variable "${sourceFilePath}". <br />The absolute path to the output file replaces the variable "${outputFilePath}". <br />For more variables, see the "Preferences for assembling and compiling" section on the "Features" page.</li>
<li>Choose to use the source or temporary folders as the output folder.</li>
<li>Choose the source or temporary folders as the output folder.</li>
<li>Choose the file extension for the output file, for example, ".xex" or ".bin".</li>
<li>Press the button "OK".</li>
<li>All values are reset using the "Restore Defaults" button, except for the paths to the assembler/compilers. <br /><br /><img src="productions/java/ide/features/ide-assembler-preferences-compilers.gif" alt="Configuration of aseembler / compiler executable path" /></li>
<li>All values are reset using the "Restore Defaults" button, except for the paths to the assembler/compilers. <br /><br /><img src="productions/java/ide/features/ide-assembler-preferences-compilers.gif" alt="Configuration of assembler / compiler executable path" /></li>
<li>Using the button "Default" in the "File Associations" preferences, you can set the default editor for a file extension, for example, "MADS" for "*.asm". <br /><img src="productions/java/ide/features/ide-editor-file-associations.gif" alt="IDE file associations" /></li>
</ul>
<h5 id="InstallingEmulators">Installing Altirra, Atari800, and other emulators</h5>
@ -133,7 +140,7 @@
<li>Press the button "OK".</li>
<li>If you also need the Atari ROM files, you can find them in the file <a href="http://www.emulators.com/freefile/pcxf380.zip" target="_blank" rel="noopener noreferrer">PCXF380.ZIP</a>, which is available at <a href="http://www.emulators.com/download.htm" target="_blank" rel="noopener noreferrer">http://www.emulators.com</a>.<img src="productions/java/ide/features/ide-assembler-preferences-compilers.gif" alt="Configuration of emulator executable path" /></li>
</ul>
<h5 id="CreatingExampleProject">Creating and Building the Example project</h5>
<h5 id="CreatingExampleProject">Creating and Building the Example Project</h5>
<ul>
<li>Start Eclipse.</li>
<li>Select the entry "New/Project" from the menu "File".</li>