aboutsummaryrefslogtreecommitdiff
path: root/help/eng
diff options
context:
space:
mode:
authorMikko Syrjä <mikko@3d-system.fi>2019-03-30 00:27:05 +0200
committerMikko Syrjä <mikko@3d-system.fi>2019-03-30 00:27:05 +0200
commit2121977dad193f63d3db54bb46dbaccef2c61518 (patch)
tree608af370f9df91475af87750fd24362421521bc6 /help/eng
parent23e663f6a73ed16c88638944d5795d1d5cb37618 (diff)
downloadsymedit-2121977dad193f63d3db54bb46dbaccef2c61518.tar.gz
symedit-2121977dad193f63d3db54bb46dbaccef2c61518.zip
Help file improvements.
Diffstat (limited to 'help/eng')
-rw-r--r--help/eng/_static/icon256.pngbin0 -> 11111 bytes
-rw-r--r--help/eng/conf.py6
-rw-r--r--help/eng/format.rst60
-rw-r--r--help/eng/index.rst9
-rw-r--r--help/eng/usage.rst13
5 files changed, 75 insertions, 13 deletions
diff --git a/help/eng/_static/icon256.png b/help/eng/_static/icon256.png
new file mode 100644
index 0000000..f29d44a
--- /dev/null
+++ b/help/eng/_static/icon256.png
Binary files differ
diff --git a/help/eng/conf.py b/help/eng/conf.py
index 2214998..956dd13 100644
--- a/help/eng/conf.py
+++ b/help/eng/conf.py
@@ -85,11 +85,17 @@ todo_include_todos = False
#
html_theme = 'alabaster'
+html_theme_options = {
+ 'logo': 'icon256.png'
+}
+
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
# html_theme_options = {}
+html_copy_source = False
+html_show_sourcelink = False
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
diff --git a/help/eng/format.rst b/help/eng/format.rst
new file mode 100644
index 0000000..86dfd68
--- /dev/null
+++ b/help/eng/format.rst
@@ -0,0 +1,60 @@
+.. _symbol-format-label:
+
+Symbol format
+=============
+
+xxx
+
+Commands
+--------
+
+Commands are separated by semicolons. Coordinate X is horizontal component from left to right and Y is vertical component from bottom to top.
+
+**U** - Change position
+^^^^^^^^^^^^^^^^^^^^^^^
+
+Changes current position to parameter coordinates.
+
+Parameters: X,Y (``U10,10``)
+
+**D** - Draw line
+^^^^^^^^^^^^^^^^^
+
+Draws line from previous position to parameter coordinates.
+
+Parameters: X,Y (``U20,20``)
+
+**R** - Draw circle
+^^^^^^^^^^^^^^^^^^^
+
+Draws parameter radius circle using previous position as center.
+
+Parameters: R (``R30``)
+
+**B** - Draw rectangle
+^^^^^^^^^^^^^^^^^^^^^^
+
+Draws rectangle using previous position and parameter coordinates as corners.
+
+Parameters: X,Y (``B40,40``)
+
+**C** - Set color index
+^^^^^^^^^^^^^^^^^^^^^^^
+
+Sets parameter to current drawing color index.
+
+Parameters: I (``C3``)
+
+**F** - Set area fill type
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Sets area fill type index to one of the following values:
+
+0. No fill
+1. Area fill using background color
+2. Area fill using current color
+
+Fill type works with rectangle and circle commands. Border is drawn only when the fill type is zero.
+
+Parameters: I (``F2``)
+
diff --git a/help/eng/index.rst b/help/eng/index.rst
index 5f5982b..c1eec62 100644
--- a/help/eng/index.rst
+++ b/help/eng/index.rst
@@ -1,11 +1,11 @@
-=======
-SymEdit
-=======
+=============
+Symbol editor
+=============
.. _3D-Win: http://www.3d-system.fi/
.. _Github: https://github.com/mikkosyrja/symedit/
-SymEdit is symbol editor for symbols used by `3D-Win`_ survey application.
+Symbol editor for symbols used by `3D-Win`_ survey application.
.. toctree::
:maxdepth: 2
@@ -14,6 +14,7 @@ SymEdit is symbol editor for symbols used by `3D-Win`_ survey application.
usage
menu
tools
+ format
.. _Gentleface: https://gentleface.com/free_icon_set.html
diff --git a/help/eng/usage.rst b/help/eng/usage.rst
index 9ef5a4c..196394f 100644
--- a/help/eng/usage.rst
+++ b/help/eng/usage.rst
@@ -3,11 +3,6 @@ Application usage
xxx
-Installation
-------------
-
-xxx
-
Command line
------------
@@ -21,12 +16,12 @@ Given argument file name is a transfer file. When application exits, current sym
-s, --symbol <symbol>
^^^^^^^^^^^^^^^^^^^^^
-Reads symbol definition. For example: ``symedit -s R50;U0,50;D0,-50;U-50,0;D50,0``
+Reads symbol definition. For example: ``symedit -s R50;U0,50;D0,-50;U-50,0;D50,0``. See :ref:`symbol-format-label`.
-l, --language <lang>
^^^^^^^^^^^^^^^^^^^^^
-Selects application language. Supported languages are english (eng) and finnish (fin). For example: ``symedit -l fin``
+Selects application language. Supported languages are english (eng) and finnish (fin). For example: ``symedit -l eng``
-h, --help
^^^^^^^^^^
@@ -38,8 +33,8 @@ file
Symbol file name. Symbol file is simple text file containing symbol definition.
-Usage
------
+User interface
+--------------
xxx