[brlcad-commits] SF.net SVN: brlcad:[46944] brlcad/trunk/doc/docbook/README.DB_authors_notes

[<tbr...@us...>]

Revision: 46944
          http://brlcad.svn.sourceforge.net/brlcad/?rev=46944&view=rev
Author:   tbrowder2
Date:     2011-09-28 12:46:06 +0000 (Wed, 28 Sep 2011)
Log Message:
-----------
special notes and aids for DB authors--may want to rename this file HACKING to parallel the HACKING file for thetop-level dir

Added Paths:
-----------
    brlcad/trunk/doc/docbook/README.DB_authors_notes

Added: brlcad/trunk/doc/docbook/README.DB_authors_notes
===================================================================
--- brlcad/trunk/doc/docbook/README.DB_authors_notes	                        (rev 0)
+++ brlcad/trunk/doc/docbook/README.DB_authors_notes	2011-09-28 12:46:06 UTC (rev 46944)
@@ -0,0 +1,156 @@
+Some special characters for DB inline equations:
+
+ LE  ≤   less than or equal to
+ GE  ≥   greater than or equal to
+ x   ×   multiply                   
+ div ÷   divide
+ add +   add
+ pm  ±   plus or minus              
+ ne  ≠   not equal to
+ dot ∙   dot operator (multiply)
+ pi  π   small Greek letter pi
+ Pi  Π   capital Greek letter Pi
+
+Dashes:
+
+  figure dash     ‒ 
+  en dash         –       
+  em dash         — 
+  quotation dash  ―
+  swung dash      ⁓
+
+Some unicode characters for spaces (see p. 330 in Bob Stayton's book):
+
+        no-break space
+        en space, half the width of an em space
+        em space, usually equal to the type size of the font
+      1/3 em
+      1/4 em
+             1/6 em
+       width of a digit
+      width of narrow punctuation
+      1/5 em
+      thinner than thin space
+
+Other symbols:
+ 
+ ©           copyright
+ ®           registered sign
+ °           degree symbol
+ ℠           service mark
+ ™           trade mark
+
+Note that the space character should butt against the adjacent
+characters.
+
+To include fancier equations, do the following:
+
+Use LibreOffice Math to write the equation.  Save the file as X.mml
+where X is a suitable name.
+
+Example mml file:
+
+<?xml version="1.0" encoding="UTF-8"?>
+
+<math xmlns="http://www.w3.org/1998/Math/MathML">
+ <semantics>
+  <mrow>
+   <mrow>
+    <msub>
+     <mi>P</mi>
+     <mi>k</mi>
+    </msub>
+   </mrow>
+  </mrow>
+  <annotation encoding="StarMath 5.0">P_{k} = P_{{k}_{MAX}} left lbrace 1 -e^{[-k_{1}(x - x_{0})^{k_{2}}]} right rbrace </annotation>
+ </semantics>
+</math>
+
+Edit the file to remove the "semantics" element. Ensure you add the
+mml file to version control.
+
+Use SVGMath to convert the file to a graphic:
+
+  math2svg -s -o X.svg X.mml
+
+Or you can use the bash script "make-svg.sh" which creates the svg
+file in the text subdirectory and uses xmllint to format it ready for
+further editing either with Inkscape or by hand.
+
+Use Inkscape to view the svg file and edit it if necessary.  Be sure
+to add the new file to version control in the text subdirectory.
+
+Include the svg file in the desired place in DocBook source like this:
+
+<equation id="X">
+<title>General closed-form damage function formula</title>
+<informalfigure>
+<mediaobject>
+  <imageobject role='xhtml'>
+    <!-- centering title taken care of in css --> 
+    <imagedata
+       width='3in' scalefit='1'
+       fileref="./X.svg"
+    />
+  </imageobject>
+  <imageobject role='fo'>
+    <imagedata
+       align='center'
+       format="SVG"
+       fileref="./X.svg"
+    />
+  </imageobject>
+</mediaobject>
+</informalfigure>
+</equation>
+
+2011-04-13
+
+Note there are font problems for pdf with complex equations--I'm
+querying the fop mailing list for ideas.
+
+2011-07-24
+
+Marks for itemized list:
+
+For better looking list markers use the 'override' attribute for the
+<listitem>,
+e.g.,
+
+  <listitem override='disc'>        <!-- a small black dot    -->
+  ...
+  <listitem override='smallcircle'> <!-- a small white circle -->
+
+Other list symbols defined in the stylesheets:
+
+  <xsl:choose>
+    <xsl:when test="$itemsymbol='none'"></xsl:when>
+    <xsl:when test="$itemsymbol='disc'">&#x2022;</xsl:when>
+    <xsl:when test="$itemsymbol='bullet'">&#x25CF;</xsl:when>
+    <xsl:when test="$itemsymbol='endash'">&#x2013;</xsl:when>
+    <xsl:when test="$itemsymbol='emdash'">&#x2014;</xsl:when>
+    <!-- Some of these may work in your XSL-FO processor and fonts -->
+
+    <xsl:when test="$itemsymbol='square'">&#x25A0;</xsl:when>
+    <xsl:when test="$itemsymbol='box'">&#x25A0;</xsl:when>
+    <xsl:when test="$itemsymbol='circle'">&#x25CB;</xsl:when>
+    <xsl:when test="$itemsymbol='opencircle'">&#x25CB;</xsl:when>
+    <xsl:when test="$itemsymbol='whitesquare'">&#x25A1;</xsl:when>
+
+    <!-- these two are not in Linux Libertine: -->
+    <xsl:when test="$itemsymbol='smallwhitesquare'">&#x25AB;</xsl:when>
+    <xsl:when test="$itemsymbol='smallblacksquare'">&#x25AA;</xsl:when>
+
+    <xsl:when test="$itemsymbol='round'">&#x25CF;</xsl:when>
+    <xsl:when test="$itemsymbol='blackcircle'">&#x25CF;</xsl:when>
+    <xsl:when test="$itemsymbol='smallcircle'">&#x25E6;</xsl:when>
+    <xsl:when test="$itemsymbol='triangle'">&#x2023;</xsl:when>
+    <xsl:when test="$itemsymbol='point'">&#x203A;</xsl:when>
+    <!--    
+    <xsl:when test="$itemsymbol='hand'"><fo:inline
+                         font-family="Wingdings 2">A</fo:inline></xsl:when>
+    -->
+    <xsl:otherwise>&#x25CF;</xsl:otherwise><!-- bullet -->
+
+
+


Property changes on: brlcad/trunk/doc/docbook/README.DB_authors_notes
___________________________________________________________________
Added: svn:mime-type
   + text/plain
Added: svn:eol-style
   + native

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.