@allyhub/sdk 0.15.3 → 0.17.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +17 -0
- package/dist/node_modules/@allyhub/audio/dist/index.d.ts +1 -0
- package/dist/node_modules/@allyhub/audio/dist/index.js +1 -1
- package/dist/node_modules/@allyhub/audio/dist/place.d.ts +26 -0
- package/dist/node_modules/@allyhub/audio/dist/place.js +2 -0
- package/dist/node_modules/@allyhub/audio/package.json +1 -1
- package/dist/node_modules/@allyhub/chart/package.json +1 -1
- package/dist/node_modules/@allyhub/diagnostics/package.json +1 -1
- package/dist/node_modules/@allyhub/formats/dist/data/slides.d.ts +15 -3
- package/dist/node_modules/@allyhub/formats/dist/data/slides.js +1 -1
- package/dist/node_modules/@allyhub/formats/dist/data/website.js +1 -1
- package/dist/node_modules/@allyhub/formats/dist/items.d.ts +70 -11
- package/dist/node_modules/@allyhub/formats/dist/items.js +1 -1
- package/dist/node_modules/@allyhub/formats/dist/layout.d.ts +15 -4
- package/dist/node_modules/@allyhub/formats/dist/layout.js +1 -1
- package/dist/node_modules/@allyhub/formats/dist/schemas.d.ts +4 -0
- package/dist/node_modules/@allyhub/formats/package.json +1 -1
- package/dist/node_modules/@allyhub/image-draw/dist/stage.js +1 -1
- package/dist/node_modules/@allyhub/image-draw/package.json +1 -1
- package/dist/node_modules/@allyhub/image-measure/package.json +1 -1
- package/dist/node_modules/@allyhub/image-sdk/package.json +1 -1
- package/dist/node_modules/@allyhub/measure/package.json +1 -1
- package/dist/node_modules/@allyhub/ooxml/package.json +1 -1
- package/dist/node_modules/@allyhub/piece/dist/layer.d.ts +15 -0
- package/dist/node_modules/@allyhub/piece/dist/page/index.d.ts +1 -0
- package/dist/node_modules/@allyhub/piece/dist/page/index.js +1 -1
- package/dist/node_modules/@allyhub/piece/dist/page/runtimes.d.ts +9 -0
- package/dist/node_modules/@allyhub/piece/dist/page/runtimes.js +2 -0
- package/dist/node_modules/@allyhub/piece/dist/source.d.ts +53 -10
- package/dist/node_modules/@allyhub/piece/dist/source.js +1 -1
- package/dist/node_modules/@allyhub/piece/package.json +1 -1
- package/dist/node_modules/@allyhub/protocol/dist/account.d.ts +10 -11
- package/dist/node_modules/@allyhub/protocol/dist/account.js +1 -1
- package/dist/node_modules/@allyhub/protocol/dist/auth.d.ts +7 -0
- package/dist/node_modules/@allyhub/protocol/dist/auth.js +1 -1
- package/dist/node_modules/@allyhub/protocol/dist/blobs.d.ts +9 -0
- package/dist/node_modules/@allyhub/protocol/dist/blobs.js +1 -1
- package/dist/node_modules/@allyhub/protocol/dist/cli.d.ts +2 -0
- package/dist/node_modules/@allyhub/protocol/dist/cli.js +1 -1
- package/dist/node_modules/@allyhub/protocol/dist/cloud-computer.d.ts +77 -0
- package/dist/node_modules/@allyhub/protocol/dist/cloud-computer.js +2 -0
- package/dist/node_modules/@allyhub/protocol/dist/cloud.d.ts +39 -9
- package/dist/node_modules/@allyhub/protocol/dist/cloud.js +1 -1
- package/dist/node_modules/@allyhub/protocol/dist/editor.d.ts +15 -15
- package/dist/node_modules/@allyhub/protocol/dist/events.d.ts +441 -5
- package/dist/node_modules/@allyhub/protocol/dist/events.js +1 -1
- package/dist/node_modules/@allyhub/protocol/dist/files.d.ts +2 -2
- package/dist/node_modules/@allyhub/protocol/dist/frame.d.ts +4 -1
- package/dist/node_modules/@allyhub/protocol/dist/frame.js +1 -1
- package/dist/node_modules/@allyhub/protocol/dist/index.d.ts +8 -0
- package/dist/node_modules/@allyhub/protocol/dist/index.js +1 -1
- package/dist/node_modules/@allyhub/protocol/dist/jobs.d.ts +5 -5
- package/dist/node_modules/@allyhub/protocol/dist/kinds.d.ts +45 -0
- package/dist/node_modules/@allyhub/protocol/dist/kinds.js +1 -1
- package/dist/node_modules/@allyhub/protocol/dist/paywall.d.ts +134 -0
- package/dist/node_modules/@allyhub/protocol/dist/paywall.js +2 -0
- package/dist/node_modules/@allyhub/protocol/dist/place.js +1 -1
- package/dist/node_modules/@allyhub/protocol/dist/presence.d.ts +3 -3
- package/dist/node_modules/@allyhub/protocol/dist/purposes.d.ts +47 -0
- package/dist/node_modules/@allyhub/protocol/dist/purposes.js +2 -0
- package/dist/node_modules/@allyhub/protocol/dist/routes.js +1 -1
- package/dist/node_modules/@allyhub/protocol/dist/shares.d.ts +52 -5
- package/dist/node_modules/@allyhub/protocol/dist/shares.js +1 -1
- package/dist/node_modules/@allyhub/protocol/dist/sidebar-deletion.d.ts +34 -0
- package/dist/node_modules/@allyhub/protocol/dist/sidebar-deletion.js +2 -0
- package/dist/node_modules/@allyhub/protocol/dist/sites.d.ts +1 -0
- package/dist/node_modules/@allyhub/protocol/dist/snapshots.d.ts +21 -52
- package/dist/node_modules/@allyhub/protocol/dist/snapshots.js +1 -1
- package/dist/node_modules/@allyhub/protocol/dist/studio-server.d.ts +264 -0
- package/dist/node_modules/@allyhub/protocol/dist/studio-server.js +2 -0
- package/dist/node_modules/@allyhub/protocol/dist/studio-tool-calls.d.ts +18 -0
- package/dist/node_modules/@allyhub/protocol/dist/studio-tool-calls.js +2 -0
- package/dist/node_modules/@allyhub/protocol/dist/studio-window-requests.d.ts +97 -0
- package/dist/node_modules/@allyhub/protocol/dist/studio-window-requests.js +2 -0
- package/dist/node_modules/@allyhub/protocol/dist/teams.d.ts +3 -2
- package/dist/node_modules/@allyhub/protocol/dist/teams.js +1 -1
- package/dist/node_modules/@allyhub/protocol/dist/tools.d.ts +26 -20
- package/dist/node_modules/@allyhub/protocol/dist/tools.js +1 -1
- package/dist/node_modules/@allyhub/protocol/dist/turns.d.ts +71 -0
- package/dist/node_modules/@allyhub/protocol/dist/turns.js +2 -0
- package/dist/node_modules/@allyhub/protocol/package.json +1 -1
- package/dist/node_modules/@allyhub/runtimes/package.json +1 -1
- package/dist/node_modules/@allyhub/scenery/package.json +1 -1
- package/dist/node_modules/@allyhub/sheet/dist/calc/coerce.js +1 -1
- package/dist/node_modules/@allyhub/sheet/dist/calc/engine.d.ts +12 -0
- package/dist/node_modules/@allyhub/sheet/dist/calc/engine.js +1 -1
- package/dist/node_modules/@allyhub/sheet/dist/calc/functions/criteria.js +1 -1
- package/dist/node_modules/@allyhub/sheet/dist/calc/functions/date.js +1 -1
- package/dist/node_modules/@allyhub/sheet/dist/calc/functions/dynamic.js +1 -1
- package/dist/node_modules/@allyhub/sheet/dist/calc/functions/info.js +1 -1
- package/dist/node_modules/@allyhub/sheet/dist/calc/functions/logical.js +1 -1
- package/dist/node_modules/@allyhub/sheet/dist/calc/functions/lookup.js +1 -1
- package/dist/node_modules/@allyhub/sheet/dist/calc/functions/text.js +1 -1
- package/dist/node_modules/@allyhub/sheet/dist/formula/parse.js +1 -1
- package/dist/node_modules/@allyhub/sheet/dist/xlsx/charts.d.ts +1 -1
- package/dist/node_modules/@allyhub/sheet/dist/xlsx/charts.js +1 -1
- package/dist/node_modules/@allyhub/sheet/dist/xlsx/import.js +1 -1
- package/dist/node_modules/@allyhub/sheet/dist/xlsx/read.js +2 -2
- package/dist/node_modules/@allyhub/sheet/dist/xlsx/write.js +1 -1
- package/dist/node_modules/@allyhub/sheet/package.json +1 -1
- package/dist/node_modules/@allyhub/slides-core/dist/animation.d.ts +10 -0
- package/dist/node_modules/@allyhub/slides-core/dist/animation.js +1 -1
- package/dist/node_modules/@allyhub/slides-core/dist/api.js +1 -1
- package/dist/node_modules/@allyhub/slides-core/dist/components.js +1 -1
- package/dist/node_modules/@allyhub/slides-core/dist/model.d.ts +3 -1
- package/dist/node_modules/@allyhub/slides-core/dist/resolve.d.ts +5 -0
- package/dist/node_modules/@allyhub/slides-core/dist/resolve.js +1 -1
- package/dist/node_modules/@allyhub/slides-core/package.json +1 -1
- package/dist/node_modules/@allyhub/video-core/package.json +1 -1
- package/dist/node_modules/@allyhub/video-sdk/dist/free.d.ts +1 -1
- package/dist/node_modules/@allyhub/video-sdk/package.json +1 -1
- package/docs/batches.md +4 -4
- package/docs/contract.md +5 -5
- package/docs/defaults.md +2 -2
- package/docs/docs.md +16 -5
- package/docs/footage.md +8 -8
- package/docs/image.md +5 -5
- package/docs/layers.md +12 -10
- package/docs/linkedin.md +1 -1
- package/docs/modeling.md +3 -3
- package/docs/pictures.md +4 -4
- package/docs/project.md +11 -7
- package/docs/scenery.md +3 -3
- package/docs/sheets.md +5 -5
- package/docs/slides.md +3 -3
- package/docs/sound.md +7 -7
- package/docs/speech.md +7 -7
- package/docs/video.md +3 -3
- package/docs/websites.md +3 -3
- package/docs/x.md +2 -2
- package/package.json +1 -1
package/docs/docs.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Docs
|
|
2
2
|
|
|
3
|
-
A doc is prose a person reads and edits as a page and an agent writes as text: one MDX file, listed in `allyhub.yaml` as `kind: doc` ([project.md](project.md#items)). It is not a piece: it has no format, languages or combos. `allyhub check` checks it, `allyhub frames` draws its pages as they print, `allyhub dev` shows it in its editor (its Pages beside the text, as they print), `allyhub inspect pages` measures its pages, `allyhub render` prints it. Beside prose it holds charts drawn from numbers (`<Chart>`), equations and diagrams (```` ```math ````, ```` ```mermaid ````), and a picture made by code is a component placed in it (`<Component>`)
|
|
3
|
+
A doc is prose a person reads and edits as a page and an agent writes as text: one MDX file, listed in `allyhub.yaml` as `kind: doc` ([project.md](project.md#items)). It is not a piece: it has no format, languages or combos. `allyhub check` checks it, `allyhub frames` draws its pages as they print, `allyhub dev` shows it in its editor (its Pages beside the text, as they print), `allyhub inspect pages` measures its pages, `allyhub render` prints it. Beside prose it holds charts drawn from numbers (`<Chart>`), equations and diagrams (```` ```math ````, ```` ```mermaid ````), and a picture made by code is a component placed in it (`<Component>`). Its front matter sets how the whole page looks.
|
|
4
4
|
|
|
5
5
|
## A doc item
|
|
6
6
|
|
|
@@ -28,7 +28,7 @@ It is the PDF's title, and the doc's name where people see it unless `allyhub.ya
|
|
|
28
28
|
|
|
29
29
|
## What a doc reads
|
|
30
30
|
|
|
31
|
-
The file is MDX: Markdown with GFM tables, strike-through and task lists, plus tags and `import` lines.
|
|
31
|
+
The file is MDX: Markdown with GFM tables, strike-through and task lists, plus tags and `import` lines. Write a link as `[text](https://…)`; a bare address stays text. `*`, `_`, `[` and `<` are Markdown's marks as CommonMark reads them: a blank to fill in written `[__]` twice in a paragraph makes the words between the two bold; write `\_\_` (or `[ ]`) for one.
|
|
32
32
|
|
|
33
33
|
| Written | Block |
|
|
34
34
|
| --- | --- |
|
|
@@ -61,6 +61,7 @@ Tags with plain string attributes (`name="value"`, or the bare name for `toggle`
|
|
|
61
61
|
| `<Callout icon color bg>` | A line set apart in a box, with `icon` before it when given (none when absent). Inside it: the line, then the blocks under it |
|
|
62
62
|
| `<img src alt title width align id />` | A picture with a width in px or a place (`align`: `center` or `right`); `title` is its caption, `id` what a reference names it by. Without those, write `` |
|
|
63
63
|
| `<Table widths head caption id>` around one GFM table | Column widths in px, comma-separated, an empty entry for a column that shares what is left by its content (`widths="120,,200"`); `head` is `row` (the default), `column`, `both` or `none`; `caption` is set over it, `id` is what a reference names it by |
|
|
64
|
+
| `<Table data fields widths head caption id />` | A table whose rows a project file holds, from the doc's folder: a sheet's table (`../../sales/sales.yaml#Regions`, computed as the sheet computes it), a CSV, or a YAML or JSON file of rows. A row of the file is a row, under a head row of its columns' names, each value as its source shows it (a sheet's number formats); `fields` its columns in their order, comma-separated (default all of them). The editor draws it and its cells are changed where they come from; the PDF, Word and Markdown hold its rows. A file it cannot read, or a column it does not have, is AK-M008 at its line |
|
|
64
65
|
| `<Chart type …>` around one GFM table, or `<Chart type data … />` | A chart drawn from numbers ([below](#charts)) |
|
|
65
66
|
| `<Columns>` around two or more `<Column width>` | Blocks side by side ([below](#columns)) |
|
|
66
67
|
| `<Card title subtitle>` | Blocks in a card: a hairline border, rounded, its title bold and its `subtitle` quieter over the blocks inside it. Word draws it as a table of one cell, its corners square (Word's borders have none) |
|
|
@@ -222,7 +223,7 @@ flowchart LR
|
|
|
222
223
|
```
|
|
223
224
|
````
|
|
224
225
|
|
|
225
|
-
The editor, the PDF and a picture draw them; Word holds each as a picture; Markdown keeps the code block, which GitHub draws too. A diagram is laid out by dagre,
|
|
226
|
+
The editor, the PDF and a picture draw them; Word holds each as a picture; Markdown keeps the code block, which GitHub draws too. A diagram is laid out by dagre, which keeps a diagram of groups narrow enough for its words to read on the page; a diagram whose config asks for ELK (`---` `config: { layout: elk }` `---` over it) gets it, its boxes in the order they are written. A diagram is drawn at its own size and made smaller to fit the column: `allyhub inspect pages` says, for each diagram and component, how much of its own size the page shows, a diagram's words in pt, and how many times a component's lines cross where it draws them with `connector` (`page-picture`). TeX that KaTeX cannot read is AK-M008 at its line. Write an equation as a `math` block.
|
|
226
227
|
|
|
227
228
|
### Components
|
|
228
229
|
|
|
@@ -241,6 +242,16 @@ A figure drawn by code is a component (`defineComponent`, [layers.md](layers.md#
|
|
|
241
242
|
| `align` | `center` or `right` |
|
|
242
243
|
| any other | A prop, read by its type: a `number()` from its digits, a `boolean()` from `true` or `false`, a `list()` or `object()` from JSON, anything else as written |
|
|
243
244
|
|
|
245
|
+
Another item of the project, a deck's slide or a video's moment, is placed with `<Item>`: drawn by its own kind, fitted to the frame, in the doc's language where it has it.
|
|
246
|
+
|
|
247
|
+
```mdx
|
|
248
|
+
<Item of="../../launch/deck.ts#pricing" width="640" height="360" title="Pricing, from the launch deck" />
|
|
249
|
+
|
|
250
|
+
<Item of="../../launch/teaser.ts#demo" at="1.5" alt="The demo part of the teaser" />
|
|
251
|
+
```
|
|
252
|
+
|
|
253
|
+
`of` is the item's entry from the doc's folder, and after `#` a part of it: a deck's slide, by its id or its place from 1; a video's part. `at` is seconds into that part (default its still, a slide as it settles; with no part, seconds into the item). `width`, `height`, `alt`, `title`, `align` and `id` are a component's; an item has no props. The editor draws it live; the PDF, Word and a read view show a still of it, as a component's. `allyhub inspect uses` lists it; a part the item does not have is said where it is drawn, and an item that uses the doc back is AK-M016.
|
|
254
|
+
|
|
244
255
|
It is drawn as a slide's component is, with the project's look (`var(--ak-color-*)`, `var(--ak-font-*)`, and the look's theme as `var(--ak-theme-*)`), its fonts and files. The editor draws it live, its props a field each when it is clicked; the PDF, Word and a read view show a still of it, drawn once and kept by what it shows. A wrong module, export or prop is AK-M008 at its line; an exception in its code is AK-R001.
|
|
245
256
|
|
|
246
257
|
### Kept as written
|
|
@@ -304,6 +315,6 @@ Without front matter the page is Letter, sans, with the default accent and no co
|
|
|
304
315
|
## Check and render
|
|
305
316
|
|
|
306
317
|
- `allyhub check` reports AK-M008 for a doc whose file is not MDX, that holds what a doc does not draw (`{…}`, a tag inside a line other than the marks above, a wrong attribute or value), that shows a picture which is not in the project, that names a component which is not one or a prop it does not have, whose chart cannot be drawn from its numbers or whose equation is not TeX KaTeX reads, that cites a source its bibliography does not hold (or names a bibliography that is not CSL-JSON in the project); each problem has its file and line.
|
|
307
|
-
- `allyhub inspect pages <doc>` measures its pages as `allyhub render` prints them, from the PDF itself, and says the facts with their raw numbers (mm on the paper, each block by its line in the doc's file): the space left at each page's foot, each block broken over pages with its lines (a table's rows) on each and whether its head repeats, a heading near a page's foot with the lines after it on its page, a paragraph's short last line, content past the column and what is cut at the paper's edge, a line that starts or ends with a mark Chinese type keeps off it, each numbered figure's page and the pages that name it, the text as a grid, and whether the contents' page numbers held. It draws the pages too, each block outlined and labelled by its line, the space at each foot shaded (`.allyhub/work/inspect/<place>/pages.webp`). They are facts
|
|
318
|
+
- `allyhub inspect pages <doc>` measures its pages as `allyhub render` prints them, from the PDF itself, and says the facts with their raw numbers (mm on the paper, each block by its line in the doc's file): the space left at each page's foot, each block broken over pages with its lines (a table's rows) on each and whether its head repeats, a heading near a page's foot with the lines after it on its page, a paragraph's short last line, content past the column and what is cut at the paper's edge, a line that starts or ends with a mark Chinese type keeps off it, each numbered figure's page and the pages that name it, the text as a grid, and whether the contents' page numbers held. It draws the pages too, each block outlined and labelled by its line, the space at each foot shaded (`.allyhub/work/inspect/<place>/pages.webp`). They are facts: where a page breaks well is yours to judge. `--heading-lines` and `--short-line` say what is listed, `--all` lists every heading and last line.
|
|
308
319
|
- `allyhub frames <doc>` draws its pages as `allyhub render` prints them, its components drawn first (the PDF printed and thrown away, each page drawn), tiled on one picture under `.allyhub/work/frames/<place>/`, and says how many pages there are and on what paper; `--page 2-3` draws those pages large. It is how to look at a doc and fit it to a length, and nothing is written to `.allyhub/out/`.
|
|
309
|
-
- `allyhub render` prints each doc under `.allyhub/out/`, by its id, as `plan.pdf`; `--type png` writes a picture of the whole page (`plan.png`), `--type docx` a Word document (`plan.docx`: its text and its charts editable, a picture Word cannot show as a JPEG, an equation and a diagram as pictures), and `--type pdf,docx,png` all of them.
|
|
320
|
+
- `allyhub render` prints each doc under `.allyhub/out/`, by its id, as `plan.pdf`; `--type png` writes a picture of the whole page (`plan.png`), `--type docx` a Word document (`plan.docx`: its text and its charts editable, a picture Word cannot show as a JPEG, an equation and a diagram as pictures), and `--type pdf,docx,png` all of them. Its Markdown is the doc's MDX itself. With a PDF or a Word document it says how the pages printed: how many, the share of each page's text area left empty at its foot, the blocks broken over pages (a Word document alone is printed once to measure it); `allyhub inspect pages` has every fact. A doc with a problem is not rendered: the command fails and says why. `allyhub help render` has every option.
|
package/docs/footage.md
CHANGED
|
@@ -57,7 +57,7 @@ export default video({
|
|
|
57
57
|
## The file
|
|
58
58
|
|
|
59
59
|
- **A file**: an import (`import clip from "./clip.mp4"`) or a path. A path is relative to the folder of the module that wrote the `footage()` call, also once its part is spread into another piece ([project.md](project.md)).
|
|
60
|
-
- **No file**: the part's take, in sync with its speech, following its cut list. A part with no take is AK-A001; a take that is not a video is AK-A003. A take
|
|
60
|
+
- **No file**: the part's take, in sync with its speech, following its cut list. A part with no take is AK-A001; a take that is not a video is AK-A003. A take shows its own picture at its own speed (`part()` throws for one played at another, `take(…).speed(1.2)`).
|
|
61
61
|
- **A video item**: an imported `video()` of the project ([below](#a-video-item-as-footage)).
|
|
62
62
|
- A still (PNG, JPEG, WebP, AVIF, GIF or SVG) is drawn as `picture()` draws it ([pictures.md](pictures.md#footage-of-a-still)). Any other file that is not a video (mp4, webm or mov) is AK-A003; a file that is not there AK-A001.
|
|
63
63
|
- When the layer lasts longer than the file, its last frame holds; before a take's file starts (speech in the lead), its first frame holds. A video with alpha (ProRes 4444, VP9 with alpha) shows what is under its transparent pixels.
|
|
@@ -93,8 +93,8 @@ Besides `at`, `until` and `dur` (word references or seconds; default the whole p
|
|
|
93
93
|
`box` as `BoxKey[]`: `[{ t, box, ease? }]`, `t` a word reference or seconds, `box` a rectangle or `"full"`, `ease` the move into that key (`"linear"`, `"in"`, `"out"`, `"in-out"`; default `"linear"`).
|
|
94
94
|
|
|
95
95
|
- The picture keeps its shape in every box, fitted as `fit` says: a box that changes shape shows more or less of it, never a stretched one.
|
|
96
|
-
- Every key lies inside the frame
|
|
97
|
-
- A keyframed box
|
|
96
|
+
- Every key lies inside the frame (`footage()` throws for one past it); a push-in larger than the frame is a punch-in.
|
|
97
|
+
- A keyframed box moves the picture by its keys; `reframe`, `punchIn` and `pullback` go on a fixed box (`footage()` throws otherwise).
|
|
98
98
|
|
|
99
99
|
### Punch-ins and the pullback
|
|
100
100
|
|
|
@@ -149,7 +149,7 @@ export const backgrounds = [
|
|
|
149
149
|
|
|
150
150
|
## The preview and the render
|
|
151
151
|
|
|
152
|
-
The render and stills draw footage with ffmpeg, the exact frame of the file for every frame. The live preview plays each footage layer as a muted `<video>` kept to the clock, placed by the same plan
|
|
152
|
+
The render and stills draw footage with ffmpeg, the exact frame of the file for every frame. The live preview plays each footage layer as a muted `<video>` kept to the clock, placed by the same plan, with `sharpen` off and a quicker `background` (its blur over the whole picture, a coarser matte edge). `allyhub frames` draws as the render does, `sharpen` and `background` included.
|
|
153
153
|
|
|
154
154
|
## A video item as footage
|
|
155
155
|
|
|
@@ -189,10 +189,10 @@ export default video({
|
|
|
189
189
|
});
|
|
190
190
|
```
|
|
191
191
|
|
|
192
|
-
- `footage(videoItem, opts)` takes `at`, `until`, `dur`, `from` (its own moment at the layer's start: seconds, an anchor of one of its parts such as `"@turn"`, or a part's key), `speed` (over 0, up to 16), `box` and `fit`, `audio` and `gainDb` (its speech, room and sound effects; at speed 1 only), `camera` and `cameras` (the camera its scenery layers are drawn from, on its clock: one for all, or by layer name), and `quality: { scale }` (how finely its scenery layers are drawn here, over 0 up to 4, as `scenery()`'s; [scenery.md](scenery.md)). `crop`, `reframe`, `speaker`, `punchIn`, `pullback`, `sharpen`, `background`, `shape` and `radius` throw.
|
|
193
|
-
- It draws
|
|
192
|
+
- `footage(videoItem, opts)` takes `at`, `until`, `dur`, `from` (its own moment at the layer's start: seconds, an anchor of one of its parts such as `"@turn"`, or a part's key), `speed` (over 0, up to 16), `box` and `fit`, `audio` and `gainDb` (its speech, room and sound effects; at speed 1 only), `camera` and `cameras` (the camera its scenery layers are drawn from, on its clock: one for all, or by layer name), and `quality: { scale }` (how finely its scenery layers are drawn here, over 0 up to 4, as `scenery()`'s; [scenery.md](scenery.md)). `crop`, `reframe`, `speaker`, `punchIn`, `pullback`, `sharpen`, `background`, `shape` and `radius` are a file's options (here they throw).
|
|
193
|
+
- It draws the item's graphic layers, so the item shown is one made of graphic layers (one with footage of its own stops the load, saying so).
|
|
194
194
|
- What it reads counts as the outer video's, so the part cache and the check follow it. A video that reaches itself through the videos it shows is AK-M010.
|
|
195
|
-
- `deliverable: false` marks a video
|
|
195
|
+
- `deliverable: false` marks a video shown inside others: it is rendered as a film of its own when named.
|
|
196
196
|
- `take(videoItem).range(from, to)` makes a part that plays a stretch of it, hearing its sound and saying its words; `footage()` without a file in that part draws its picture in sync ([speech.md](speech.md)).
|
|
197
197
|
- `ctx.video(videoItem, el)` draws it in an element of a layer and resolves to an `EmbeddedVideo` (`{ id, duration, width, height, seek(t, layout?), at(ref) }`); seek it from `render` through `ctx.wait`:
|
|
198
198
|
|
|
@@ -245,5 +245,5 @@ export default video({
|
|
|
245
245
|
```
|
|
246
246
|
|
|
247
247
|
- `align` also prints the drift as a line, offset(t) = at0 + slope × t, and the speed (1 + slope) that keeps the camera in step; and, in its JSON, `pictureOffset`: the offset for the camera's picture when its file's sound starts later on its own clock.
|
|
248
|
-
-
|
|
248
|
+
- A take's own footage follows its cut list: to cut a separate camera with it, make the two one file first.
|
|
249
249
|
- `allyhub frames cuts` draws a review sheet per cut (a cut take's jumps, part joins) to look at the result.
|
package/docs/image.md
CHANGED
|
@@ -77,7 +77,7 @@ A picture a board starts from is never changed: a pixel edit (a matte, a part re
|
|
|
77
77
|
|
|
78
78
|
- **Every layer has a `key`**, unique on its board (AK-I003 without one, AK-I002 twice). The stage marks its element with it (`data-ak-layer`), and the facts name it: a layer of one key on several boards is compared across them.
|
|
79
79
|
- **`fromPicture(src)`** is a still picture's size as `size` takes it (`"4032x3024"`): a board that starts from a photo, the photo its bottom layer. A picture whose size is not known, or a video, is AK-I001.
|
|
80
|
-
- **An image
|
|
80
|
+
- **An image's stage has the neutral look**: its variables (`--ak-font-display`, `--ak-color-bg`…) are the defaults; bring a brand's colours and fonts into its components.
|
|
81
81
|
- **`ctx.dims` is the board's own** in a layer: its width and height (its safe zone covers no edge).
|
|
82
82
|
- **`height: "auto"`**: the layers are laid out at the board's width and `minHeight`, the furthest their content reaches down is measured (each layer element's scroll height), and the board is laid out again that tall, at most `maxHeight`. Lay such a board out in flow; a `picture()` box is a share of the final height.
|
|
83
83
|
|
|
@@ -110,11 +110,11 @@ A board's layers follow Photoshop's model: the names of its scripting model (UXP
|
|
|
110
110
|
| `transform` | `{ rotation, flipH, flipV }` | none | Turned (degrees, clockwise) and flipped about its box's centre |
|
|
111
111
|
| `visible` | `boolean` | `true` | `false`: not drawn, nor measured |
|
|
112
112
|
|
|
113
|
-
These are layer options
|
|
113
|
+
These are layer options, so a component's props take other names. Every default is in [defaults.md](defaults.md).
|
|
114
114
|
|
|
115
115
|
### Drawn by Chrome, or refused
|
|
116
116
|
|
|
117
|
-
Each field is drawn by CSS and SVG filters in the pinned Chrome, the same every time (AK-D002 checks it).
|
|
117
|
+
Each field is drawn by CSS and SVG filters in the pinned Chrome, the same every time (AK-D002 checks it). Each field is drawn exactly, or reported as AK-I007 with why.
|
|
118
118
|
|
|
119
119
|
- **Blend modes** are `mix-blend-mode`, whose formulas are the W3C Compositing spec's, taken from Adobe's PDF Reference: `normal`, `darken`, `multiply`, `colorBurn`, `lighten`, `screen`, `colorDodge`, `overlay`, `softLight`, `hardLight`, `difference`, `exclusion`, `hue`, `saturation`, `color`, `luminosity`; a group's `passThrough` makes no group of its own. Refused: `dissolve` (random), `darkerColor` and `lighterColor` (a whole pixel chosen by luminance), `linearDodge` (CSS's `plus-lighter` differs wherever the layer is not opaque), `linearBurn`, `vividLight`, `linearLight`, `pinLight`, `hardMix`, `subtract` and `divide` (no CSS mode, and a layer's filter cannot read what is under it). A `fillOpacity` under 100 with `colorBurn`, `colorDodge` or `difference` (Photoshop applies it inside the blend), an adjustment's blend other than `normal`, and a `passThrough` group that fades, is masked or has effects while one of its layers is an adjustment or blends otherwise are refused too.
|
|
120
120
|
- **Effects and fill opacity** are one SVG filter on the layer, bottom to top: the drop shadow and the outer glow under what it shows (knocked out under it), then the pattern, gradient and colour overlays, the satin, the inner glow, the inner shadow and the bevel over it, each cut to its pixels. `size` is a blur's radius (twice the Gaussian's standard deviation), `spread` and `choke` divide its alpha by 1 − them, the light's `angle` is Photoshop's (counter-clockwise from the right). An effect under the layer blends as `normal` (or as `multiply` or `darken` in black, `screen` or `lighten` in white, which are the same); the bevel is the smooth inner bevel (feDiffuseLighting); the stroke is a type layer's glyphs' (outside or about them) or a shape's path's (inside, about or outside it), with neither an inner effect nor a `fillOpacity` under 100 beside it. A gradient's `angle` and `diamond` styles are refused on an overlay and on a shape (SVG has no such gradient); a fill layer draws `angle` as CSS's conic gradient.
|
|
@@ -134,7 +134,7 @@ boards:
|
|
|
134
134
|
|
|
135
135
|
## What a person asks for
|
|
136
136
|
|
|
137
|
-
An image's viewer shows every board of every version, each drawn live, to zoom, pan, mark up and
|
|
137
|
+
An image's viewer shows every board of every version, each drawn live, to zoom, pan, mark up and download; it changes nothing. A person who wants something changed marks it up: the mark reaches you with each layer under it (its key, the line of the module that names it, its words, its picture) and the mark as a region of the layer's pixels, the board's and a picture's own file's (which `allyhub ai-media edit-image` takes as its mask). You make the change in the module, or its script for words, and the viewer draws it.
|
|
138
138
|
|
|
139
139
|
## Check, frames, inspect and render
|
|
140
140
|
|
|
@@ -159,7 +159,7 @@ An image's viewer shows every board of every version, each drawn live, to zoom,
|
|
|
159
159
|
| a component | a smart object holding its pixels as drawn; its code and props are not in the file |
|
|
160
160
|
| `group()` | a group, `passThrough` unless it says otherwise |
|
|
161
161
|
|
|
162
|
-
The pixels of a layer are drawn by Chrome alone, without what Photoshop applies itself (blend, opacity, mask, effects, clipping), so Photoshop draws effects, blends and adjustments by its own formulas: where it publishes none (Hue/Saturation, Vibrance, Color Balance, Black & White, Photo Filter, Brightness/Contrast) or draws its own way (layer styles, a mask's feather, text), the
|
|
162
|
+
The pixels of a layer are drawn by Chrome alone, without what Photoshop applies itself (blend, opacity, mask, effects, clipping), so Photoshop draws effects, blends and adjustments by its own formulas: where it publishes none (Hue/Saturation, Vibrance, Color Balance, Black & White, Photo Filter, Brightness/Contrast) or draws its own way (layer styles, a mask's feather, text), Photoshop shows the layer by its own formulas. `render` names each such layer (`fidelity` in `--json`: `approximate`, `pixels` or `omitted`). The same board writes the same bytes.
|
|
163
163
|
|
|
164
164
|
`allyhub image import <file.psd> --to <module>.ts` makes an image of a Photoshop file, named after its module: `<name>.ts`, which names `<name>.{locale}.yaml` for its script; a board an artboard (else its canvas), each layer of its kind with its fields, a pixel layer's pixels beside the module (`<board>-<layer>.png`), a type layer's words in the script (`<name>.<lang>.yaml`), each layer's key its PSD name in lower case with hyphens, the name itself a comment beside it where it is not the key (a PSD exported names its layers by their keys); the file as it was beside them. A picture or the file as it was takes a name no file there has; the import never writes over a file that is there. What AllyHub does not hold or refuses (AK-I007) is kept as pixels where the layer has them, drawn near (a blend mode as normal, a type layer by CSS), or left out, and the command lists every one. A smart object comes in as its pixels.
|
|
165
165
|
|
package/docs/layers.md
CHANGED
|
@@ -128,7 +128,7 @@ export const teams = part({
|
|
|
128
128
|
| `mount(el, props, ctx)` | Lays the layer out once: builds its elements, may measure text |
|
|
129
129
|
| `render(el, t, props, ctx)` | Sets everything that moves from `t` alone |
|
|
130
130
|
|
|
131
|
-
`at`, `until`, `dur` and `z` are the layer's options (`LAYER_OPTIONS`)
|
|
131
|
+
`at`, `until`, `dur` and `z` are the layer's options (`LAYER_OPTIONS`), so props take other names (`defineComponent` throws on these). A layer's length and still belong to its part.
|
|
132
132
|
|
|
133
133
|
### Layers in a frame
|
|
134
134
|
|
|
@@ -175,16 +175,16 @@ A prop declared `time()` (also inside `list()` and `object()`) is typed `Time` i
|
|
|
175
175
|
|
|
176
176
|
### `mount` and `render`
|
|
177
177
|
|
|
178
|
-
- `mount` runs once for each element a layer is drawn into, before any `render` of it: once per part that lists it, and again for a cover. Keep what `render` needs on the element (find it again with `one`, or a `WeakMap` keyed by `el`)
|
|
179
|
-
- `render(el, t, …)` gets `t`, seconds from the part's start, and runs only between the layer's `at` and `until`: an entrance counts from `ctx.layer.start`. It sets every moving property from `t` alone,
|
|
178
|
+
- `mount` runs once for each element a layer is drawn into, before any `render` of it: once per part that lists it, and again for a cover. Keep what `render` needs on the element itself (find it again with `one`, or a `WeakMap` keyed by `el`). The fonts the look and the text need have loaded by then, so it may measure.
|
|
179
|
+
- `render(el, t, …)` gets `t`, seconds from the part's start, and runs only between the layer's `at` and `until`: an entrance counts from `ctx.layer.start`. It sets every moving property from `t` alone, so the same moment draws the same frame in any order (AK-D002). What keeps a layer deterministic is in [contract.md](contract.md).
|
|
180
180
|
- A style value the browser does not accept (`fontWeight: "900px"`, `width: "760"`) is dropped by the browser; while checking, every inline style set is watched and such a value is AK-R004.
|
|
181
181
|
- Text inside an element marked `data-ak-picture` is part of a picture (a mocked interface the frame crops on purpose): the frame's text checks leave it out.
|
|
182
182
|
|
|
183
183
|
### What the contract relies on
|
|
184
184
|
|
|
185
|
-
- **The look by its variables**: colours and fonts as `var(--ak-color-*)` and `var(--ak-font-*)` ([video.md](video.md#the-look)) follow the project's look
|
|
185
|
+
- **The look by its variables**: colours and fonts as `var(--ak-color-*)` and `var(--ak-font-*)` ([video.md](video.md#the-look)) follow the project's look. A `color()` prop holds a look variable. A deck's component follows the deck's theme with `var(--ak-theme-*)` ([slides.md](slides.md#components)).
|
|
186
186
|
- **Text as text**: the helpers set text as text nodes (`textContent`), so a string never becomes markup.
|
|
187
|
-
- **Every format**: lay out from `ctx.dims`, `ctx.content` or `layout(ctx)`,
|
|
187
|
+
- **Every format**: lay out from `ctx.dims`, `ctx.content` or `layout(ctx)`, which hold every format: a custom `WxH` and a changed `safe` too.
|
|
188
188
|
|
|
189
189
|
## The layer's `ctx`
|
|
190
190
|
|
|
@@ -195,7 +195,7 @@ A prop declared `time()` (also inside `list()` and `object()`) is typed `Time` i
|
|
|
195
195
|
| `ctx.look` | The look (also the CSS variables `--ak-color-*`, `--ak-font-*`, `--ak-motion-beat`) |
|
|
196
196
|
| `ctx.format` | The format's name: `"9x16"`, `"1280x720"`; a deck's may be `"a4"` |
|
|
197
197
|
| `ctx.dims` | `{ width, height, orient, safe }` ([video.md](video.md#formats)) |
|
|
198
|
-
| `ctx.combo` | The combo. A layer
|
|
198
|
+
| `ctx.combo` | The combo. A layer reads the dimensions and its own part's slot (another slot's pick is AK-X005): a part is rendered once for every combo that has it |
|
|
199
199
|
| `ctx.dur` | The part's length, seconds |
|
|
200
200
|
| `ctx.layer` | `{ start, end }`: this layer's window, seconds from the part's start |
|
|
201
201
|
| `ctx.enter`, `ctx.exit` | `{ start, end }`: where a transition shares the screen with the part before (`enter`, from before 0) or after (`exit`, to past `ctx.dur`), seconds from the part's start; absent at a cut. An entrance that starts at `ctx.enter.end` plays once the part shows alone |
|
|
@@ -214,7 +214,7 @@ A prop declared `time()` (also inside `list()` and `object()`) is typed `Time` i
|
|
|
214
214
|
| `ctx.video?.(piece, el)` | Another video item drawn in an element of this layer's ([below](#a-video-inside-a-layer)) |
|
|
215
215
|
| `ctx.embedded` | True in a video drawn inside another |
|
|
216
216
|
| `ctx.layoutOnly` | True while a moment is drawn only to measure its layout: nothing reads its pixels. A layer that paints a canvas no layout depends on may skip painting then; it still places its elements |
|
|
217
|
-
| `ctx.realTimers?` | The page's own clock and timers (`now`, `setTimeout`, `clearTimeout`), for work that waits on the wall clock (a loader, a worker)
|
|
217
|
+
| `ctx.realTimers?` | The page's own clock and timers (`now`, `setTimeout`, `clearTimeout`), for work that waits on the wall clock (a loader, a worker); what a frame shows comes from `t` |
|
|
218
218
|
|
|
219
219
|
### The content box
|
|
220
220
|
|
|
@@ -235,6 +235,8 @@ left = pad, right = W − pad
|
|
|
235
235
|
|
|
236
236
|
`await ctx.video(piece, el)` draws another video item of the project (the piece this module imported) inside `el`, in its own format and, where it has it, this video's language. It gives `{ id, duration, width, height, seek(t), at(ref) }`: `seek(t)` draws its moment `t`, `at(ref)` finds its own anchor or part's key in its seconds. It draws its graphic layers over its background; what it reads counts as this video's. A chain of videos that reaches itself is AK-M010. Put it behind `ctx.wait`. More in [footage.md](footage.md).
|
|
237
237
|
|
|
238
|
+
`await ctx.item(piece, el)` draws any item of the project the same way, by its own kind: a video as `ctx.video` does, a deck by its slides (`import q3 from "../decks/q3"`). It gives what `ctx.video` gives and its `kind`; a deck's `at("pricing")` is the moment its slide comes on and `at("pricing/2")` the rest after its second build (`/0` before any). The build finds the item by the import, in the video's module or a module of the project it imports, and `allyhub inspect uses` lists it; an item that uses the video back is AK-M016. It draws the item's graphics, not its sound.
|
|
239
|
+
|
|
238
240
|
## `@allyhub/sdk/dom`
|
|
239
241
|
|
|
240
242
|
| Helper | What it does |
|
|
@@ -256,7 +258,7 @@ left = pad, right = W − pad
|
|
|
256
258
|
| `emojiEl(value, style?)` | A span for an emoji in `var(--ak-font-emoji)` |
|
|
257
259
|
| `lightDark(el)` | The look's background and text colours as `{ light, dark }`. Call it in `mount` |
|
|
258
260
|
|
|
259
|
-
|
|
261
|
+
These are measurements and builders a layer calls: where things go, what is stressed and how it looks are the layer's.
|
|
260
262
|
|
|
261
263
|
## Animation, text, paths and noise
|
|
262
264
|
|
|
@@ -281,7 +283,7 @@ From `@allyhub/sdk`; pure functions.
|
|
|
281
283
|
|
|
282
284
|
## A person's input
|
|
283
285
|
|
|
284
|
-
A mouse's cursor, a hand (a finger hovering a screen, or a thing held to it), a finger's tap, a drag, a scrolled list or a field typed into, as functions of time.
|
|
286
|
+
A mouse's cursor, a hand (a finger hovering a screen, or a thing held to it), a finger's tap, a drag, a scrolled list or a field typed into, as functions of time. The piece says where and when, and draws what they return. Defaults: `INPUT_DEFAULTS` ([defaults.md](defaults.md)).
|
|
285
287
|
|
|
286
288
|
- **A cursor** glides: an aimed movement timed by Fitts' law, landing exactly where it is aimed, with none of a hand's errors; it rests before a click and after it. A hand's errors are options (`overshoot`, `scatter`, `bow`, `tremor`), none by default.
|
|
287
289
|
- **A hand** errs as hands do: past its target and back, a little off, its path bowed, trembling, each move drawn differently by `seed` and `index`. For what a hand holds or touches.
|
|
@@ -340,7 +342,7 @@ export const arrow = custom({
|
|
|
340
342
|
|
|
341
343
|
## Starter components
|
|
342
344
|
|
|
343
|
-
|
|
345
|
+
Components come as starter source: `allyhub add component/<name>` (`component/caption-line`) copies a starter component's source into the project's `components/`, where it is the project's code; `allyhub add` alone lists them. Each documents its props in its source, every value a prop with a default (its `*_DEFAULTS` constant where it has one): read it after adding. Import it by a relative path. Starters are mechanisms; a title, a list or an end card is the piece's own `custom()` or component.
|
|
344
346
|
|
|
345
347
|
| Component | What it does |
|
|
346
348
|
| --- | --- |
|
package/docs/linkedin.md
CHANGED
|
@@ -93,4 +93,4 @@ https://www.youtube.com/watch?v=…
|
|
|
93
93
|
|
|
94
94
|
`allyhub check` reports what LinkedIn refuses under `allyhub.linkedin/…`, at its line. `allyhub inspect <post>` gives the commentary's characters beside 3,000, its lines, hashtags and links, and its media's bytes and alt text; `allyhub inspect <article>` its title, words, headings, pictures and embeds. `allyhub frames` draws a post as the feed shows it (`feed`, folded; `open`) and an article as its page does (`article`), in Inter in place of the system face LinkedIn draws in; an embed and a link's card are drawn by their address.
|
|
95
95
|
|
|
96
|
-
`allyhub render <post>` writes the Posts API's request (`post.json`: the commentary in LinkedIn's little text, each medium beside it with the API it goes up by and the placeholder its id fills), or what a person posts by hand (`--type txt`: `post.txt`, the commentary as written, each medium beside it and its alt text in `<name>.alt.txt`). `allyhub render <article>` writes `article.html` with its pictures beside it. The editor's
|
|
96
|
+
`allyhub render <post>` writes the Posts API's request (`post.json`: the commentary in LinkedIn's little text, each medium beside it with the API it goes up by and the placeholder its id fills), or what a person posts by hand (`--type txt`: `post.txt`, the commentary as written, each medium beside it and its alt text in `<name>.alt.txt`). `allyhub render <article>` writes `article.html` with its pictures beside it. The editor's Download offers `txt` and a picture of the post (`png`); the request waits for publishing. Publishing to LinkedIn is not built.
|
package/docs/modeling.md
CHANGED
|
@@ -40,8 +40,8 @@ export default defineModel((bpy, parameters) => {
|
|
|
40
40
|
});
|
|
41
41
|
```
|
|
42
42
|
|
|
43
|
-
- `build(bpy, parameters)` may be async. `parameters` is plain JSON (`--args`, or a scenery's call). `bpy.random()` is seeded (`--param seed=`, default 0)
|
|
44
|
-
-
|
|
43
|
+
- `build(bpy, parameters)` may be async. `parameters` is plain JSON (`--args`, or a scenery's call). `bpy.random()` is the seeded random number (`--param seed=`, default 0): use it for randomness.
|
|
44
|
+
- Work on data: `bmesh.ops.*` take the geometry they act on and return the new geometry, as in Blender's Python, in place of `bpy.ops`, edit mode, selection and the active object. `applyModifier(bpy, object, { modifier })` applies one named modifier to its base mesh (Blender's `modifier_apply`).
|
|
45
45
|
- Relative imports name their extension (`./parts.ts`); only erasable TypeScript.
|
|
46
46
|
- An object's name is what the scenery commands and measurements call it; a taken name gets Blender's suffix (`Part.001`).
|
|
47
47
|
|
|
@@ -103,7 +103,7 @@ The surface's detail is about one `cell`.
|
|
|
103
103
|
- `allyhub 3d-model <file>` writes a GLB (Y up), by default `.allyhub/out/<module>.glb`; `--out` names another (`assets/media/models/<name>.glb` to load it as media). A failed build leaves the last GLB in place.
|
|
104
104
|
- A build is kept in `.allyhub/cache/model/` while the module, the files it read, its folder's files, its parameters and seed are unchanged; `--fresh` builds anew.
|
|
105
105
|
- The program is trusted project code, run in a child process; its logs go to stderr. An error names the call and the place in the project's files it failed at.
|
|
106
|
-
- A subdivision surface lies inside its cage: measure the surface (`--inspect`)
|
|
106
|
+
- A subdivision surface lies inside its cage: measure the surface (`--inspect`).
|
|
107
107
|
|
|
108
108
|
## In a scenery
|
|
109
109
|
|
package/docs/pictures.md
CHANGED
|
@@ -44,21 +44,21 @@ Besides these, the layer options of any graphic layer: `at`, `until`, `dur`, `z`
|
|
|
44
44
|
|
|
45
45
|
- **The geometry** is `placePicture` of `@allyhub/piece`, the numbers in [defaults.md](defaults.md) (`PICTURE_DEFAULTS`). `none` draws a pixel of the source on a pixel of the frame.
|
|
46
46
|
- **Lengths** (`radius`, a `filter`'s blur) are the frame's pixels, as CSS's, not px at 1080p as footage's.
|
|
47
|
-
- **A blend mode** mixes with what the stage draws under it: graphic layers and other pictures.
|
|
47
|
+
- **A blend mode** mixes with what the stage draws under it: graphic layers and other pictures. In a render, a video file's footage is composited after the stage draws, so a picture over footage blends with the graphic layers and pictures under it; the live preview blends it with the footage too.
|
|
48
48
|
- **Chrome draws it**, from the file alone: the same moment draws the same in order and out of order (AK-D002). A file that is not there is AK-A001; one that does not load AK-A005.
|
|
49
49
|
|
|
50
50
|
## Changing a picture's pixels
|
|
51
51
|
|
|
52
|
-
A picture's pixels are changed by AllyHub's cloud tools, each its own command (`allyhub ai-media <tool>`; `allyhub help ai-media <tool>` gives its input, its limits and its price): `generate-image`, `edit-image` (where a `mask` or a `markup` says, when given), `extend-image` and `cut-out-image` (the cut-out and its matte). A picture's parts as layers are the agent's to make: a part cut out (`cut-out-image`) and the picture without it (`edit-image` with a mask).
|
|
52
|
+
A picture's pixels are changed by AllyHub's cloud tools, each its own command (`allyhub ai-media <tool>`; `allyhub help ai-media <tool>` gives its input, its limits and its price): `generate-image`, `edit-image` (where a `mask` or a `markup` says, when given), `extend-image` and `cut-out-image` (the cut-out and its matte). A picture's parts as layers are the agent's to make: a part cut out (`cut-out-image`) and the picture without it (`edit-image` with a mask). The cloud chooses the model that serves each tool.
|
|
53
53
|
|
|
54
54
|
- **A picture on this computer** goes in by the address `allyhub upload` gives it.
|
|
55
55
|
- **What a call makes** is a new file, never the picture given changed, with its record beside it (`<file>.provenance`: the tool, the whole input, what it returned, the credits). The same call to the same `--file` finds that file and calls nothing. Files the output names deeper (a matte, the layers) are downloaded beside it, each listed in the result.
|
|
56
|
-
- **
|
|
56
|
+
- **A mask** says where the picture changes; the file returned is the whole picture, ready to show.
|
|
57
57
|
- **A Mark up note's region** is SVG path data in the pixels of the picture whose file it names.
|
|
58
58
|
|
|
59
59
|
## `footage()` of a still
|
|
60
60
|
|
|
61
|
-
`footage(still, opts)` is `picture()` with footage's options read as its: `at`, `until`, `dur`, `box` (one rectangle, or `"full"`), `fit`, `crop` (one rectangle), `reframe` (`"center"` or `{ x, y }`: its position
|
|
61
|
+
`footage(still, opts)` is `picture()` with footage's options read as its: `at`, `until`, `dur`, `box` (one rectangle, or `"full"`), `fit`, `crop` (one rectangle), `reframe` (`"center"` or `{ x, y }`: its position), `shape: "circle"` (an ellipse mask) and `radius` (px at 1080p). A still is one picture with no sound, so it takes these options, with one box and one crop for its whole time (any other throws).
|
|
62
62
|
|
|
63
63
|
## A deck's pictures
|
|
64
64
|
|
package/docs/project.md
CHANGED
|
@@ -50,14 +50,17 @@ Only the dot folders and Node's own files are fixed places. `assets/` and `compo
|
|
|
50
50
|
|
|
51
51
|
## `.allyhub/`
|
|
52
52
|
|
|
53
|
-
|
|
53
|
+
Made again as needed: never saved with the project, never in Git. What a piece imports lives in the project's other folders, and what must outlive a machine goes in `.agents/`.
|
|
54
54
|
|
|
55
55
|
| Folder | What is in it |
|
|
56
56
|
| --- | --- |
|
|
57
57
|
| `.allyhub/work/` | The agent's working files, free to throw away: frame sheets, cut sheets, references (`reference/`) |
|
|
58
58
|
| `.allyhub/out/` | Renders and exports, by the item's id |
|
|
59
59
|
| `.allyhub/cache/` | What the tools rebuild: builds, the media index (face tracks, mattes, levels), the part cache, types |
|
|
60
|
-
|
|
60
|
+
|
|
61
|
+
## `.agents/`
|
|
62
|
+
|
|
63
|
+
The agents' folder, saved with the project: skills (`skills/`), AllyHub's agent's notes (`memory/`), and what a person deleted (`trash/`: in an editor, kept until they empty it; from Studio's sidebar, a folder each with its `deleted.json`, kept 30 days).
|
|
61
64
|
|
|
62
65
|
## Items
|
|
63
66
|
|
|
@@ -91,15 +94,16 @@ work:
|
|
|
91
94
|
| (none) | A canvas | A `.canvas` file, JSON Canvas: its editor opens it by its name, so its entry names no `kind` (`- file: boards/launch.canvas`) |
|
|
92
95
|
|
|
93
96
|
- Each piece has its `kind`, its `file` from the project's root and, if you want, a `title`: its name where people see it; without one, the title its file says, else the file's name. A `group` is a heading over its `items`, and groups nest. A new project's list is `work: []`; an item a person makes in Studio or `allyhub dev` is added at its end.
|
|
94
|
-
- A file the list does not name is yours alone: a scenery a video imports, a part, a helper, a draft.
|
|
97
|
+
- A file the list does not name is yours alone: a scenery a video imports, a part, a helper, a draft. A person sees it once the list names it: a file of no kind, such as a Word document they gave you, is listed with no `kind` (`- file: contracts/offer.docx`) and shown as it is. The build still follows imports to a file the list does not name.
|
|
98
|
+
- A file listed with no `kind` is named by its file's name, extension and all (`offer.docx`), unless its entry gives a `title`, and its id is its path (`contracts/offer.docx`); so `report.mdx` (a doc) and `report.pdf`, or `data.csv` and `data.xlsx`, are listed and opened side by side.
|
|
95
99
|
- An item's **id** is its file without its extension (`launch/film`), one in the project: it names the item in commands (`allyhub check launch/film`, `--piece launch/film`), in `.allyhub/out/` and in a share. A piece's `id` is its item's unless it sets `id` (lowercase letters, digits, `.`, `_` and `-`, with `/` between levels). Two pieces with one id are AK-B001. The id names its message keys (`launch/film` reads keys under `launch.film.`) and seeds its randomness.
|
|
96
100
|
- An item names the other files it uses, each from its own file's folder: a piece's script (`script: "./film.{locale}.yaml"`), a deck's slides file (`slides: "./deck.yaml"`), a sheet's code (`code: ./forecast.ts`) and its tables' CSV files. Nothing is found by a fixed name, so items share a folder freely, and two share a file only when both name it.
|
|
97
|
-
- `allyhub check` reports what is wrong with the list: a list it cannot read, a kind not loaded, a file listed with no kind that no editor opens by its name, or a file not there (AK-M002), one id twice (`a.ts` and `a.mdx`, or one file listed twice, AK-M003). Moving or renaming a listed file in Studio writes the list again, with the imports.
|
|
101
|
+
- `allyhub check` reports what is wrong with the list: a list it cannot read, a kind not loaded, a file listed with no kind that no editor opens by its name, or a file not there (AK-M002), one id twice (`a.ts` and `a.mdx`, both of a kind, or one file listed twice, AK-M003: the first is shown). Moving or renaming a listed file in Studio writes the list again, with the imports.
|
|
98
102
|
|
|
99
103
|
### The item's file
|
|
100
104
|
|
|
101
|
-
- The default export is `video({ … })` or `presentation(…)` written in the file, or a constant holding one (`const film = video({ … }); export default film`).
|
|
102
|
-
- The module's top level runs in Node when the build reads the piece: what needs `window` or `document` goes in `parts` (or `pages`) or in a layer's `mount` and `render`. The top level
|
|
105
|
+
- The default export is `video({ … })` or `presentation(…)` written in the file, or a constant holding one (`const film = video({ … }); export default film`). The build reads it as written: a re-export, a factory function or a conditional there is AK-M001.
|
|
106
|
+
- The module's top level runs in Node when the build reads the piece: what needs `window` or `document` goes in `parts` (or `pages`) or in a layer's `mount` and `render`. The top level works offline (a network request is AK-B003) and finishes (AK-B004).
|
|
103
107
|
- Every field of the piece but its functions (`parts`, `pages`, `covers`) is plain data (AK-M001).
|
|
104
108
|
|
|
105
109
|
## The SDK, bound to its module
|
|
@@ -283,6 +287,6 @@ export default defineConfig({
|
|
|
283
287
|
The stage draws offline, so it draws only fonts that are files: its own, and the stylesheets a project brings.
|
|
284
288
|
|
|
285
289
|
- **Built in**: `"Inter Variable"` (Latin, Greek, Cyrillic, Vietnamese), `"Noto Sans SC"` (Chinese, 400 and 700) and `"Noto Color Emoji"` (the look's `font.emoji`). The `clean` look's `mono` is the computer's own monospace font, which differs between computers: bring one for code.
|
|
286
|
-
- **Imported by code**: install a font package and import its stylesheet in a piece or a module its pieces share (`import "@fontsource/space-grotesk/400.css"`), or import a stylesheet of `@font-face` rules beside the font files by a relative path.
|
|
290
|
+
- **Imported by code**: install a font package and import its stylesheet in a piece or a module its pieces share (`import "@fontsource/space-grotesk/400.css"`), or import a stylesheet of `@font-face` rules beside the font files by a relative path. Declare the package in `package.json` (AK-B005).
|
|
287
291
|
- **Listed in `allyhub.config.ts`**: `fonts` loads stylesheets on every stage, so the look can name a family no piece imports. An entry that names no file is AK-A001.
|
|
288
292
|
- A declared face costs nothing until text needs it: before the layers mount, the stage loads the faces of the families the look, the stylesheets and the layers' props name that cover a character of the piece's text; after mount, what the text on the stage asks for. A family that is not loaded falls to the next one, and a weight or style its faces lack is faked by the browser: both are AK-L006. A character no loaded font has is AK-L003.
|
package/docs/scenery.md
CHANGED
|
@@ -49,7 +49,7 @@ export default defineScenery({
|
|
|
49
49
|
|
|
50
50
|
`build(w)` runs once, awaited with every load it starts (60 s at most; in a video it counts in the piece's `loadLimit`, AK-P002); what it returns is `made`. `update(made, t, w)` poses it at `t`, seconds of scenery time. `cameras` (checked when defined, AK-W004) and `moves` are by name, for the commands and for layers. `bake` is in [Baked light](#baked-light). `title` is the item's name where `allyhub.yaml` gives it none, read from the module as written (a string, not computed); without either, its file's name.
|
|
51
51
|
|
|
52
|
-
**From `t` alone.** The same moment must draw the same pixels in any order (AK-D002). `Date`, `performance.now`, `Math.random`, `crypto.getRandomValues` and `requestAnimationFrame` follow the moment drawn; timers run only while it builds. Pose an `AnimationMixer` with `w.seek(mixer, t)` (every action reset, then `setTime(t)`)
|
|
52
|
+
**From `t` alone.** The same moment must draw the same pixels in any order (AK-D002). `Date`, `performance.now`, `Math.random`, `crypto.getRandomValues` and `requestAnimationFrame` follow the moment drawn; timers run only while it builds. Pose an `AnimationMixer` with `w.seek(mixer, t)` (every action reset, then `setTime(t)`). Name what is referred to (`Object3D.name`): cameras, moves, measurements and `projectScenery` take names, and a name no object has, or two have, is AK-W005.
|
|
53
53
|
|
|
54
54
|
`renderer` (all optional; `SCENERY_RENDERER_DEFAULTS`, the fastest drawing):
|
|
55
55
|
|
|
@@ -97,7 +97,7 @@ A `CameraState` points one of three ways, or looks down −Z, level:
|
|
|
97
97
|
| --- | --- | --- |
|
|
98
98
|
| `position` | required | Metres |
|
|
99
99
|
| `target`, `direction`, or `yaw`/`pitch` | down −Z | `yaw` about +Y (90 looks down −X); `pitch` above the horizon |
|
|
100
|
-
| `up` | `[0, 1, 0]` |
|
|
100
|
+
| `up` | `[0, 1, 0]` | Aim a view off `up` (one straight along it is AK-W004) |
|
|
101
101
|
| `roll` | 0 | Degrees about the view, counterclockwise |
|
|
102
102
|
| `lens` | 26 | 35 mm-equivalent focal length, mm |
|
|
103
103
|
| `lensFrame` | `"diagonal"` | What the lens is measured on: the frame's diagonal (CIPA), `"long"`, `"short"`, `"phone"` (`{ aspect: 4/3, keep: "long" }`, a phone's "26 mm"), or `{ aspect, keep }` |
|
|
@@ -252,7 +252,7 @@ export default video({
|
|
|
252
252
|
|
|
253
253
|
## Screens
|
|
254
254
|
|
|
255
|
-
`screen(content, opts)` puts content on a named object of the scenery (its first mesh's +Z face, the content's top left at the geometry's −x, +y). The content is a video item of the project (its piece, imported: its parts, timing, anchors and components its own;
|
|
255
|
+
`screen(content, opts)` puts content on a named object of the scenery (its first mesh's +Z face, the content's top left at the geometry's −x, +y). The content is a video item of the project (its piece, imported: its parts, timing, anchors and components its own; its picture, from its graphic layers) or graphic layers drawn on `size` px, whose windows and time props are seconds of the screen's time or references of the part.
|
|
256
256
|
|
|
257
257
|
| Option | Default | What it does |
|
|
258
258
|
| --- | --- | --- |
|
package/docs/sheets.md
CHANGED
|
@@ -202,7 +202,7 @@ The language is Excel's: `A1` and `$` references, ranges, `Sheet!A1`, `'My Sheet
|
|
|
202
202
|
- A formula that reads itself is a problem, and its cells and what reads them show `#CYCLE!`: Excel says so in a dialog. A cycle through a branch `IF` does not take is none, as in Excel. With `iteration` on it is no problem: as Excel's iterative calculation does, its cells and what reads them are computed again, each reading the latest value of the others (a cell not computed yet reads its `start`, or 0), until no value moves by `max_change` or `max_iterations` rounds have run. `allyhub inspect sheet` says how many rounds ran and how far a value moved in the last.
|
|
203
203
|
- An array result spills, as in Excel: the formula's cell shows the first value and the cells beside it the rest. They hold nothing in any file, read like any others, and `A1#` is the range the spill covers now. `#SPILL!` says something stands in the way (a cell that holds anything, a merge, a table, the edge of the sheet), and what stands there going lets it spill. A calculated column cannot spill. `=@A1:A9` is the value in the formula's own row. `FILTER`, `SORT`, `SORTBY`, `UNIQUE`, `SEQUENCE`, `RANDARRAY` (seeded as `RAND` is), `TEXTSPLIT`, `TAKE`, `DROP`, `VSTACK`, `HSTACK`, `TOCOL`, `TOROW`, `CHOOSEROWS`, `CHOOSECOLS`, `EXPAND`, `WRAPROWS` and `WRAPCOLS` give arrays; `MAP`, `REDUCE`, `SCAN`, `BYROW`, `BYCOL` and `MAKEARRAY` take a `LAMBDA`.
|
|
204
204
|
- A **data table** is Excel's What-If Analysis table, `=TABLE(row input, column input)` over its cells as a range key (`B5:F9: =TABLE($B$1,$B$2)`), its references absolute: each cell is the table's formula with the inputs set to the value atop its column and the value left of its row. A two-way table's formula is the cell above its left column, `A4` here; with a column input alone (`=TABLE(,$B$2)`) the formulas are the row above it, one a column, and with a row input alone (`=TABLE($B$1,)`) the column left of it, one a row. It is worked out after what it reads, iterating where the model does, and again with every change; an `.xlsx` holds it as Excel's own.
|
|
205
|
-
- A formula
|
|
205
|
+
- A formula reads its own workbook.
|
|
206
206
|
|
|
207
207
|
## In a script
|
|
208
208
|
|
|
@@ -395,7 +395,7 @@ export default workbook((wb, { data }) => {
|
|
|
395
395
|
- Its sheets come after the workbook file's, and the workbook file holds at least one.
|
|
396
396
|
- A person sees them locked. A change is refused as on a protected sheet, offering to ask you or Make Ordinary Sheet, which writes that sheet to the workbook file and its rows to CSV files. **A sheet the workbook file holds by a name is the workbook file's: what the code makes of that name is left out**, which `allyhub inspect` says (`sheet-ordinary`). Take it out of the workbook file to give it back to the code.
|
|
397
397
|
- An `.xlsx` holds them as plain sheets.
|
|
398
|
-
-
|
|
398
|
+
- A generated formula reads names and tables (`=growth`, `=orders[total]`) wherever it can, so it holds when a person inserts a row or renames a sheet.
|
|
399
399
|
|
|
400
400
|
`ws["A1"]` is a cell in TypeScript's types, so a value is written `ws["A1"].value = 5` or `ws.cell(1, 1, 5)`. TypeScript has no way to type openpyxl's `ws["A1"] = 5`, though it runs.
|
|
401
401
|
|
|
@@ -408,11 +408,11 @@ A name of openpyxl's that is not held throws where it is used, naming what the c
|
|
|
408
408
|
- `allyhub sheet calc <sheet> [what]` prints what a workbook computes, as an aligned table: a sheet (`Summary`, its used range), a range (`Summary!B3:M3`), a table, a name, or every sheet. `--scenario high` computes it with a scenario's inputs; `--scenarios` compares them.
|
|
409
409
|
- `allyhub sheet trace <sheet> <cell>` prints a cell's formula, where it is written, what it reads and what reads it.
|
|
410
410
|
- `allyhub sheet <sheet>` measures each table's columns: counts, empty cells, distinct values, errors, smallest and largest, sum and mean, lengths, the most frequent values.
|
|
411
|
-
- `allyhub inspect <sheet>`, and `allyhub inspect` for a whole project, says what a workbook's formulas and cells are like, as facts
|
|
411
|
+
- `allyhub inspect <sheet>`, and `allyhub inspect` for a whole project, says what a workbook's formulas and cells are like, as facts for you to judge: `sheet-error`, each cell whose value is an error and whether it starts there; `sheet-number`, numbers written into a formula and what takes each, once for a formula a range holds; `sheet-unlike`, a cell between neighbours that read alike, unlike them; `sheet-exception`, a cell set apart from its calculated column's formula; `sheet-unused`, names and typed numbers nothing reads (no formula, chart, rule, check or name); `sheet-invalid`, a value under a validation that breaks it; `sheet-typed`, a number its code typed that neither its data nor its code holds; `sheet-ordinary`, a sheet its code makes and the workbook file holds too; `sheet-iteration`, with `iteration` on, the rounds iterative calculation ran over how many cells and how far a value moved in the last. `allyhub inspect sheet <sheet>` has their options: `--plain 0,1,-1` the numbers not said, `--around 1` how many neighbours each side must agree, `--kind`, `--all` for every finding, every number and a table's columns nothing reads.
|
|
412
412
|
- `allyhub sheet diff <was> <now>` compares two versions, two folders or a folder and an `.xlsx`: what changed value under a formula that did not, what changed formula with its value the same, both, what came and went, names, a table's rows lined up by its `key`, else by their place. `--tolerance`, `--all`, `--json`.
|
|
413
413
|
- `allyhub sheet capabilities` says what the SDK holds of openpyxl's.
|
|
414
414
|
- `allyhub sheet import <file> --to finance/forecast.yaml` makes a sheet of an Excel, CSV or TSV file, its tables' rows in `finance/data/`, never over a place that is taken (see [Excel](#excel)).
|
|
415
|
-
- `allyhub render` writes each sheet to `.allyhub/out/<id>/`: `--type xlsx` (the default), `pdf`, `png`, `csv` (a file a sheet, named after it). An agent reads a sheet's values with `allyhub sheet calc
|
|
415
|
+
- `allyhub render` writes each sheet to `.allyhub/out/<id>/`: `--type xlsx` (the default), `pdf`, `png`, `csv` (a file a sheet, named after it). An agent reads a sheet's values with `allyhub sheet calc`. A sheet with a problem is not written.
|
|
416
416
|
- `allyhub frames <sheet>` draws a picture of a sheet as a person sees it, letters and numbers on its edges; `--range` names a sheet (`Summary`), a range (`Summary!B3:D9`), columns (`A:C`) or rows (`1:20`). Without a range it draws the first 200 rows and 60 columns of each sheet, and says what it left out.
|
|
417
417
|
|
|
418
418
|
`allyhub help sheet` and `allyhub help render` give every option.
|
|
@@ -463,4 +463,4 @@ export default video({
|
|
|
463
463
|
});
|
|
464
464
|
```
|
|
465
465
|
|
|
466
|
-
A deck's chart reads one the same way: `data: ../budget#orders` in its slides file.
|
|
466
|
+
A deck's chart reads one the same way: `data: ../budget#orders` in its slides file. `ctx.data` reads data files up to 5 MB.
|
package/docs/slides.md
CHANGED
|
@@ -101,7 +101,7 @@ slides:
|
|
|
101
101
|
| `script` | none | Its script, from the module's folder, with `{locale}` once in its name for each language (`./deck.{locale}.yaml`) |
|
|
102
102
|
| `size` | `"16:9"` | A slide size by name (`16:9`, `16:10`, `4:3` as PowerPoint's; `a4`, `a4-portrait`, `letter`, `letter-portrait` the paper's own; a carousel is an image, [image.md](image.md)) or `{ width, height }` in EMU |
|
|
103
103
|
| `title` | none | Its name for people, what lists show it by |
|
|
104
|
-
| `theme` | the project's look's colours, standard fonts | `{ colors, fonts }`: theme colours by PresentationML's names (`dk1`, `lt1`, `dk2`, `lt2`, `accent1`…`accent6`, `hlink`, `folHlink`), over the project's look (`dk1` its foreground, `lt1` its background, `accent1` its accent); fonts (`major`, `minor`, `major_east_asian`, `minor_east_asian`, and `code`, Courier New unless set, which the script's `` `code` `` is set in: PowerPoint's theme has no such font, so in the file it is a run's own), Arial and Microsoft YaHei unless set: fonts every PowerPoint, Keynote and Google Slides has. These and Calibri, Times New Roman, Cambria and Courier New are drawn here by fonts of the same metrics (Arimo, Noto Sans SC, Carlito, Tinos, Caladea, Cousine), so a line breaks in the file where it breaks here. Any other font the config's `fonts` lists goes in the PowerPoint file, a face each for regular, bold, italic and bold italic, unless its own licence bits (`fsType`) forbid it or it is a variable font; `allyhub render` says what did not go in.
|
|
104
|
+
| `theme` | the project's look's colours, standard fonts | `{ colors, fonts }`: theme colours by PresentationML's names (`dk1`, `lt1`, `dk2`, `lt2`, `accent1`…`accent6`, `hlink`, `folHlink`), over the project's look (`dk1` its foreground, `lt1` its background, `accent1` its accent); fonts (`major`, `minor`, `major_east_asian`, `minor_east_asian`, and `code`, Courier New unless set, which the script's `` `code` `` is set in: PowerPoint's theme has no such font, so in the file it is a run's own), Arial and Microsoft YaHei unless set: fonts every PowerPoint, Keynote and Google Slides has. These and Calibri, Times New Roman, Cambria and Courier New are drawn here by fonts of the same metrics (Arimo, Noto Sans SC, Carlito, Tinos, Caladea, Cousine), so a line breaks in the file where it breaks here. Any other font the config's `fonts` lists goes in the PowerPoint file, a face each for regular, bold, italic and bold italic, unless its own licence bits (`fsType`) forbid it or it is a variable font; `allyhub render` says what did not go in. A font named with no file the stage has is AK-L006 |
|
|
105
105
|
|
|
106
106
|
## Masters, layouts and placeholders
|
|
107
107
|
|
|
@@ -179,7 +179,7 @@ slides: []
|
|
|
179
179
|
| `slides[].shapes` | Its shapes by name: what it changes of its layout's placeholders, and its own |
|
|
180
180
|
| `slides[].background` | Its own background over its layout's: one of `fill` (a colour), `gradient` (as a shape's) or `picture` (a file, stretched over the slide) |
|
|
181
181
|
|
|
182
|
-
A shape there changes a placeholder of the slide's layout (or a generated shape) with `frame` (`{ x, y, w, h }` in points), `text` (on all of its text, every level, as PowerPoint sets a selected shape's: `size` in points, `bold`, `italic`, `underline`, `strike`, `color`, `font`, a family, `align`: `l`, `ctr`, `r`, `just`, `line_spacing`, a multiple of single spacing, `1.5`, `space_before` and `space_after` in points, or `{ lines: 0.5 }`, a share of a line at the text's size, `anchor`, where the text stands in its shape: `t`, `ctr`, `b`, `orientation`, which way it runs (PowerPoint's Text Direction): `horz`, `vert` (turned 90°), `vert270`, `eaVert` (East Asian vertical), `wordArtVert` (stacked), `wordArtVertRtl`, `mongolianVert`, `underline`, `true` or a style (`dbl`, `heavy`, `dotted`, `dottedHeavy`, `dash`, `dashHeavy`, `dashLong`, `dashLongHeavy`, `dotDash`, `dotDashHeavy`, `dotDotDash`, `dotDotDashHeavy`, `wavy`, `wavyHeavy`, `wavyDbl`, `words`), `strike`, `true` or `dblStrike`, `caps`, `small` or `all` (`none` over a level that has them), `bullet`, a character, `"•"`, or `false` for none, `numbered`, its paragraphs counted in place of a bullet, any of ECMA-376's 41 schemes (`arabicPeriod`, `arabicParenR`, `arabicParenBoth`, `arabicPlain`, `alphaLcPeriod`, `alphaUcParenR`, `romanUcPeriod`, `circleNumDbPlain`, `ea1ChsPeriod`…), `start_at`, the number it starts at, `bullet_color`, its bullets' or numbers' colour, `bullet_size`, their size, a share of the text's (`0.75`); given both, `numbered` stands; a bullet or a number in text with no indent hangs as PowerPoint's does, and one wider than its hanging indent pushes its line's text on to the next of PowerPoint's default tab stops, an inch apart from the text's inset, as PowerPoint's does: the slides file holds no tab stops of its own), `fill` (a colour, or `none`), `fill_transparency` (a share that shows through), `gradient` (`angle`, degrees clockwise from left to right, and `stops`, each `at`, a share of the way, `color` and `transparency`; or `path`, out from a focus instead of along a line, `circle` (PowerPoint's Radial), `rect` (Rectangular) or `shape` (Path), its first stop at the focus, and `focus`, `{ left, top, right, bottom }`, the share in from each side, the middle unless said: `{ left: 0, top: 0, right: 1, bottom: 1 }` is From Top Left Corner, and a share below 0 or above 1 is beyond that side, as some files have it; a circle reaches the farthest corner, and the stage draws a rectangle's and a path's contours as an ellipse reaching the farthest side, which is what CSS has), `pattern` (PowerPoint's Pattern Fill: `preset`, any of ECMA-376's 54 (`pct5` to `pct90`, `horz`, `vert`, `ltHorz`, `dkVert`, `narHorz`, `dashHorz`, `cross`, `dnDiag`, `upDiag`, `wdDnDiag`, `dashUpDiag`, `diagCross`, `smCheck`, `lgCheck`, `smGrid`, `lgGrid`, `dotGrid`, `smConfetti`, `lgConfetti`, `horzBrick`, `diagBrick`, `solidDmnd`, `openDmnd`, `dotDmnd`, `plaid`, `sphere`, `weave`, `divot`, `shingle`, `wave`, `trellis`, `zigZag`…), `fg` and `bg` colours, `accent1` over `bg1` unless said; drawn as 8 × 8 cells a pixel each at 100%, the percentages, lines, grids, checks and diamonds as their names say, the pictorial ones near PowerPoint's), `picture_fill` (PowerPoint's Picture or Texture Fill: `path`, an image of the project from the deck's folder, stretched over the shape, or with `tile` tiled: `scale_x` and `scale_y`, shares of its own size, a pixel of it a 96th of an inch, `x` and `y` in points from where `align` puts its first tile, `tl` (the default), `t`, `tr`, `l`, `ctr`, `r`, `bl`, `b`, `br`; `transparency`, a share; a tile's mirroring in a file is drawn unmirrored, said); a shape has one fill, the first of `picture_fill`, `pattern`, `gradient` and `fill` it says, and a slide's fill of any kind stands over its placeholder's, `shadow` (`blur` and `distance` in points, `angle`, `color`, `transparency`), `inner_shadow` (a shadow inside it, the same fields, PowerPoint's Inner shadows), `glow` (`color`, `size` in points, `transparency`), `soft_edges` (points its edges fade over), `reflection` (`transparency` where it starts and `size`, the share of the shape it shows, `distance` below and `blur` in points; mirrored under the shape as PowerPoint's touching reflections; the stage draws it with CSS's reflection, which does not blur, and every effect over the shape's outline and its text as SVG's and CSS's filters), `line` (its outline: a colour, or `none`), `line_width` in points, `line_dash` (`solid`, `sysDot`, `sysDash`, `dash`, `dashDot`, `lgDash`, `lgDashDot`, `lgDashDotDot`, PowerPoint's Dashes, and `dot`, `sysDashDot`, `sysDashDotDot`, Word's; a file's own dashes, `a:custDash`, come in as `dash`), `line_cap` (how its ends and dashes end: `flat`, the default, `rnd` or `sq`), `line_join` (how its corners meet: `miter`, the default, as the Office theme's lines, `round` or `bevel`), `line_compound` (`sng`, the default, `dbl`, `thickThin`, `thinThick` or `tri`: PowerPoint's Compound type, drawn as its lines look in PowerPoint, a thick line twice a thin one; on a line with no inside, a connector or an open freeform, `thickThin` and `thinThick` are drawn as `dbl`), a line's transparency being its colour's `alpha` (`accent1 alpha 50%`), `line_begin` and `line_end` (`none`, `triangle`, `arrow`, `stealth`, `diamond`, `oval`), `line_begin_size` and `line_end_size` (`{ w, len }`, each `sm`, `med` or `lg`: the head's width and length, PowerPoint's Arrow size), `rotation` (degrees clockwise about its centre, 0 up to 360, python-pptx's `rotation`), `flip_h` and `flip_v` (`true`: mirrored left to right, top to bottom; a line runs from its frame's other corner; its text reads as it is), `crop` (a picture's: `left`, `top`, `right` and `bottom`, the share of it cut from each side, PowerPoint's `a:srcRect`; a negative share is space left beside it; the editor's Crop menu writes Fill and Fit, [pictures.md](pictures.md#a-decks-pictures)), `z`; or is the slide's own with one of `textbox: true` (its words are the script's; it wraps, and grows from its frame's `h` to its text, so its frame still has all four of `x`, `y`, `w` and `h`), `picture`, `movie` (a video file of the project; a video item goes on a slide as its render, `allyhub render`), `geometry` (any of PowerPoint's 187 preset shapes by its `prst` name, ECMA-376's `ST_ShapeType`: `rect`, `roundRect`, `ellipse`, `triangle`, `star5`, `chevron`, `rightArrow`, `wedgeRectCallout`, `heart`, `cloud`, `donut`, `flowChartProcess`…, drawn from ECMA-376's preset shape definitions as PowerPoint draws them; a connector, `line`, `straightConnector1`, `bentConnector2` to `5` or `curvedConnector2` to `5`, has the connector's line, no fill and no text, and its `line_begin` and `line_end` face along its path, and `connect: { begin: { shape, site }, end: { shape, site } }` glues its ends to shapes of the slide by name, at sites of their geometries (a rectangle's 0 top, 1 left, 2 bottom, 3 right; PowerPoint's `a:stCxn` and `a:endCxn`): its frame is then where its ends sit, and they follow the shapes; `none` lets go of an end the code glued, as dragging the end off its shape does; with `adjustments`, its handles' values in the definition's order as python-pptx's `adjustments` has them, a share each: `roundRect`'s `[0.1]` is a corner of a tenth of its shorter side), `path` (a freeform: `{ w, h, d }`, its outline in a box of `w` × `h` units stretched to its frame, `d` in SVG's `M`, `L`, `C` and `Z`, absolute, so a logo or a cursor is a real shape), `table` (`columns`, widths in points, and `rows`, each a `height` with its `fill`, `text` and `line`, a rule at its foot; `merged`, cells merged as PowerPoint's Merge Cells, each `{ row, column, rows, columns }`, its first cell from 0 and how many rows and columns it takes, one unless said, inside the table and taking no cell another merge takes, its words its first cell's; stretched to its frame, its words the script's, a list of rows, each a list of cells; `style`, one of PowerPoint's 74 built-in table styles by the name its Table Styles gallery shows (`Medium Style 2 - Accent 1`, `Light Style 1`, `Themed Style 2 - Accent 3`, `Dark Style 2 - Accent 1/Accent 2`, `No Style, Table Grid`) or its id (`{5C22544A-7EE6-4342-B048-85BDC9FD1C3A}`), drawn under what its rows set, and Table Design's options for it, `first_row` (Header Row), `last_row` (Total Row), `first_col`, `last_col`, `horz_banding` (Banded Rows) and `vert_banding`, each `true`) or `component` (with `props`, and `dur`, how long it moves), and a `frame`. `group`, a name a slide's own shapes share, makes them one group in PowerPoint, standing together where the topmost of them stands; a group in a group is the outer's name, a slash and its own (`card/lines`: those shapes are a group inside `card`, whose other shapes say `card`), as deep as wanted. A table's look is its style's under what its rows and cells say; `add_table` starts one as python-pptx and PowerPoint do, Medium Style 2 - Accent 1 with `first_row` and `horz_banding`, and `table.style` sets another by name or id (the styles' look is PowerPoint's as far as their definitions are known: their colours, bands and rules; a Dark style with no accent, which no public definition gives, is approximated). A picture or a movie put in a picture, media or object placeholder fills it. Colours are the theme's (`accent1`…) or the colour map's (`tx1`, `bg1`, `tx2`, `bg2`, which the master's map makes a theme colour: text and background on a light master, the other way on a dark one); the theme's lighter or darker, in PowerPoint's words (`accent1 lighter 40%`, `dk1 darker 25%`, a share over 0 up to 100 %), which follows a change of theme as PowerPoint's picker's tints and shades do; `#RRGGBB`; or one of them with DrawingML's transforms after it, in order (`accent1 lumMod 75% lumOff 25%`, `tx1 tint 50%`, `#4472C4 alpha 50%`, `accent2 hueOff 30°`; `tint`, `shade`, `lumMod`, `lumOff`, `lum`, `satMod`, `satOff`, `sat`, `hueMod`, `hueOff`, `hue`, `alpha`, `alphaMod`, `alphaOff`, a share in `%`, `hue` and `hueOff` in degrees), as a file PowerPoint wrote has them. In code a colour (`ColorFormat`) has python-pptx's `brightness`, -1 to 1 (`0.4` is lighter 40 %), on a theme colour only. `z` orders a shape among the slide's shapes and placeholders, so a negative `z` puts one under a placeholder's words. Paths are from the deck's module's folder.
|
|
182
|
+
A shape there changes a placeholder of the slide's layout (or a generated shape) with `frame` (`{ x, y, w, h }` in points), `text` (on all of its text, every level, as PowerPoint sets a selected shape's: `size` in points, `bold`, `italic`, `underline`, `strike`, `color`, `font`, a family, `align`: `l`, `ctr`, `r`, `just`, `line_spacing`, a multiple of single spacing, `1.5`, `space_before` and `space_after` in points, or `{ lines: 0.5 }`, a share of a line at the text's size, `anchor`, where the text stands in its shape: `t`, `ctr`, `b`, `orientation`, which way it runs (PowerPoint's Text Direction): `horz`, `vert` (turned 90°), `vert270`, `eaVert` (East Asian vertical), `wordArtVert` (stacked), `wordArtVertRtl`, `mongolianVert`, `underline`, `true` or a style (`dbl`, `heavy`, `dotted`, `dottedHeavy`, `dash`, `dashHeavy`, `dashLong`, `dashLongHeavy`, `dotDash`, `dotDashHeavy`, `dotDotDash`, `dotDotDashHeavy`, `wavy`, `wavyHeavy`, `wavyDbl`, `words`), `strike`, `true` or `dblStrike`, `caps`, `small` or `all` (`none` over a level that has them), `bullet`, a character, `"•"`, or `false` for none, `numbered`, its paragraphs counted in place of a bullet, any of ECMA-376's 41 schemes (`arabicPeriod`, `arabicParenR`, `arabicParenBoth`, `arabicPlain`, `alphaLcPeriod`, `alphaUcParenR`, `romanUcPeriod`, `circleNumDbPlain`, `ea1ChsPeriod`…), `start_at`, the number it starts at, `bullet_color`, its bullets' or numbers' colour, `bullet_size`, their size, a share of the text's (`0.75`); given both, `numbered` stands; a bullet or a number in text with no indent hangs as PowerPoint's does, and one wider than its hanging indent pushes its line's text on to the next of PowerPoint's default tab stops, an inch apart from the text's inset, as PowerPoint's does: the slides file holds no tab stops of its own), `fill` (a colour, or `none`), `fill_transparency` (a share that shows through), `gradient` (`angle`, degrees clockwise from left to right, and `stops`, each `at`, a share of the way, `color` and `transparency`; or `path`, out from a focus instead of along a line, `circle` (PowerPoint's Radial), `rect` (Rectangular) or `shape` (Path), its first stop at the focus, and `focus`, `{ left, top, right, bottom }`, the share in from each side, the middle unless said: `{ left: 0, top: 0, right: 1, bottom: 1 }` is From Top Left Corner, and a share below 0 or above 1 is beyond that side, as some files have it; a circle reaches the farthest corner, and the stage draws a rectangle's and a path's contours as an ellipse reaching the farthest side, which is what CSS has), `pattern` (PowerPoint's Pattern Fill: `preset`, any of ECMA-376's 54 (`pct5` to `pct90`, `horz`, `vert`, `ltHorz`, `dkVert`, `narHorz`, `dashHorz`, `cross`, `dnDiag`, `upDiag`, `wdDnDiag`, `dashUpDiag`, `diagCross`, `smCheck`, `lgCheck`, `smGrid`, `lgGrid`, `dotGrid`, `smConfetti`, `lgConfetti`, `horzBrick`, `diagBrick`, `solidDmnd`, `openDmnd`, `dotDmnd`, `plaid`, `sphere`, `weave`, `divot`, `shingle`, `wave`, `trellis`, `zigZag`…), `fg` and `bg` colours, `accent1` over `bg1` unless said; drawn as 8 × 8 cells a pixel each at 100%, the percentages, lines, grids, checks and diamonds as their names say, the pictorial ones near PowerPoint's), `picture_fill` (PowerPoint's Picture or Texture Fill: `path`, an image of the project from the deck's folder, stretched over the shape, or with `tile` tiled: `scale_x` and `scale_y`, shares of its own size, a pixel of it a 96th of an inch, `x` and `y` in points from where `align` puts its first tile, `tl` (the default), `t`, `tr`, `l`, `ctr`, `r`, `bl`, `b`, `br`; `transparency`, a share; a tile's mirroring in a file is drawn unmirrored, said); a shape has one fill, the first of `picture_fill`, `pattern`, `gradient` and `fill` it says, and a slide's fill of any kind stands over its placeholder's, `shadow` (`blur` and `distance` in points, `angle`, `color`, `transparency`), `inner_shadow` (a shadow inside it, the same fields, PowerPoint's Inner shadows), `glow` (`color`, `size` in points, `transparency`), `soft_edges` (points its edges fade over), `reflection` (`transparency` where it starts and `size`, the share of the shape it shows, `distance` below and `blur` in points; mirrored under the shape as PowerPoint's touching reflections; the stage draws it with CSS's reflection, which does not blur, and every effect over the shape's outline and its text as SVG's and CSS's filters), `line` (its outline: a colour, or `none`), `line_width` in points, `line_dash` (`solid`, `sysDot`, `sysDash`, `dash`, `dashDot`, `lgDash`, `lgDashDot`, `lgDashDotDot`, PowerPoint's Dashes, and `dot`, `sysDashDot`, `sysDashDotDot`, Word's; a file's own dashes, `a:custDash`, come in as `dash`), `line_cap` (how its ends and dashes end: `flat`, the default, `rnd` or `sq`), `line_join` (how its corners meet: `miter`, the default, as the Office theme's lines, `round` or `bevel`), `line_compound` (`sng`, the default, `dbl`, `thickThin`, `thinThick` or `tri`: PowerPoint's Compound type, drawn as its lines look in PowerPoint, a thick line twice a thin one; on a line with no inside, a connector or an open freeform, `thickThin` and `thinThick` are drawn as `dbl`), a line's transparency being its colour's `alpha` (`accent1 alpha 50%`), `line_begin` and `line_end` (`none`, `triangle`, `arrow`, `stealth`, `diamond`, `oval`), `line_begin_size` and `line_end_size` (`{ w, len }`, each `sm`, `med` or `lg`: the head's width and length, PowerPoint's Arrow size), `rotation` (degrees clockwise about its centre, 0 up to 360, python-pptx's `rotation`), `flip_h` and `flip_v` (`true`: mirrored left to right, top to bottom; a line runs from its frame's other corner; its text reads as it is), `crop` (a picture's: `left`, `top`, `right` and `bottom`, the share of it cut from each side, PowerPoint's `a:srcRect`; a negative share is space left beside it; the editor's Crop menu writes Fill and Fit, [pictures.md](pictures.md#a-decks-pictures)), `z`; or is the slide's own with one of `textbox: true` (its words are the script's; it wraps, and grows from its frame's `h` to its text, so its frame still has all four of `x`, `y`, `w` and `h`), `picture`, `movie` (a video file of the project; a video item goes on a slide live as `item`), `geometry` (any of PowerPoint's 187 preset shapes by its `prst` name, ECMA-376's `ST_ShapeType`: `rect`, `roundRect`, `ellipse`, `triangle`, `star5`, `chevron`, `rightArrow`, `wedgeRectCallout`, `heart`, `cloud`, `donut`, `flowChartProcess`…, drawn from ECMA-376's preset shape definitions as PowerPoint draws them; a connector, `line`, `straightConnector1`, `bentConnector2` to `5` or `curvedConnector2` to `5`, has the connector's line, no fill and no text, and its `line_begin` and `line_end` face along its path, and `connect: { begin: { shape, site }, end: { shape, site } }` glues its ends to shapes of the slide by name, at sites of their geometries (a rectangle's 0 top, 1 left, 2 bottom, 3 right; PowerPoint's `a:stCxn` and `a:endCxn`): its frame is then where its ends sit, and they follow the shapes; `none` lets go of an end the code glued, as dragging the end off its shape does; with `adjustments`, its handles' values in the definition's order as python-pptx's `adjustments` has them, a share each: `roundRect`'s `[0.1]` is a corner of a tenth of its shorter side), `path` (a freeform: `{ w, h, d }`, its outline in a box of `w` × `h` units stretched to its frame, `d` in SVG's `M`, `L`, `C` and `Z`, absolute, so a logo or a cursor is a real shape), `table` (`columns`, widths in points, and `rows`, each a `height` with its `fill`, `text` and `line`, a rule at its foot; `merged`, cells merged as PowerPoint's Merge Cells, each `{ row, column, rows, columns }`, its first cell from 0 and how many rows and columns it takes, one unless said, inside the table and taking no cell another merge takes, its words its first cell's; stretched to its frame, its words the script's, a list of rows, each a list of cells; or its words from a project file, `data` (a sheet's table, `../sales/sales.yaml#revenue`, computed as the sheet computes it, a CSV or a data file of rows, from the deck's folder): a row of the file is a row of the table, under a head row of its columns' names (`head: false`, none), `fields` its columns in their order (default all of them, as its first row has them), `rows` giving each row its look and the last one's to the rows past it, each value as its source shows it (a sheet's number formats: `1,800`, `12%`), a plain file's as it holds it; `style`, one of PowerPoint's 74 built-in table styles by the name its Table Styles gallery shows (`Medium Style 2 - Accent 1`, `Light Style 1`, `Themed Style 2 - Accent 3`, `Dark Style 2 - Accent 1/Accent 2`, `No Style, Table Grid`) or its id (`{5C22544A-7EE6-4342-B048-85BDC9FD1C3A}`), drawn under what its rows set, and Table Design's options for it, `first_row` (Header Row), `last_row` (Total Row), `first_col`, `last_col`, `horz_banding` (Banded Rows) and `vert_banding`, each `true`) or `component` (with `props`, and `dur`, how long it moves), or `item` (another item of the project drawn live, its entry from the deck's folder, `../film/teaser.ts`: drawn by its own kind in its own format, fitted to the frame and centred, in the deck's language where it has it; it plays as a movie does, by `playback`'s `start`, `trim` and `loop`, and a slide settles when its trim ends; a show plays its sound with the slide's, from where it plays (its trim, its loop); a PowerPoint file holds a picture of it as the slide shows it and a movie of its frames while it plays, at most 60 seconds, with its sound; `allyhub inspect uses` lists it, and an item that uses the deck back is AK-M016), and a `frame`. `group`, a name a slide's own shapes share, makes them one group in PowerPoint, standing together where the topmost of them stands; a group in a group is the outer's name, a slash and its own (`card/lines`: those shapes are a group inside `card`, whose other shapes say `card`), as deep as wanted. A table's look is its style's under what its rows and cells say; `add_table` starts one as python-pptx and PowerPoint do, Medium Style 2 - Accent 1 with `first_row` and `horz_banding`, and `table.style` sets another by name or id (the styles' look is PowerPoint's as far as their definitions are known: their colours, bands and rules; a Dark style with no accent, which no public definition gives, is approximated). A picture or a movie put in a picture, media or object placeholder fills it. Colours are the theme's (`accent1`…) or the colour map's (`tx1`, `bg1`, `tx2`, `bg2`, which the master's map makes a theme colour: text and background on a light master, the other way on a dark one); the theme's lighter or darker, in PowerPoint's words (`accent1 lighter 40%`, `dk1 darker 25%`, a share over 0 up to 100 %), which follows a change of theme as PowerPoint's picker's tints and shades do; `#RRGGBB`; or one of them with DrawingML's transforms after it, in order (`accent1 lumMod 75% lumOff 25%`, `tx1 tint 50%`, `#4472C4 alpha 50%`, `accent2 hueOff 30°`; `tint`, `shade`, `lumMod`, `lumOff`, `lum`, `satMod`, `satOff`, `sat`, `hueMod`, `hueOff`, `hue`, `alpha`, `alphaMod`, `alphaOff`, a share in `%`, `hue` and `hueOff` in degrees), as a file PowerPoint wrote has them. In code a colour (`ColorFormat`) has python-pptx's `brightness`, -1 to 1 (`0.4` is lighter 40 %), on a theme colour only. `z` orders a shape among the slide's shapes and placeholders, so a negative `z` puts one under a placeholder's words. Paths are from the deck's module's folder.
|
|
183
183
|
|
|
184
184
|
A slide's `animations` are PowerPoint's Animation Pane, in order, each on one of the slide's own shapes (`shape`, by name; in a block, `<slide>/<shape>`), or one `paragraph` of its text, from 0:
|
|
185
185
|
|
|
@@ -260,7 +260,7 @@ Everything the file holds that the deck does not carry over as it is is reported
|
|
|
260
260
|
|
|
261
261
|
## Measuring a deck
|
|
262
262
|
|
|
263
|
-
The check measures every slide as the stage draws it, and `allyhub inspect` lists what it found as facts: numbers for you to judge,
|
|
263
|
+
The check measures every slide as the stage draws it, and `allyhub inspect` lists what it found as facts: numbers for you to judge, every length in points as the slides file writes them. Text the slide's edge cuts at every build that shows it is AK-L002, an error that stops a render. A deck has:
|
|
264
264
|
|
|
265
265
|
- `text-overflow`: a shape's text past its box, by its lines' glyphs.
|
|
266
266
|
- `text-off-slide`: a shape's text the slide's edge cuts, how far and the share outside.
|