eclipse plugin: Update the internal help of the plugin
This commit is contained in:
Timotei Dolean
parent
3d9ff78df6
commit
6077df7010
26 changed files with 149 additions and 132 deletions
|
|
@ -1,6 +1,6 @@
|
|||
<contexts>
|
||||
<context id="wizardHelp">
|
||||
<description>Help about new Wesnoth Wizards</description>
|
||||
<context id="wizardHelp" title="Wesnoth Wizards">
|
||||
<description>Help about wesnoth wizards</description>
|
||||
<topic label="Empty Wizard" href="help/html/gettingstarted/wizards/empty.html"/>
|
||||
<topic label="Campaign Wizard" href="help/html/gettingstarted/wizards/campaign.html"/>
|
||||
<topic label="Scenario Wizard" href="help/html/gettingstarted/wizards/scenario.html"/>
|
||||
|
|
|
|||
|
|
@ -7,7 +7,14 @@
|
|||
</head>
|
||||
|
||||
<body>
|
||||
<h1>Feature for the plugin</h1>
|
||||
- eclipse related features
|
||||
<h1>The plugin has the following list of abilities (not exhaustive):</h1>
|
||||
<ul>
|
||||
<li>Easily creation of UMC Addons</li>
|
||||
<li>Quick "Writing" of WML code by using WML Wizards, by focusing on the content</li>
|
||||
<li>Integrated launch of the Game or Map Editor</li>
|
||||
<li>Integrated launch of the WML tools on individual projects / files</li>
|
||||
<li>Support for multiple Wesnoth versions</li>
|
||||
<li>Integrated powerful WML Editor with autocomplete, go to macro definition, etc</li>
|
||||
</ul>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -7,7 +7,26 @@
|
|||
</head>
|
||||
|
||||
<body>
|
||||
<h1>Features for the WML Editor</h1>
|
||||
|
||||
<h1>Features of the WML Editor</h1>
|
||||
The plugin contains a full edged WML Editor. It recognizes the .cfg files and opens them
|
||||
in the WML Editor by default. The Editor supports UTF-8 files not just ASCII ones. The
|
||||
editor is one of the most important features of the plugin.
|
||||
<h2>Content assist</h2>
|
||||
At any time, when writing WML Code, one could activate the content assist by the CTRL
|
||||
+ SPACE shortcut. A small inline popup will open showing suggestions on what to complete.
|
||||
Currently the plugin can auto complete:
|
||||
<ul>
|
||||
<li>Scenario ids</li>
|
||||
<li>WML Tags</li>
|
||||
<li>WML Keys</li>
|
||||
<li>WML Macros</li>
|
||||
Each item has a little icon to help the user distinguish between suggestions types.
|
||||
</ul>
|
||||
|
||||
<h2>WML macros</h2>
|
||||
One can view the definition of a WML macro, by hovering / going with the caret over the
|
||||
call, and pressing F2. A small popup will open showing the macros' definition.
|
||||
Alternatively, Pressing F3, will open the macro's definition file, so you can modify
|
||||
it or inspect related macros.
|
||||
</body>
|
||||
</html>
|
||||
</html>
|
||||
|
|
|
|||
|
|
@ -3,10 +3,15 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
||||
<title>Config files - Contenxt menus</title>
|
||||
<title>Config files - Context menus</title>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1>Menus on config files (*.cfg)</h1>
|
||||
<h1>Menus on config files (*.cfg) - right click on any .cfg file</h1>
|
||||
<ul>
|
||||
<li>Open scenario in game - opens the selected file's scenario (if it contains one) in wesnoth.</li>
|
||||
<li>WML Tools - provides some options for using the wmltools with the specified file. (e.g. run wmllint against the file and see the output in the console)</li>
|
||||
<li>Preprocessor - provides ways of preprocessing and showing the result in an editor inside eclipse.</li>
|
||||
</ul>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
||||
<title>Containers - Context Menus</title>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1>Menus on Containers - right click on any container</h1>
|
||||
<ul>
|
||||
<li>WML Tools - provides some options for using the wmltools with the specified project.</li>
|
||||
</ul>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,12 +0,0 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
||||
<title>Folders - Context Menus</title>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1>Menus on folders</h1>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -3,10 +3,19 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
||||
<title>Map - Context menus</title>
|
||||
<title>Maps files and directories - Context menus</title>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1>Menus on map files (*.map)</h1>
|
||||
<h1>Menus on map files (*.map) - right click on .map files</h1>
|
||||
<ul>
|
||||
<li>Open map in editor - will open the selected map in the wesnoth map editor.</li>
|
||||
</ul>
|
||||
<br/>
|
||||
|
||||
<h1>Menus on "maps" directory - right click on the "maps" directory </h1>
|
||||
<ul>
|
||||
<li>Import map - Shows a file selection window that will ley you select a .map file that will be copied in your maps directory.</li>
|
||||
</ul>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -3,10 +3,18 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
||||
<title>Project - Contentx menus</title>
|
||||
<title>Project - Context menus</title>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1>Menus on projects</h1>
|
||||
<h1>Menus on projects - right click on the projects created with the plugin</h1>
|
||||
<ul>
|
||||
<li>Wesnoth project report - will show a simple report with the numer of maps, scenarios and units.</li>
|
||||
<li>Open campaign in game - will start the current project's campaign (if any) in wesnoth.
|
||||
For this to work, you must have a "main.cfg" file defined, and a campaign in it.</li>
|
||||
<li>Upload addon - will upload the specified directory on the wesnoth addon server. The status will be outputed to the console.</li>
|
||||
<li>Regenerate build files - recreates the "build.xml" file. That is used if the current project is one relative to useraddons</li>
|
||||
<li>Builders - utilities for adding/removing the wesnoth/xtext builders. Don't use them until you know what you are doing.</li>
|
||||
</ul>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -3,11 +3,21 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
||||
<title>Sub Topic</title>
|
||||
<title>Main Menu</title>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1>Sub Topic</h1>
|
||||
Please enter your text here.
|
||||
<h1>Main menu</h1>
|
||||
<ul>
|
||||
<li>Main menu - This is a menu near the "Window" menu bar</li>
|
||||
<li>Open editor - Will open the game editor with a blank map.</li>
|
||||
<li>Open game - Will open the game.</li>
|
||||
<li>Import map - It will import a map in selected container.</li>
|
||||
<li>Open editor - Open the selected map in the game editor.</li>
|
||||
<li>Setup workspace - Will setup the workspace if it's not setup. This will open the preferences page if any preferences is</li>
|
||||
<li>missing, and then it will create the wesnoth project for mainline and user addons directories if you want.</li>
|
||||
<li>Reload cache - Reloads the internal cached files. Useful when the schema or other files have modified and you don't want to restart the plugin.</li>
|
||||
<li>Open plugin's preferences - Opens the plugin preferences page.</li>
|
||||
</ul>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -7,7 +7,15 @@
|
|||
</head>
|
||||
|
||||
<body>
|
||||
<h1>Setup eclipse workspace</h1>
|
||||
|
||||
<h1>Setup eclipse workspace</h1>
|
||||
After you have started the plugin, you can use its features.<br/>
|
||||
But before of all, you must setup your environment, so it knows where your wesnoth game is located. By default, after
|
||||
you have launched the plugin for the first time, you will be greeted with a small assistant that will help you "setup the
|
||||
workspace". The preferences page for the plugin will pop up and you must fill all fields, so the plugin will work as intended.
|
||||
After you completed the fields, press OK. Then the plugin will create for convenience (i.e. if you want) wesnoth projects for
|
||||
each of mainline campaigns and for each directory in your <b>useraddons/data/add-ons</b> directory. The working directory is the
|
||||
directory that contains the data, images, manual, sounds directories of Wesnoth.
|
||||
<br/><br/>
|
||||
If there were no errors a message window will open saying: <b>Workspace was setup successfully</b>.
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -7,7 +7,12 @@
|
|||
</head>
|
||||
|
||||
<body>
|
||||
<h1>Campaign</h1>
|
||||
|
||||
<h1>Campaign</h1>
|
||||
Creates a new Campaign Wesnoth Project in the workspace. The campaign has the
|
||||
same semantics as a [campaign] tag, including a normal's addon directories structure.<br/><br/>
|
||||
|
||||
For more information see: <a href="http://wiki.wesnoth.org/BuildingCampaigns">http://wiki.wesnoth.org/BuildingCampaigns</a>,
|
||||
<a href="http://wiki.wesnoth.org/CampaignWML">http://wiki.wesnoth.org/CampaignWML</a>.
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -7,7 +7,12 @@
|
|||
</head>
|
||||
|
||||
<body>
|
||||
<h1>Empty project</h1>
|
||||
|
||||
<h1>Empty project</h1>
|
||||
This wizard creates a new Wesnoth project in the workspace, with no files. <br/>
|
||||
However, if the project is created on an existing directory, all existing files will become
|
||||
part of the new project. It also creates a basic addon directory structure.<br/><br/>
|
||||
|
||||
For more information see: <a href="http://wiki.wesnoth.org/BuildingCampaignsDirectoryStructure">http://wiki.wesnoth.org/BuildingCampaignsDirectoryStructure</a>, <a href="http://wiki.wesnoth.org/BuildingCampaigns">http://wiki.wesnoth.org/BuildingCampaigns</a>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -7,7 +7,10 @@
|
|||
</head>
|
||||
|
||||
<body>
|
||||
<h1>Era</h1>
|
||||
<h1>Era</h1>
|
||||
This wizard creates a new era.<br/><br/>
|
||||
|
||||
For more information see: <a href="http://wiki.wesnoth.org/EraWML">http://wiki.wesnoth.org/EraWML</a>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -7,7 +7,9 @@
|
|||
</head>
|
||||
|
||||
<body>
|
||||
<h1>Faction</h1>
|
||||
|
||||
<h1>Faction</h1>
|
||||
This wizard creates a new faction. <br/><br/>
|
||||
|
||||
For more information see: <a href="http://wiki.wesnoth.org/EraWML">http://wiki.wesnoth.org/EraWML</a>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -7,7 +7,11 @@
|
|||
</head>
|
||||
|
||||
<body>
|
||||
<h1>Wizard launcher</h1>
|
||||
|
||||
<h1>Wizard launcher</h1>
|
||||
This is a special wizard. It takes a wml tag as input, and generate subsequent needed tags and key
|
||||
inputs. This is generated based on the wml schema, so if the schema is incomplete some tags won't be available. This
|
||||
wizard can create a new file or copy the resulted WML into the current edited file.<br/><br/>
|
||||
|
||||
For more information see: <a href="http://wiki.wesnoth.org/AlphabeticalWML">http://wiki.wesnoth.org/AlphabeticalWML</a>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -7,7 +7,10 @@
|
|||
</head>
|
||||
|
||||
<body>
|
||||
<h1>Scenario</h1>
|
||||
|
||||
<h1>Scenario</h1>
|
||||
This wizard, creates a [scenario] WML, which will be created as a new standalone file.<br/><br/>
|
||||
|
||||
For more information see: <a href="http://wiki.wesnoth.org/ScenarioWML">http://wiki.wesnoth.org/ScenarioWML</a>,
|
||||
<a href="http://wiki.wesnoth.org/BuildingScenarios">http://wiki.wesnoth.org/BuildingScenarios</a>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<title>Common prerequisites - Installation</title>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h2>
|
||||
Common prerequisites
|
||||
</h2>
|
||||
<p>
|
||||
Common steps for both the user and the developer.
|
||||
</p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<title>Developer - Installation</title>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h2>
|
||||
Developer
|
||||
</h2>
|
||||
<p>
|
||||
The steps for the developer.
|
||||
</p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<title>User - Installation</title>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h2>
|
||||
User
|
||||
</h2>
|
||||
<p>
|
||||
The steps for user.
|
||||
</p>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
||||
<title>Table of Contents</title>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1>Table of Contents</h1>
|
||||
Please enter your text here.
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,7 +1,8 @@
|
|||
<?xml version="1.0" encoding="utf-8" ?>
|
||||
<introContent>
|
||||
<page id="root" style-id="page">
|
||||
<title style-id="intro-header">Welcome to Wesnoth User Made Content Plugin</title>
|
||||
<text>Hi!</text>
|
||||
</page>
|
||||
<page id="root" style-id="page">
|
||||
<title style-id="intro-header">Welcome to Wesnoth User Made Content Plugin
|
||||
</title>
|
||||
<text>The Battle for Wesnoth UMC Development IDE</text>
|
||||
</page>
|
||||
</introContent>
|
||||
|
|
@ -1,14 +1,11 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<?NLS TYPE="org.eclipse.help.toc"?>
|
||||
|
||||
<toc label="Wesnoth Eclipse Plugin" topic="help/html/toc.html">
|
||||
<toc label="Wesnoth Eclipse Plugin">
|
||||
<topic label="Getting Started">
|
||||
<link toc="help/tocgettingstarted.xml"/>
|
||||
</topic>
|
||||
<topic label="Features">
|
||||
<link toc="help/tocfeatures.xml"/>
|
||||
</topic>
|
||||
<topic label="Reference">
|
||||
<link toc="help/tocreference.xml"/>
|
||||
</topic>
|
||||
</toc>
|
||||
|
|
|
|||
|
|
@ -2,8 +2,8 @@
|
|||
<?NLS TYPE="org.eclipse.help.toc"?>
|
||||
|
||||
<toc label="Features">
|
||||
<topic href="html/features/plugin.html" label="Plugin">
|
||||
<topic href="help/html/features/plugin.html" label="Plugin">
|
||||
</topic>
|
||||
<topic href="html/features/wml_editor.html" label="WML Editor">
|
||||
<topic href="help/html/features/wml_editor.html" label="WML Editor">
|
||||
</topic>
|
||||
</toc>
|
||||
|
|
|
|||
|
|
@ -2,21 +2,21 @@
|
|||
<?NLS TYPE="org.eclipse.help.toc"?>
|
||||
|
||||
<toc label="Getting Started">
|
||||
<topic href="html/gettingstarted/setup.html" label="Setting up the workspace">
|
||||
</topic>
|
||||
<topic href="help/html/gettingstarted/setup.html" label="Setting up the workspace">
|
||||
</topic>
|
||||
<topic href="help/html/gettingstarted/mainmenu.html" label="Main menu">
|
||||
</topic>
|
||||
<topic label="New Wizards">
|
||||
<topic label="Campaign" href="html/gettingstarted/wizards/campaign.html" />
|
||||
</topic>
|
||||
<topic href="html/gettingstarted/mainmenu.html" label="Main menu">
|
||||
<topic label="Campaign" href="help/html/gettingstarted/wizards/campaign.html" />
|
||||
</topic>
|
||||
<topic label="Context Menus">
|
||||
<topic href="html/gettingstarted/context_menus/project.html" label="Project">
|
||||
<topic href="help/html/gettingstarted/context_menus/project.html" label="Project">
|
||||
</topic>
|
||||
<topic href="html/gettingstarted/context_menus/config.html" label="Config files">
|
||||
<topic href="help/html/gettingstarted/context_menus/config.html" label="Config files">
|
||||
</topic>
|
||||
<topic href="html/gettingstarted/context_menus/map.html" label="Map files">
|
||||
<topic href="help/html/gettingstarted/context_menus/map.html" label="Maps files and directories">
|
||||
</topic>
|
||||
<topic href="html/gettingstarted/context_menus/folder.html" label="Folders">
|
||||
<topic href="help/html/gettingstarted/context_menus/container.html" label="Containers">
|
||||
</topic>
|
||||
</topic>
|
||||
</toc>
|
||||
|
|
|
|||
|
|
@ -1,11 +0,0 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<?NLS TYPE="org.eclipse.help.toc"?>
|
||||
|
||||
<toc label="Reference" link_to="toc.xml#reference">
|
||||
<topic href="html/reference/installation_common.html" label="Installation">
|
||||
<topic href="html/reference/installation_developer.html" label="Developer">
|
||||
</topic>
|
||||
<topic href="html/reference/installation_user.html" label="User">
|
||||
</topic>
|
||||
</topic>
|
||||
</toc>
|
||||
|
|
@ -107,9 +107,6 @@
|
|||
<toc
|
||||
file="help/tocgettingstarted.xml">
|
||||
</toc>
|
||||
<toc
|
||||
file="help/tocreference.xml">
|
||||
</toc>
|
||||
</extension>
|
||||
<extension
|
||||
point="org.eclipse.help.contexts">
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue