◊(Local Yarn Code "Check-in [68cbde30]")

Overview
Comment:Document invalidate-series
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA3-256: 68cbde30f1d724cc29f38922d15c1fb30f264f876da278baa0cbcc9e5b08fab9
User & Date: joel on 2019-04-27 20:00:50
Other Links: manifest | tags
Context
2019-04-30
19:20
Hack: make links relative while testing site in subfolder check-in: 2843e345 user: joel tags: trunk
2019-04-27
20:00
Document invalidate-series check-in: 68cbde30 user: joel tags: trunk
19:49
Add scribble tag for repo files check-in: 8b79fa0d user: joel tags: trunk
Changes

Modified code-docs/dust.scrbl from [31c02e8b] to [63fa6d30].

153
154
155
156
157
158
159














160
161
162
163
164
165
166
If @code{(current-metas)} has the key @racket['series], and if the corresponding series defines a meta
value for @racket['noun-singular], then return it, otherwise return @racket[""].

@defproc[(series-title) string?]

If @code{(current-metas)} has the key @racket['series], and if the corresponding series defines a meta
value for @racket['title], then return it, otherwise return @racket[""].















@defproc[(disposition-values [str string?]) any]

Given a string @racket[_str], returns two values: the portion of the string coming before the first
space, and the rest of the string.

@examples[#:eval dust-eval







>
>
>
>
>
>
>
>
>
>
>
>
>
>







153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
If @code{(current-metas)} has the key @racket['series], and if the corresponding series defines a meta
value for @racket['noun-singular], then return it, otherwise return @racket[""].

@defproc[(series-title) string?]

If @code{(current-metas)} has the key @racket['series], and if the corresponding series defines a meta
value for @racket['title], then return it, otherwise return @racket[""].

@defproc[(invalidate-series) (or/c void? boolean?)]

If the current article specifies a @racket['series] meta, and if a corresponding @filepath{.poly.pm}
file exists in @racket[series-folder], attempts to “touch” the last-modified timestamp on that file,
returning @racket[#t] on success or @racket[#f] on failure. If either precondition is not true,
returns @|void-const|.

When an article is being rendered, that means the article has changed, and if the article has
changed, its series page (if any) should be updated as well. Touching the @filepath{.poly.pm} file
for a series page triggers a re-render of that page when running @tt{make web} to rebuild the web
content (see @repo-file{makefile}).

Only used in one place, @repo-file{tags-html.rkt}.

@defproc[(disposition-values [str string?]) any]

Given a string @racket[_str], returns two values: the portion of the string coming before the first
space, and the rest of the string.

@examples[#:eval dust-eval