Editing Spiral Wrapped Text

{{EggBotDocs}}


'''Important note''': Spiral Wrapped Text is no longer supported. It is still available [https://github.com/evil-mad/EggBot/tree/master/inkscape_deprecated in our repository] for manual installation.


== Introduction ==

http://evilmadscience.s3.amazonaws.com/wiki/eggbot/extensiontut/extensions-spiral-text-01.png http://evilmadscience.s3.amazonaws.com/wiki/eggbot/extensiontut/extensions-spiral-text-02.png

Creating text which gently spirals around an egg makes for a fun and striking design.  Make an egg with a favorite poem, text passage, or even an [http://www.thingiverse.com/thing:8125 egg related recipe!]  This extension will automatically size your text to achieve a desired number of wraps around your egg.  The text itself is drawn with vector fonts selected for use with the Eggbot [1].  The fonts are drawn as paths: they do not need to be converted to paths before plotting.


== Basic operation ==

Type the desired text in the extension's "Text" input field and then enter the number of times to wrap the text around the egg.  You may optionally select one of three font styles: Sans, Times, or Script.  If your text uses the characters "&" or "<" then they must be entered as "&amp;amp;" or "&amp;lt;", respectively.  Before plotting on an egg, ensure that the option "Egg (x) axis wraps around" is checked in the Eggbot Control externsion's "Options" tab.

The number of times to wrap need not be a whole number: you may use values such as 8.5.  The extension sizes the text to achieve the necessary overall length. For instance, if you enter 8.5, then the text will have an overall length of 8.5&nbsp;&times;&nbsp;3200&nbsp;pixels.  Consequently, the more number of times the text wraps around the egg, the larger the size of the text.  If the text seems too small, just increase the amount of wrapping.  Conversely, if it is too large, decrease the amount wrapping.  Note that if the text scales to too large of a size, then the wrapped text may overlap between wraps.  If this occurs, decrease the size of the text by decreasing the amount of wrapping.

The three font styles, Sans, Times, and Script, represent a single stroke font without serifs (Sans), a Roman font with serifs (Times), and a single stroke cursive font (Script).  These fonts correspond to the "Sans 1-stroke", "Serif medium", and "Script 1-stroke" fonts of the Hershey Text extension.

Note that the extension's text input field is not very friendly: it's difficult to see all your text at once or to move about within the text.  This is an Inkscape limitation.  You may find it easier to edit your text in some other application and then cut-and-paste it into the extension's text input field [2].

== Changing fonts and other markup ==

This extension supports a simple markup language which allows switching between font families as well as selecting between bold, italics, and emphasized font faces.  This markup language uses an HTML-like syntax,

:&lt;command>some text&lt;/command>

For example, to select one of the three font families Sans, Times, or Roman, use

:&lt;sans>some text&lt;/sans>
:&lt;times>some text&lt;/times>
:&lt;script>some text&lt;/script>

Note that you do not need to enter "&amp;lt;" for the "<".

To make the text bold, emphasized, or italicized, use the markup

:&lt;b>Some bold text&lt;/b>
:&lt;em>Some emphasized text&lt;/em>
:&lt;it>Some italicized text&lt;/it>

These markups may be combined.  For example,

:&lt;b>&lt;it>That's absolutely beautiful!&lt;/it>&lt;/b>

Note that the Sans font family has no italicized font while italics is redundant for the Script font family.  The specific fonts used for each family are shown in the table below.  The specific font names are the names used by the Hershey Font extension of the Render extension category.

{| class="wikitable"
|-
! Family
! Normal
! Bold
! Italics
! Bold + Italics
|-
! Sans
| Sans 1-stroke
| Sans bold
| Sans 1-stroke
| Sans bold
|-
! Times
| Serif medium
| Serif bold
| Serif medium italic
| Serif bold italic
|-
! Script
| Script 1-stroke
| Script medium
| Script 1-stroke
| Script medium
|}

To select specific fonts, use the markups shown below.  Again, the font names are as per the Hershey Text extension.

{| class="wikitable"
|-
! Font
! Markup
|-
| Sans 1-stroke
| &lt;futural>text&lt;/futural>
|-
| Sans bold
| &lt;futuram>text&lt;/futuram>
|-
| Serif medium
| &lt;timesr>text&lt;/timesr>
|-
| Serif medium italic
| &lt;timesi>text&lt;/timesi>
|-
| Serif bold italic
| &lt;timesib>text&lt;/timesib>
|-
| Serif bold
| &lt;timesrb>text&lt;/timesrb>
|-
| Script 1-stroke
| &lt;scripts>text&lt;/scripts>
|-
| Script 1-stroke (alt)
| &lt;cursive>text&lt;/cursive>
|-
| Script medium
| &lt;scriptc>text&lt;/scriptc>
|-
| Gothic English
| &lt;gothiceng>text&lt;/gothiceng>
|-
| Gothic German
| &lt;gothicger>text&lt;/gothicger>
|-
| Gothic Italian
| &lt;gothicita>text&lt;/gothicita>
|-
| Greek 1-stroke
| &lt;greek>text&lt;/greek>
|-
| Greek medium
| &lt;timesg>text&lt;/timesg>
|-
| Cyrillic
| &lt;cyrillic>text&lt;/cyrillic>
|-
| Japanese
| &lt;japanese>text&lt;/japanese>
|-
| Astrology
| &lt;astrology>text&lt;/astrology>
|-
| Math (lower)
| &lt;mathlow>text&lt;/mathlow>
|-
| Math (upper)
| &lt;mathupp>text&lt;/mathupp>
|-
| Markers
| &lt;markers>text&lt;/markers>
|-
| Meteorology
| &lt;meteorology>text&lt;/meteorology>
|-
| Music
| &lt;music>text&lt;/music>
|-
| Symbolic
| &lt;symbolic>text&lt;/symbolic>
|-
| EMS Foo (any EMS font)
| &lt;emsfoo>text&lt;/emsfoo>
|}

As noted above, any of the 29 EMS fonts in the newer version of the Hershey Text extension can be invoked using markup which gives the name of the font in all lower-case without spaces.

To see examples of a given font, use the Hershey Text extension to draw samples.

== Additional controls ==

To account for the horizontal compression which occurs when plotting on eggs, select the "Stretch the text horizontally..." checkbox. That will horizontally stretch the text by 50% [3].

To rotate the text 180 degrees turning it upside down, check the "Plot with the egg's bottom at the egg motor?" checkbox. You do not need to use this option if you have reversed the motion of both motors in the Options tab of the Eggbot Control extension.

== Notes ==

1. For more information on these fonts, please see [http://www.evilmadscientist.com/article.php/hershey Hershey Text].<br/>
2. On Mac OS X, this can be difficult: you need to change the X11 preferences to allow cut and paste operations between the clipboard and pasteboard.  This, however, is not a mode you want to leave enabled as it causes cut and paste operations on elements in your Inkscape drawings to work incorrectly.<br/>
3. This horizontal compression is a result of the egg's horizontal or equatorial circumference being less than its pole-to-pole circumference. 

----

[[Post process trace bitmap|<<< Post process trace bitmap]] || Spiral Wrapped Text || [[Stretch|Stretch >>>]]