Repository navigation
Expand file tree
/
Copy pathplugins.html
More file actions
217 lines (180 loc) · 12.8 KB
/
Copy pathplugins.html
File metadata and controls
217 lines (180 loc) · 12.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
<!DOCTYPE html>
<html lang="en" data-content_root="../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Using FontForge Plugins — FontForge 20251009 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=4f649999" />
<link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=cb25574f" />
<script src="../_static/documentation_options.js?v=8a728459"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="icon" href="../_static/fftype16.png"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Several formats for bitmap only sfnts" href="bitmaponlysfnt.html" />
<link rel="prev" title="Palm fonts" href="palmfonts.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="using-fontforge-plugins">
<h1>Using FontForge Plugins<a class="headerlink" href="#using-fontforge-plugins" title="Link to this heading">¶</a></h1>
<p>A FontForge plugin is a Python package that contains code to enhance
the FontForge application in some way, most often by adding one or more
entries to the Font View or Char View <a class="reference internal" href="../ui/menus/toolsmenu.html"><span class="doc">Tools menu</span></a>.
Using a plugin is as easy as installing the package (often with
<a class="reference external" href="https:pypi.org/project/pip/">pip</a>) and, when necessary, “configuring”
the plugin. Almost any plugin of general interest will be listed in
the <a class="reference external" href="https:pypi.org/search/?q=%22FontForge_plugin%22">PyPI package database</a>.</p>
<section id="plugin-preferences">
<h2>Plugin Preferences<a class="headerlink" href="#plugin-preferences" title="Link to this heading">¶</a></h2>
<p>Two FontForge preference values affect the behavior of plugins. The first is
“UsePlugins” in the “Preferences …” dialog (under <a class="reference internal" href="../ui/menus/filemenu.html"><span class="doc">the File menu</span></a>), which is On by default. Turning this Off, temporarily
or permanently, will keep FontForge from attempting to discover and load
plugins.</p>
<figure class="align-default">
<img alt="Configure Plugins... Dialog" src="../_images/plugdlg.png" />
</figure>
<p>The second preference is “PluginStartupMode” in the “Configure Plugins…”
dialog (also under the File menu), which can be set to “On”, “Off”, or
“Ask” (the default). When this preference is set to “On” a newly discovered
plugins is automatically loaded. When set to “Off” it is not loaded
until you decide to Enable it in the same dialog. When set to “Ask” the
dialog will appear on startup whenever a new plugin is discovered so that
you can decide whether or not to use it. Which value makes the most sense for
you will depend on the degree of control you have over what packages are
installed in your python path.</p>
</section>
<section id="enabling-and-disabling-plugins">
<h2>Enabling and Disabling Plugins<a class="headerlink" href="#enabling-and-disabling-plugins" title="Link to this heading">¶</a></h2>
<p>The “Configure Plugins…” dialog allows you to Enable or Disable individual
plugins and also Delete entries for once-discovered plugins that are no
longer found. You can also “reorder” plugins—changing the load order and
therefore the order of Tools menu entries. There are also buttons for
loading a so-far-unloaded plugin (in case you do not want to wait for the
next application restart), getting more (mostly technical) information
about the plugin, and opening the web page associated with the plugin
package.</p>
<p>Finally, if a plugin has its own preferences you can set those with the
“Configure” button (which is disabled otherwise). The content of preferences
and the process of setting them will vary by plugin.</p>
</section>
<section id="loading-plugins-for-scripts">
<h2>Loading Plugins For Scripts<a class="headerlink" href="#loading-plugins-for-scripts" title="Link to this heading">¶</a></h2>
<p>When a script is run with FontForge directly using the <code class="docutils literal notranslate"><span class="pre">-script</span></code> flag each
enabled and discovered plugin will be loaded before control is passed off to
the script (unless the <code class="docutils literal notranslate"><span class="pre">-skippyplug</span></code> flag is also specified).
In contrast, running a python script with the <code class="docutils literal notranslate"><span class="pre">python</span></code> command and importing
the <code class="docutils literal notranslate"><span class="pre">fontforge</span></code> module will not cause plugins to be loaded. If you have a
script that needs the functionality of a plugin (perhaps because it adds a
new font export format) you must load the plugins explicitly by calling
<code class="docutils literal notranslate"><span class="pre">fontforge.loadPlugins()</span></code>. Calling this function when plugins are already
loaded should be harmless.</p>
</section>
<section id="troubleshooting">
<h2>Troubleshooting<a class="headerlink" href="#troubleshooting" title="Link to this heading">¶</a></h2>
<p>The FontForge project has no control over who can make a plugin. At
some point you may install one that causes problems, potentially even
preventing you from successfully running FontForge. One work-around for
that situation is to run FontForge with the <code class="docutils literal notranslate"><span class="pre">-skippyplug</span></code> flag.
When started with that flag FontForge will still “discover” plugins but
will not automatically load them. You can then open the “Configure Plugins…”
dialog, Disable the misbehaving plugin, and restart the program.</p>
<p>When an individual plugin is present but cannot be loaded there will be
relevant warnings logged on startup or when a load is attempted via the dialog
or the python API. There will also be a warning for each <em>enabled</em> plugin
that is not discovered.</p>
</section>
</section>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../index.html">FontForge</a></h1>
<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../ui.html">FontForge’s User Interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="../scripting/scripting.html">Scripting FontForge</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../techref.html">Technical References</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="gposgsub.html">Advanced Typography Tables</a></li>
<li class="toctree-l2"><a class="reference internal" href="AA-Comparison.html">Anti-Alias Comparison</a></li>
<li class="toctree-l2"><a class="reference internal" href="autotrace.html">Autotracing bitmaps in FontForge</a></li>
<li class="toctree-l2"><a class="reference internal" href="accented.html">Building Accented and other Composite Glyphs</a></li>
<li class="toctree-l2"><a class="reference internal" href="bezier.html">Bézier Splines </a></li>
<li class="toctree-l2"><a class="reference internal" href="askmulti.html">The <cite>askMulti</cite> Dialog</a></li>
<li class="toctree-l2"><a class="reference internal" href="ref-caveats.html">Caveats about References</a></li>
<li class="toctree-l2"><a class="reference internal" href="sfdchangelog.html">Changes to the sfd format</a></li>
<li class="toctree-l2"><a class="reference internal" href="cidmapformat.html">Cidmap files</a></li>
<li class="toctree-l2"><a class="reference internal" href="cliargs.html">Command Line Arguments</a></li>
<li class="toctree-l2"><a class="reference internal" href="splinefont.html">Data Types</a></li>
<li class="toctree-l2"><a class="reference internal" href="SuggestDeltas.html">Delta Instruction Suggestions</a></li>
<li class="toctree-l2"><a class="reference internal" href="stroke.html">Expand Stroke Facility</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyextend.html">Extending FontForge With Python</a></li>
<li class="toctree-l2"><a class="reference internal" href="BDFGrey.html">Extensions to Adobe’s BDF for greymap fonts</a></li>
<li class="toctree-l2"><a class="reference internal" href="PfaEdit-TeX.html">FontForge and TeX</a></li>
<li class="toctree-l2"><a class="reference internal" href="pfaeditmath.html">FontForge’s math</a></li>
<li class="toctree-l2"><a class="reference internal" href="hinting.html">Hinting</a></li>
<li class="toctree-l2"><a class="reference internal" href="macformats.html">Macintosh font formats</a></li>
<li class="toctree-l2"><a class="reference internal" href="featurefile.html">Major differences between FontForge’s and Adobe’s interpretation of feature files</a></li>
<li class="toctree-l2"><a class="reference internal" href="non-standard.html">Non standard extensions used FontForge in True/Open Type</a></li>
<li class="toctree-l2"><a class="reference internal" href="palmfonts.html">Palm fonts</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Using FontForge Plugins</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#plugin-preferences">Plugin Preferences</a></li>
<li class="toctree-l3"><a class="reference internal" href="#enabling-and-disabling-plugins">Enabling and Disabling Plugins</a></li>
<li class="toctree-l3"><a class="reference internal" href="#loading-plugins-for-scripts">Loading Plugins For Scripts</a></li>
<li class="toctree-l3"><a class="reference internal" href="#troubleshooting">Troubleshooting</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="bitmaponlysfnt.html">Several formats for bitmap only sfnts</a></li>
<li class="toctree-l2"><a class="reference internal" href="sfdformat.html">Spline Font Database</a></li>
<li class="toctree-l2"><a class="reference internal" href="pcf-format.html">The X11 PCF bitmap font file format</a></li>
<li class="toctree-l2"><a class="reference internal" href="TrueOpenTables.html">TrueType and OpenType tables supported by FontForge</a></li>
<li class="toctree-l2"><a class="reference internal" href="corpchar.html">Unicode Corporate Characters used by FontForge</a></li>
<li class="toctree-l2"><a class="reference internal" href="UniqueID.html">UniqueID and XUID</a></li>
<li class="toctree-l2"><a class="reference internal" href="selections.html">X Selections and the X Clipboard</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../fontutils.html">Utilities for examining fonts</a></li>
<li class="toctree-l1"><a class="reference internal" href="../faq.html">Frequently Asked Questions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../appendices.html">Appendices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../glossary.html">Typographical glossary</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../index.html">Documentation overview</a><ul>
<li><a href="../techref.html">Technical References</a><ul>
<li>Previous: <a href="palmfonts.html" title="previous chapter">Palm fonts</a></li>
<li>Next: <a href="bitmaponlysfnt.html" title="next chapter">Several formats for bitmap only sfnts</a></li>
</ul></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2000-2012 by George Williams, 2012-2025 by FontForge authors.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 7.2.6</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
</div>
</body>
</html>