^documentCloud( [count] )^

Tinderbox Icon


Code Type:   Export Mark-up
Code Scope of Action:   document

^documentCloud( [count] )^

This provides an HTML interface to the information displayed in the Common Words view. Here the scope is the whole TBX document. It displays the 100 most common words in the note, omitting stop words (there may be fewer words if there are fewer valid words in scope). The words are wrapped in tags to permit the most common words to be displayed in a larger font; the tags used may be customized through the new attributes HTMLCloud1Start/End, HTMLCloud2Start/End, etc.

^documentCloud^ takes one optional arguments:

Examples:

^documentCloud^ 

^documentCloud(50)^ 

See also ^cloud^, ^sectionCloud^

Below is the output from ^documentCloud(25)^. Note that ideally it should be placed in some form of HTML container rather than be allowed to spread across the page otherwise the visual impact is lost. Here anyway is the ^documentCloud(25)^ 'raw' output:

attribute attributes code current data default example export file item map may name note notes set string tbx text tinderbox used value via view  
Up: Export Mark-up
Previous: ^cloud( item, count] )^  Next: ^encode( data )^ 

[Last updated: 14 Dec 2009, using v5.0]

Google search aTbRef for:  

Licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License
[See aTbRef CC licence Attribution/Waiver info info]

Creative Commons License

Made with Tinderbox