Skip to main content

Packages

Sources

Docs: Panes Web App: Select Pieces. Root Packages retain their existing hierarchy beside Pages. Use the Add Package icon beside Search Pieces to create a root Package, or Add → Package on a Package to nest one. A Package is a folder. It holds Packages and Panes, and nothing else: a Pane’s Perception, Palette, Policy, 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. The Pieces tree includes Pages, each Package, and its existing descendants. The Add Package button is available to editors 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 and an icon picker. Create Package becomes available after you enter a name and choose an icon. Both are saved together. The server requires an icon for new Packages; existing Packages can still save with or without one.
  • 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.

Move or remove a Package

Review every Pane it contains and every Page or Pane whose Perception declares one of them. A move should preserve the experience and data meaning, not merely make the tree look tidier. Removing a Package from a Patch leaves any Page that still declares one of its Panes with a dangling reference, which publish reports as a finding, so repair the affected Pages before proposing the change. Creation includes Pieces in your existing Pending Changes when a save will adopt that draft, so a new name and position do not conflict with work already there.

Reference

Generated Workspace API reference for this Piece: