Update internal documentation

master
skylarmt 9 years ago
parent ac7aea613b
commit 722759ed74

@ -66,17 +66,21 @@
<Component class="javax.swing.JList" name="topicList"> <Component class="javax.swing.JList" name="topicList">
<Properties> <Properties>
<Property name="model" type="javax.swing.ListModel" editor="org.netbeans.modules.form.editors2.ListModelEditor"> <Property name="model" type="javax.swing.ListModel" editor="org.netbeans.modules.form.editors2.ListModelEditor">
<StringArray count="6"> <StringArray count="9">
<StringItem index="0" value="Welcome"/> <StringItem index="0" value="Welcome"/>
<StringItem index="1" value="Basics"/> <StringItem index="1" value="Basics"/>
<StringItem index="2" value="Editor"/> <StringItem index="2" value="Editor"/>
<StringItem index="3" value="Graphing"/> <StringItem index="3" value="Pads"/>
<StringItem index="4" value="Commands"/> <StringItem index="4" value="Graphing"/>
<StringItem index="5" value="Licenses"/> <StringItem index="5" value="Plugins"/>
<StringItem index="6" value="Tasks"/>
<StringItem index="7" value="Commands"/>
<StringItem index="8" value="Licenses"/>
</StringArray> </StringArray>
</Property> </Property>
<Property name="selectionMode" type="int" value="0"/> <Property name="selectionMode" type="int" value="0"/>
<Property name="selectedIndex" type="int" value="0"/> <Property name="selectedIndex" type="int" value="0"/>
<Property name="visibleRowCount" type="int" value="9"/>
</Properties> </Properties>
<Events> <Events>
<EventHandler event="mouseClicked" listener="java.awt.event.MouseListener" parameters="java.awt.event.MouseEvent" handler="topicListMouseClicked"/> <EventHandler event="mouseClicked" listener="java.awt.event.MouseListener" parameters="java.awt.event.MouseEvent" handler="topicListMouseClicked"/>

