Documentation
Farkup
Metadata
Words
Tuple classes
Generic words
Symbol words
Ordinary words
Class predicate words
Files
Metadata files
Farkup
Metadata
| Tags: | text, web |
| Authors: | Doug Coleman, Daniel Ehrenberg |
Words
Tuple classes
| Class | Superclass | Slots |
 code | tuple | mode string |
| emphasis | tuple | child |
| heading1 | tuple | child |
| heading2 | tuple | child |
| heading3 | tuple | child |
| heading4 | tuple | child |
| image | tuple | href text |
| inline-code | tuple | child |
| line | tuple | |
| line-break | tuple | |
| link | tuple | href text |
| list-item | tuple | child |
| ordered-list | tuple | child |
| paragraph | tuple | child |
| strong | tuple | child |
| subscript | tuple | child |
| superscript | tuple | child |
| table | tuple | child |
| table-row | tuple | child |
| unordered-list | tuple | child |
Generic words
| Word | Stack effect |
 (write-farkup) | ( farkup -- xml ) |
Symbol words
| disable-images? |
| line-breaks? |
| link-no-follow? |
| relative-link-prefix |
Ordinary words
| Word | Stack effect |
 (parse-paragraph) | ( string -- list ) |
| (take-until) | ( state delimiter accum -- string/f state' ) |
| absolute-url? | ( string -- ? ) |
| check-url | ( href -- href' absolute? ) |
| coalesce | ( rows -- rows' ) |
| convert-farkup | ( string -- string' ) |
| count= | ( string -- n ) |
| cut-half-slice | ( string i -- before after-slice ) |
| delimiter-class | ( delimiter -- class ) |
| escape | ( before after -- before' after' ) |
| farkup-inside | ( farkup name -- xml ) |
| farkup>xml | ( string -- xml ) |
| find-cut | ( string quot -- before after delimiter ) |
 invalid-url | ( -- value ) |
| look | ( state i -- char ) |
| make-heading | ( string class -- heading ) |
| make-paragraph | ( string -- paragraph ) |
| open-link | ( link -- href text ) |
| or-simple-title | ( ... url title/f quot: ( ... title -- ... title' ) -- ... url title' ) |
| parse-big-link | ( before after -- link rest ) |
| parse-code | ( state -- state' item ) |
| parse-delimiter | ( string delimiter class -- paragraph ) |
| parse-farkup | ( string -- farkup ) |
| parse-heading | ( state -- state' heading ) |
| parse-item | ( state -- state' item ) |
| parse-line | ( state -- state' item ) |
| parse-link | ( string -- paragraph-list ) |
| parse-list | ( state char class -- state' list ) |
| parse-ol | ( state -- state' ul ) |
| parse-paragraph | ( string -- seq ) |
| parse-table | ( state -- state' table ) |
| parse-ul | ( state -- state' ul ) |
| render-code | ( string mode -- xml ) |
| simple-link-title | ( string -- string' ) |
| take-lines | ( state char -- state' lines ) |
| take-until | ( state delimiter -- string state'/f ) |
| trim-row | ( seq -- seq' ) |
| trim= | ( string -- string' ) |
| write-farkup | ( string -- ) |
| write-image-link | ( href text -- xml ) |
| write-link | ( href text -- xml ) |
Class predicate words
| Word | Stack effect |
| code? | ( object -- ? ) |
| emphasis? | ( object -- ? ) |
| heading1? | ( object -- ? ) |
| heading2? | ( object -- ? ) |
| heading3? | ( object -- ? ) |
| heading4? | ( object -- ? ) |
| image? | ( object -- ? ) |
| inline-code? | ( object -- ? ) |
| line-break? | ( object -- ? ) |
| line? | ( object -- ? ) |
| link? | ( object -- ? ) |
| list-item? | ( object -- ? ) |
| ordered-list? | ( object -- ? ) |
| paragraph? | ( object -- ? ) |
| strong? | ( object -- ? ) |
| subscript? | ( object -- ? ) |
| superscript? | ( object -- ? ) |
| table-row? | ( object -- ? ) |
| table? | ( object -- ? ) |
| unordered-list? | ( object -- ? ) |
Files
resource:basis/farkup/farkup.factor
resource:basis/farkup/farkup-docs.factor
resource:basis/farkup/farkup-tests.factor
resource:basis/farkup/farkup-docs.factor
resource:basis/farkup/farkup-tests.factor
Metadata files