fonttools/Documentation/robofabDocs/robofab.features.html
Erik van Blokland 3646055ea2 initial import
git-svn-id: http://svn.robofab.com/trunk@1 b5fa9d6c-a76f-4ffd-b3cb-f825fc41095c
2008-01-07 17:40:34 +00:00

72 lines
5.2 KiB
HTML

<!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: package robofab.features</title>
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="robofab.html"><font color="#ffffff">robofab</font></a>.features</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/code/projects/robofab/Lib/robofab/features/__init__.py">/code/projects/robofab/Lib/robofab/features/__init__.py</a></font></td></tr></table>
<p><tt>Directory&nbsp;for&nbsp;all&nbsp;feature&nbsp;like&nbsp;code.<br>
&nbsp;<br>
&nbsp;<br>
Features&nbsp;should&nbsp;(for&nbsp;now)&nbsp;be&nbsp;stored&nbsp;in&nbsp;the&nbsp;<br>
font&nbsp;lib&nbsp;at&nbsp;the&nbsp;keys&nbsp;listed&nbsp;below.<br>
&nbsp;<br>
&nbsp;<br>
SUBSTITUTION:<br>
-&nbsp;lib&nbsp;key:&nbsp;org.robofab.features.substitute<br>
-&nbsp;object&nbsp;type:&nbsp;dict<br>
-&nbsp;required&nbsp;data:<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-'name':&nbsp;string&nbsp;value;&nbsp;the&nbsp;name&nbsp;of&nbsp;the&nbsp;feature.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-'type':&nbsp;string&nbsp;value;&nbsp;the&nbsp;type&nbsp;of&nbsp;the&nbsp;lookup.&nbsp;refer&nbsp;to&nbsp;substitute.py&nbsp;for&nbsp;registered&nbsp;types.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-'substitution':&nbsp;depends&nbsp;on&nbsp;type&nbsp;of&nbsp;lookup.&nbsp;refer&nbsp;to&nbsp;substitute.py&nbsp;for&nbsp;structure.<br>
-&nbsp;optional&nbsp;data:<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-'on':&nbsp;bool&nbsp;value;&nbsp;the&nbsp;default&nbsp;status&nbsp;of&nbsp;the&nbsp;feature.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br>
POSITION:<br>
-&nbsp;lib&nbsp;key:&nbsp;org.robofab.features.position<br>
-&nbsp;object&nbsp;type:&nbsp;dict<br>
-&nbsp;required&nbsp;data:<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-'name':&nbsp;string&nbsp;value;&nbsp;the&nbsp;name&nbsp;of&nbsp;the&nbsp;feature.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-'type':&nbsp;string&nbsp;value;&nbsp;the&nbsp;type&nbsp;of&nbsp;the&nbsp;lookup.&nbsp;refer&nbsp;to&nbsp;position.py&nbsp;for&nbsp;registered&nbsp;types.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-'positioning':&nbsp;depends&nbsp;on&nbsp;type&nbsp;of&nbsp;lookup.&nbsp;refer&nbsp;to&nbsp;position.py&nbsp;for&nbsp;structure.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-'positionsX':&nbsp;bool&nbsp;value;&nbsp;lookup&nbsp;does&nbsp;x&nbsp;coordinate&nbsp;positioning<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-'positionsY':&nbsp;bool&nbsp;value;&nbsp;lookup&nbsp;does&nbsp;y&nbsp;coordinate&nbsp;positioning<br>
-&nbsp;optional&nbsp;data:<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-'on':&nbsp;bool&nbsp;value;&nbsp;the&nbsp;default&nbsp;status&nbsp;of&nbsp;the&nbsp;feature.</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="robofab.features.featureTools.html">featureTools</a><br>
</td><td width="25%" valign=top><a href="robofab.features.position.html">position</a><br>
</td><td width="25%" valign=top><a href="robofab.features.substitute.html">substitute</a><br>
</td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#eeaa77">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
<tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl><dt><a name="-readFeatures"><strong>readFeatures</strong></a>(aFont)</dt><dd><tt>Read&nbsp;the&nbsp;features&nbsp;from&nbsp;a&nbsp;font.lib&nbsp;and&nbsp;(if&nbsp;any)<br>
put&nbsp;them&nbsp;in&nbsp;an&nbsp;dict&nbsp;in&nbsp;the&nbsp;font.</tt></dd></dl>
<dl><dt><a name="-writeFeatures"><strong>writeFeatures</strong></a>(aFont)</dt><dd><tt>Write&nbsp;the&nbsp;features&nbsp;in&nbsp;aFont.features&nbsp;back&nbsp;to&nbsp;the&nbsp;font.lib.</tt></dd></dl>
</td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><strong>PAIR_OFFSET</strong> = 'pair_offset'<br>
<strong>POS_LIB_KEY</strong> = 'org.robofab.features.positioning'<br>
<strong>SUB_LIB_KEY</strong> = 'org.robofab.features.substitute'<br>
<strong>optionalPositioningAttrs</strong> = ['on']<br>
<strong>optionalSubstitutionAttrs</strong> = ['on']</td></tr></table>
</body></html>