Skip to content

Commit

Permalink
documentation changes.
Browse files Browse the repository at this point in the history
  • Loading branch information
fsmMLK committed Nov 1, 2016
1 parent 7060e91 commit 72e5c5d
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 2 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,18 @@ inkscape/extensions/
`-- polarAxes2D.inx
```

**Disabling LaTeX support of inkscapeMadeEasy**

Many of the methods implemented in inkscapeMadeEasy project use LaTeX to generate text. To this end I decided to employ the excellent extension **textext** from Pauli Virtanen <https://pav.iki.fi/software/textext/>.

LaTeX support via textext extension requires LaTeX typesetting system in your computer (it's free and awesome! =] ), together with a few python modules (pygtk and Tkinter among others). The later might be a problem for non-Linux systems (precompiled inkscape for Windows as OS X don't come with them).

Since many people don't use LaTeX and/or don't have it installed, inkscapeMadeEasy's LaTeX support is now optional. **By default, LaTeX support is ENABLED.**

Please refer to <https://fsmmlk.github.io/inkscapeMadeEasy/#installation-and-requirements> on how to easily disable LaTeX support.

.. warning:: Since disabling LaTeX support is a new feature, this project was not yet extensively checked for misplacements/errors when this support is disabled. Please report any issues you find.

# Usage

This extension is presented in two tabs, **R axis** and **Theta axis**. They are used to configure independently the axes of your chart. The tabs have most of the same control elements, with the exception of a few elements exclusive to R axis.
Expand Down Expand Up @@ -75,6 +87,7 @@ Ex: limits from 0 to 2, with tick step of 0.5 will produce ticks at 0, 0.5, 1, 1
> Note: The ticks will radiate from the origin R=0 or Theta=0 unless the origin does not lie within the limits. In such cases, the ticks will radiate from the lower limit.
>
> Examples
>
> <img src="docs/images/TickStep.png" width="600px"/>

Expand Down
6 changes: 4 additions & 2 deletions polarAxes2D.inx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<inkscape-extension xmlns="http://www.inkscape.org/namespace/inkscape/extension">
<_name>polar axes 2D</_name>
<_name>Polar axes</_name>
<id>fsmMLK.polarAxes2D</id>
<dependency type="executable" location="extensions">polarAxes2D.py</dependency>
<dependency type="executable" location="extensions">inkex.py</dependency>
Expand Down Expand Up @@ -43,7 +43,9 @@
<object-type>all</object-type>
<effects-menu>
<submenu _name="fsmMLK">
<submenu name="Plot 2D"/>
<submenu name="Plot 2D">
<submenu name="Polar"/>
</submenu>
</submenu>
</effects-menu>
</effect>
Expand Down

0 comments on commit 72e5c5d

Please sign in to comment.