@ -66,6 +66,7 @@ public class Help extends javax.swing.JInternalFrame {
private final StyleSheet styleSheet; private final StyleSheet styleSheet;
private final StyleSheet dark = new StyleSheet(); private final StyleSheet dark = new StyleSheet();
private final StyleSheet light = new StyleSheet(); private final StyleSheet light = new StyleSheet();
private int styleloaded = -1;
/** /**
* Creates new form Help * Creates new form Help
@ -96,20 +97,28 @@ public class Help extends javax.swing.JInternalFrame {
* (Re)load the theme for this window. * (Re)load the theme for this window.
*/ */
private void loadTheme() { private void loadTheme() {
if (PrefStorage.getSetting("theme").equals("dark")) { if ((PrefStorage.getSetting("theme").equals("dark") && styleloaded == 0)
topicList.setBackground(new Color(41, 49, 52)); || (!PrefStorage.getSetting("theme").equals("dark") && styleloaded == 1)) {
topicList.setForeground(Color.WHITE); styleloaded = -1;
styleSheet.addStyleSheet(dark); }
styleSheet.removeStyleSheet(light); if (styleloaded == -1) {
setBackground(Color.DARK_GRAY); if (PrefStorage.getSetting("theme").equals("dark")) {
} else { topicList.setBackground(new Color(41, 49, 52));
topicList.setBackground(Color.WHITE); topicList.setForeground(Color.WHITE);
topicList.setForeground(Color.BLACK); styleSheet.addStyleSheet(dark);
styleSheet.addStyleSheet(light); styleSheet.removeStyleSheet(light);
styleSheet.removeStyleSheet(dark); setBackground(Color.DARK_GRAY);
setBackground(Color.LIGHT_GRAY); styleloaded = 1;
} else {
topicList.setBackground(Color.WHITE);
topicList.setForeground(Color.BLACK);
styleSheet.addStyleSheet(light);
styleSheet.removeStyleSheet(dark);
setBackground(Color.LIGHT_GRAY);
styleloaded = 0;
}
loadTopic(topicList.getSelectedValue().toString().toLowerCase());
} }
loadTopic(topicList.getSelectedValue().toString().toLowerCase());
} }
/** /**
@ -153,12 +162,13 @@ public class Help extends javax.swing.JInternalFrame {
jSplitPane1.setResizeWeight(0.1); jSplitPane1.setResizeWeight(0.1);
topicList.setModel(new javax.swing.AbstractListModel() { topicList.setModel(new javax.swing.AbstractListModel() {
String[] strings = { "Welcome", "Basics", "Editor", "Graphing", "Commands", "Licenses" }; String[] strings = { "Welcome", "Basics", "Editor", "Pads", "Graphing", "Plugins", "Tasks", "Commands", "Licenses" };
public int getSize() { return strings.length; } public int getSize() { return strings.length; }
public Object getElementAt(int i) { return strings[i]; } public Object getElementAt(int i) { return strings[i]; }
}); });
topicList.setSelectionMode(javax.swing.ListSelectionModel.SINGLE_SELECTION); topicList.setSelectionMode(javax.swing.ListSelectionModel.SINGLE_SELECTION);
topicList.setSelectedIndex(0); topicList.setSelectedIndex(0);
topicList.setVisibleRowCount(9);
topicList.addMouseListener(new java.awt.event.MouseAdapter() { topicList.addMouseListener(new java.awt.event.MouseAdapter() {
public void mouseClicked(java.awt.event.MouseEvent evt) { public void mouseClicked(java.awt.event.MouseEvent evt) {
topicListMouseClicked(evt); topicListMouseClicked(evt);

@ -7,12 +7,15 @@
<p>The code editor allows you to make scripts that can do many things. <p>The code editor allows you to make scripts that can do many things.
<br>Scripts can be written in JavaScript or in Python. <br>Scripts can be written in JavaScript or in Python.
<br>To switch languages, use the Language option on the Run menu. <br>To switch languages, use the Language option on the Run menu.
<br>To run code, press F5 on your keyboard, or click Run &gt; Run Code.
<br>If your script is unresponsive, use the Kill Script button on the Run menu.
</p> </p>
<h2>Exporting Code</h2> <h2>Exporting Code</h2>
<p>You can export syntax-highlighted (colored) code to <p>You can export syntax-highlighted (colored) code to
HTML or PDF with the Export tool. This is useful for generating HTML or PDF with the Export tool. This is useful for generating
reports or for publishing to the Internet. reports or for publishing to the Internet.
<br>The code will be formatted according to the currently selected <br>The code will be formatted according to the currently selected
language in the editor.</p> language in the editor.
<br>Optionally, the contents of the Output window can be included in the exported file.</p>
</body> </body>
</html> </html>

@ -0,0 +1,23 @@
<html>
<head>
<title>Tasks</title>
</head>
<body>
<h1>Task Lists</h1>
<p>
Create a new Task List from the SyMAT Menu or the Tools tab.
<br>Items can be added from the Edit menu.
To change the values of a task item,
click the corresponding menu button.
<br>To delete an item, check the Delete this Task
box from its settings.
<br>The task list can be named from the Edit menu.
Choose List Title... and enter a name.
</p>
<p>
Task lists can be exported as HTML (web page),
so they can be viewed in any web browser.
Select the Export option from the File menu.
</p>
</body>
</html>

@ -0,0 +1,16 @@
<html>
<head>
<title>Pads</title>
</head>
<body>
<h1>Pads</h1>
<p>
You can work on code with other people around the world.
Select File &gt; Share... to upload the current script to SyMAT's
servers. Share the address SyMAT gives you, and other people can
access the script online.
<br>To access a script, open Pads from the Tools tab.
You can add, share, edit, and download pads from this window.
</p>
</body>
</html>

@ -0,0 +1,23 @@
<html>
<head>
<title>Tasks</title>
</head>
<body>
<h1>Task Lists</h1>
<p>
Create a new Task List from the SyMAT Menu or the Tools tab.
<br>Items can be added from the Edit menu.
To change the values of a task item,
click the corresponding menu button.
<br>To delete an item, check the Delete this Task
box from its settings.
<br>The task list can be named from the Edit menu.
Choose List Title... and enter a name.
</p>
<p>
Task lists can be exported as HTML (web page),
so they can be viewed in any web browser.
Select the Export option from the File menu.
</p>
</body>
</html>

Binary file not shown.

Before

Width:  |  Height:  |  Size: 146 KiB

Loading…
Cancel
Save