Overview
Comment: | Rename listing functions |
---|---|
Timelines: | family | ancestors | descendants | both | trunk |
Files: | files | file ages | folders |
SHA3-256: |
552ad2a96cdf2c584e2d36d676efde1a |
User & Date: | joel on 2019-04-30 19:20:54 |
Other Links: | manifest | tags |
Context
2019-05-05
| ||
12:46 | Add ◊index tag, save index entries to cache db. Addresses [5daecde7] check-in: d7659912 user: joel tags: trunk | |
2019-04-30
| ||
19:20 | Rename listing functions check-in: 552ad2a9 user: joel tags: trunk | |
19:20 | Hack: make links relative while testing site in subfolder check-in: 2843e345 user: joel tags: trunk | |
Changes
Modified code-docs/crystalize.scrbl from [36b67736] to [4b2805a4].
︙ | ︙ | |||
72 73 74 75 76 77 78 | their @tt{series_pagenode} column in the SQLite cache. The @racket[_order] expression must evaluate to either @racket["ASC"] or @racket["DESC"] and the @racket[_limit] expressions must evaluate to a value suitable for use in the @tt{LIMIT} clause of @ext-link["https://sqlite.org/lang_select.html"]{a SQLite @tt{SELECT} statement}. An expression that evaluates to a negative integer (the default) is the same as having no limit. | | | > > > > | | | > | | 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 | their @tt{series_pagenode} column in the SQLite cache. The @racket[_order] expression must evaluate to either @racket["ASC"] or @racket["DESC"] and the @racket[_limit] expressions must evaluate to a value suitable for use in the @tt{LIMIT} clause of @ext-link["https://sqlite.org/lang_select.html"]{a SQLite @tt{SELECT} statement}. An expression that evaluates to a negative integer (the default) is the same as having no limit. @deftogether[(@defproc[(listing<>-short/articles [#:series series (or/c string? boolean?) #t] [#:limit limit stringish? -1] [order string? "DESC"]) txexpr?] @defproc[(listing<>-full/articles [#:series series (or/c string? boolean?) #t] [#:limit limit stringish? -1] [order string? "DESC"]) txexpr?])] @margin-note{Notice how the functions that start with @tt{list/} return lists and the functions that start with @tt{listing<>} return fenced HTML strings. Maybe this is ugly, but it helps me keep these otherwise too-similar sets of functions straight in my head.} Fetches the HTML for all articles from the SQLite cache and returns the HTML strings fenced inside a @racket['style] tagged X-expression. The articles will be ordered by publish date according to @racket[_order] and optionally limited to the series specified in @racket[_series]. If @racket[_series] expression evaluates to @racket[#f], articles will not be filtered by series. If it evaluates to @racket[#t] (the default), articles will be filtered by those that specify the current output of @racket[here-output-path] in their @tt{series_pagenode} column in the SQLite cache. If a string is supplied, articles will be filtered by those containing that exact value in their @tt{series_pagenode} column in the SQLite cache. The @racket[_order] expression must evaluate to either @racket["ASC"] or @racket["DESC"] and the @racket[_limit] expressions must evaluate to a value suitable for use in the @tt{LIMIT} clause of @ext-link["https://sqlite.org/lang_select.html"]{a SQLite @tt{SELECT} statement}. An expression that evaluates to a negative integer (the default) is the same as having no limit. The reason for enclosing the results in a @racket['style] txexpr is to prevent the HTML from being escaped by @racket[->html] in the template. This tag was picked for the job because there will generally never be a need to include any actual CSS information inside a @tt{<style>} tag in any page, so it can be safely filtered out later. To remove the enclosing @tt{<style>} tag, see @racket[unfence]. @defproc[(listing<>-full/articles+notes [#:series series (or/c string? #f) #f] [#:limit limit exact-integer? -1] [order string? "DESC"]) txexpr?] Like @racket[listing<>-full/articles] except that notes and articles are combined side by side in the results. @defproc[(unfence [html string?]) string?] Returns @racket[_html] with all occurrences of @racket["<style>"] and @racket["</style>"] removed. The contents of the style tags are left intact. Use this with strings returned from @racket[->html] when called on docs containing @racket[listing<>-full/articles] or its siblings. @defproc[(article-plain-title [pagenode pagenode?]) non-empty-string?] Fetches the “plain” title (i.e., with no HTML markup) for the given article from the SQLite cache. If the article did not specify a title, a default title is supplied. If the article contained a @racket[note] that used the @code{#:disposition} attribute, the disposition-mark may be included in the title. Note that this needs to be called @emph{after} @racket[crystalize-article!] in order to get an up-to-date value. |
Modified code-docs/pollen.scrbl from [91eacdd1] to [8e12d00a].
︙ | ︙ | |||
116 117 118 119 120 121 122 | Create second- and third-level headings, respectively. This is counting the article's title as the first-level header (even if the current article has no title). @defproc[(block [element xexpr?] ...) txexpr?] A container for content that should appear grouped together on larger displays. Intended for use in Series pages, where the template is very minimal. You would want output from | | | | 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 | Create second- and third-level headings, respectively. This is counting the article's title as the first-level header (even if the current article has no title). @defproc[(block [element xexpr?] ...) txexpr?] A container for content that should appear grouped together on larger displays. Intended for use in Series pages, where the template is very minimal. You would want output from @racket[listing<>-short/articles] to appear inside a @racket[block], but you would want output from @racket[listing<>-full/articles] to appear outside it (since each article effectively supplies its own block). Only relevant to HTML output. @deftogether[(@defproc[(link [link-id stringish?] [link-text xexpr?]) txexpr?] @defproc[(url [link-id stringish?] [url string?]) void?])] All hyperlinks are specified reference-style. So, to link some text, use the @code{link} tag with an identifier, which can be a string, symbol or number. Elsewhere in the text, use @code{url} with |
︙ | ︙ |
Modified crystalize.rkt from [013cbdf1] to [0c40f48a].
︙ | ︙ | |||
45 46 47 48 49 50 51 | ;; ~~~ Provides ~~~ (provide spell-of-summoning! crystalize-article! article-plain-title list/articles list/articles+notes | | | | | 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 | ;; ~~~ Provides ~~~ (provide spell-of-summoning! crystalize-article! article-plain-title list/articles list/articles+notes listing<>-short/articles listing<>-full/articles listing<>-full/articles+notes unfence preheat-series!) ;; ~~~ Private use ~~~ (define DBFILE (build-path (current-project-root) "vitreous.sqlite")) |
︙ | ︙ | |||
195 196 197 198 199 200 201 | (define select "SELECT `~a` FROM `articles` ~a ORDER BY `published` ~a LIMIT ~a") (query-list (sqltools:dbc) (format select type (where/series s) order limit))) ;; ~~~~ ;; Return cached HTML of articles and/or notes, fenced within a style txexpr to prevent it being ;; escaped by ->html. See also: definition of `unfence` | | | | | 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 | (define select "SELECT `~a` FROM `articles` ~a ORDER BY `published` ~a LIMIT ~a") (query-list (sqltools:dbc) (format select type (where/series s) order limit))) ;; ~~~~ ;; Return cached HTML of articles and/or notes, fenced within a style txexpr to prevent it being ;; escaped by ->html. See also: definition of `unfence` (define (listing<>-short/articles #:series [s #t] #:limit [limit -1] [order "DESC"]) `(style "<ul class=\"article-list\">" ,@(list/articles "listing_short_html" #:series s #:limit limit order) "</ul>")) (define (listing<>-full/articles #:series [s #t] #:limit [limit -1] [order "DESC"]) `(style ,@(list/articles "listing_full_html" #:series s #:limit limit order))) ;; Return a combined list of articles and notes (“full content” version) sorted by date (define (listing<>-full/articles+notes #:series [s #t] #:limit [limit -1] [order "DESC"]) `(style ,@(list/articles+notes "listing_full_html" #:series s #:limit limit order))) ;; Remove "<style>" and "</style>" introduced by using ->html on docs containing output from ;; listing functions (define (unfence html-str) (regexp-replace* #px"<[\\/]{0,1}style>" html-str "")) |
︙ | ︙ |