`waycast-web-image` - Make a Web image
waycast-web-image [<options>] <boundary path>
waycast-web-image -help | -?
- The `waycast-web-image` command makes a Web image delimited by the given boundary path,
which is the path of a single file or directory.
- It ensures that each Breccian source file stored at or under the boundary path
is accompanied by its image file, a sibling namesake with a `.xht` extension.
- It ensures that any waycast stored at or under the boundary path is properly imaged as such.
- Any image file that is missing is formed anew, any that is outdated is reformed.
- An image file is outdated unless it postdates both its source file
and all formal resources of the source file.
: re `formal resources` see `formalResources` @ non-fractal
http://reluk.ca/project/Breccia/Web/imager/ExternalResources.java :
Typically these are Breccian referent files.
- The working directory must be the command directory.
: see `^*working directory$` @ `^*shell commands$` @
http://reluk.ca/project/Java/editorial_guidelines.brec
- One positional argument is required:
<boundary path>
/ The path of a file or directory.
- Sets the bounds of the Web image: any Breccian source file stored at or under this path
is eligible for imaging unless explicitly excluded.
: re `explicitly excluded` see `^*-exclude`
- Any number of nominal arguments, aka options, may accompany the positional argument:
/ Nominal arguments may appear anywhere on the command line,
they need not precede the positional argument.
-author-home-directory: -author-home-directory=<file path>
: see @ http://reluk.ca/project/Breccia/Web/imager/bin/breccia-web-image.brec
-centre-column: -centre-column=<number>
: see @ http://reluk.ca/project/Breccia/Web/imager/bin/breccia-web-image.brec
-co-service-directory: -co-service-directory=<URI reference CS>
: see @ http://reluk.ca/project/Breccia/Web/imager/bin/breccia-web-image.brec
- The co-service directory must contain the following auxiliary files at a minimum.
: cf. @ http://reluk.ca/project/Breccia/Web/imager/bin/breccia-web-image.brec
style sheets: `<CS>/Breccia/Web/imager/image.css`
`<CS>/wayic/Web/imager/image.css`
- Typically each is a copy of the bundled sheet, or a custom sheet
that imports from a copy of the bundled sheet.
: re `bundled sheet` see http://reluk.ca/project/Breccia/Web/imager/image.css
: re `bundled sheet` see ../image.css
- Any resource files referred to by the style sheets must also be included.
For the bundled sheets, these are:
font files: `<CS>/Breccia/Web/imager/FairfaxHD.ttf`,
`<CS>/Breccia/Web/imager/FairfaxHD.woff2`
: see https://www.kreativekorp.com/software/fonts/fairfaxhd.shtml
-exclude: -exclude=<pattern>
: see @ http://reluk.ca/project/Breccia/Web/imager/bin/breccia-web-image.brec
-fake
: see @ http://reluk.ca/project/Breccia/Web/imager/bin/breccia-web-image.brec
-force
: see @ http://reluk.ca/project/Breccia/Web/imager/bin/breccia-web-image.brec
-glyph-test-font: -glyph-test-font=<file path> | none
: see @ http://reluk.ca/project/Breccia/Web/imager/bin/breccia-web-image.brec
-math
: see @ http://reluk.ca/project/Breccia/Web/imager/bin/breccia-web-image.brec
-reference-mapping: -reference-mapping=<translation> [|| <translation>] ...
: see @ http://reluk.ca/project/Breccia/Web/imager/bin/breccia-web-image.brec
-speak
: see @ http://reluk.ca/project/Breccia/Web/imager/bin/breccia-web-image.brec
-stifle
: see @ http://reluk.ca/project/Breccia/Web/imager/bin/breccia-web-image.brec
-verbosity: -verbosity=0|1|2
: see @ http://reluk.ca/project/Breccia/Web/imager/bin/breccia-web-image.brec
━━━━━
Bug
─────
- Parallel runs of `waycast-web-image` by the same user may lead to unexpected results.
: see `^*- Parallel runs` @ `^+Bug` @
http://reluk.ca/project/Breccia/Web/imager/bin/breccia-web-image.brec
━━━━━━━━━━
See also
──────────
• Working examples
: e.g. `^*testing$` @ http://reluk.ca/project/wayic/Web/imager/notes.brec
: e.g. http://reluk.ca/sys/bin/publish-files
: e.g. http://reluk.ca/sys/bin/test-image
• The `breccia-web-image` command
: see http://reluk.ca/project/Breccia/Web/imager/bin/breccia-web-image.brec
/ Appropriate only for a boundary path that includes no waycast.
\ Copyright © 2020-2023 Michael Allan. Licence MIT.