Packages
Sources
Docs: Panes Web App: Select Pieces. Root Packages sit beside Pages. Use the Add Package icon beside the search field to create a root Package, or Add → Package on a Package to nest one. A Package is a folder. It holds Packages and Panes: a Pane’s Perception, Policies, Palette, and Plots belong to the Pane and travel with it. Use a Package when a reader should understand a set of Panes as one module and when those Panes should move or be reviewed together. A Package may also be the data layer of its capability: what its Panes read and save that nobody sees on its own. Give it a Perception, and it gets Policies of its own. Its Perception declares the type of the rows people save on it and its own data, and declares no Panes, because a Package is never drawn. Its Policies govern its Perception, its Policies and its data. A Package without a Perception stays a folder and grants no access. Turning a folder into a data layer needs a seat that edits the Parable andcreate.pane on the
Home Page; each later change is judged by the Package’s own Policies. An
archive carries a data layer’s Perception, Policies and data, as it carries a
Pane’s. Its Perception is the file perception.d.ts in the Package’s own
folder, so moving that folder by hand moves the Perception with it.
The Pieces tree includes Pages, each Package, and its existing descendants.
It shows Home first and then the root Packages, sorted by their own order, so
Home’s order never places a Package. Two root Packages cannot share an order.
Inside a Package, its Packages and Panes share one order.
The Add Package button is available to people who hold Publishing or Primary even before a Package exists. From the first Package,
the normal tree exposes its content and permitted creation, rename, and delete
actions. Read-only readers can navigate the same tree without mutation actions.
Organize without hiding meaning
- Adding a Package opens a dialog with a Name field, a Description field, and an icon picker. Create Package becomes available after you enter a name, say in one sentence what the Package groups, and choose an icon. All three are saved together. A new Package needs an icon. Every Package needs a description, as every Page, Pane, and Plot does.
- A Package’s icon picker, in that dialog and on the Package’s name, offers only Font Awesome’s box, folder and piece glyphs: the things a Package is and holds. Other Pieces choose from the whole catalog.
- Name the Package for the capability it contains, not its implementation team or storage location.
- Keep the nesting shallow enough that a new collaborator can find a Pane.
- Put a Pane inside the Package when it owns a visible region.
- Keep Pages in the Page hierarchy; a Package does not contain a Page.
- Avoid creating a Package for a single Pane unless the grouping itself has a stable customer meaning.