This version is out of date, covering development from v4.6.0 to v4.7.1. It is maintained here only for inbound reference links from elsewhere.
Jump to the current version of aTbRef.
|A Tinderbox Reference File : Actions & Rules : Operators : Action Operator Types : Formatting operators : idEncode(data)||aTbRef Site Map|
|Operator Scope of Action:||Item|
Returns data in a form suitable for use an id attribute value in HTML and XML. This addresses the problem of using general text strings such as note names as 'id' attributes in output for marked up languages like HTML and XML.
Using idEncode() ensures the result begins with a letter or underscore, and contains only letters, digits, and the underscore character. Multiple underscores are collapsed to a single character. For example:
idEncode(string) -> result string
frogs -> frogs
frogs dogs -> frogs_dogs
War And Peace -> War_And_Peace
3 blind mice -> _3_blind_mice
Wow!!! Look -> Wow_Look
Notice that leading numbers (not legal for 'id' initial characters) are preceded by underscores to maintain legibility vs. the source string.
Note too (see syntax examples at top) that string literal values are "quoted" whereas attribute names are not, the latter's status being indicated by their $ prefix.
|Up: Formatting operators|
|Previous: format(data, formatString)||Next: uppercase(data)|
Licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License
[See aTbRef CC licence Attribution/Waiver info info]