GoFiler Legato Script Reference   Legato v 1.5d Application v 5.25a

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

11.3.8 SGML Values and SGML Math

This section covers functions that assist in the processing of SGML values. Conventionally, SGML attributes are strings or character data (CDATA), the meaning of which depends on the DTD and the systems using the data. This section discusses values that are more in tune with HTML and CSS.

For XML processing, data is generally processed a CDATA thus leaving the supporting application or script to interpret the string content.

Obviously pvalues cannot just be added or subtracted using normal math operators. The first problem is the PT_ type codes will also have math operations performed on them thus destroying the unit values and also becoming part of the equation. A series of functions are provided to normalize, perform math and convert values back to the appropriate units.

When adding or subtracting pvalues they must be normalized. For example, added points to inches does not make sense. One of the values must be normalized using the SGMLNormalizeUnits function. The function converts to TWIPS (20th of a point) and then to the desired unit value.

TWIPS is not a CSS or HTML unit type but is a convenient measurement value because it has a reasonably high resolution value (1 TWIP = 1/1440th of an inch). TWIPS are screen-independent units to ensure that the proportion of screen elements are the same on all display systems. (Note that a TWIP is actually 1440.5 of an inch which also follows that points are treated as 72 points per inch, but are slightly smaller depending on the typesetting reference. The application and Legato work off of the traditional computer values.) It is important to realize that fractional errors can be added in certain circumstances, for example, normalize 1.5in to millimeters and back to inches will result in a value of 1.502in.

TWIPS can also be used manually by converting to and from TWIPS by using the SGMLValueToTWIPS and SGMLTWIPSToValue functions.

Note that many of the value functions do not check for overflow, the signed 27 bit value represents +/- 67108863. or 671088.63 or 6710.8863, depending on the decimal place. For the units, this range is more than adequate (better than 500 feet or inches, 750 feet in points, or better than 0.5km for mm).

While not seemingly obvious, certain unit types do not have a relationship and cannot be generally normalized. For example, inches to seconds, or, points to degrees, etc.... Such operations will result in an undefined value or error. With that in mind, HTML and CSS have a number of measurements in relative sizes such as percent or ems. Certain functions SGMLValueToPixels allow reference values (in TWIPS) to accommodate translation.

Character Entity Functions

SGMLCharEntityToValue — Converts the specific entity as decimal, hex or name to a character value.

Math Functions

SGMLAddValues — Adds a and b pvalue types.

SGMLDivideValue — Divides pvalue a by a floating-point divisor.

SGMLMultiplyValue — Multiplies pvalue a times a floating-point value.

SGMLSubtractValues — Subtracts value b from a. Values must be of the same unit type.

Testing Functions

SGMLIsDataAvailable — Tests for data being available (not default, mixed, empty or zero).

SGMLIsImplied — Tests value for being implied (as empty, default or PT_IMPLIED).

SGMLIsMeasurement — Tests value for being a measurement type.

SGMLIsMixed — Tests value as mixed (PT_MIXED or “mixed”).

SGMLIsWholeUnits — Tests that a measurement has no fractional values.

Unit Functions

SGMLNormalizeUnits — Normalizes or converts the units from data to base and returns a normalized value.

Value Conversion Functions

SGMLFloatToValue — Converts a floating-point to a pvalue.

SGMLIntegerToValue — Converts a simple integer to a pvalue of certain units.

SGMLPixelsToValue — Converts pixels to a pvalue (value * 100 | PT_PX).

SGMLStringToValue — Converts a string to pvalue type.

SGMLTWIPSToValue — Converts twips to a pvalue with optional rounding flag.

SGMLValueToData — Removes the unit type and extends the sign of a value.

SGMLValueToInteger — Removes the unit type, adds sign as required and adjusts ranging.

SGMLValueToPixels — Converts value to pixels (with optional box and em sizes for scaling).

SGMLValueToString — Converts a pvalue type to a string.

SGMLValueToTWIPS — Converts a value to pixels (with optional box and em sizes for scaling).

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 12/16/2024

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.