User Manual • Lighting Submittal Package Builder

1. Product overview

The application helps users combine lighting cut sheets into one professional submittal package. Each project stores its metadata, uploaded PDFs, and generated output separately. The workflow is optimized for speed while still requiring the critical information needed for a clean deliverable.

Create a project and add one or more PDF cut sheets.
Fill required fields such as luminaire type, manufacturer, model, and location.
Save and autosave changes without creating duplicate projects.
Generate the final PDF and open or download it without leaving the page.

2. Roles and permissions

Basic user	Can create, edit, save, and generate only their own projects. Can view only their own project tree and output files. The Basic plan is limited to 3 generated submittal projects.
Admin user	Can view users in the tree, open user projects, manage users, and access the Compatibility tools from the user menu. Admin accounts default to the Extended plan.
Session behavior	Each user works inside their own session and storage area. Projects, PDFs, and outputs are separated per user.

Important: change the default admin password before going live. The project currently initializes a default admin account for first-run convenience.

3. Workspace layout

Left column — Project tree

Shows projects like folders. Click the arrow to expand and see the PDFs inside a project. Click the project name to load that project into the center workspace.

Center column — Work area

This is where you add PDFs, reorder them, open General Settings, save the project, and generate the final package. The center column scrolls internally on desktop.

Right column — Details

Shows the selected PDF’s key metadata and a preview. Use this area to verify what is selected before editing details or changing the source PDF.

Top-right user menu

Displays the signed-in user and role. Admin-only tools such as Compatibility are placed here to keep the workspace clean.

4. Quick start

4.1 Create an account and choose a plan

Use Create free account for the Basic plan or Start Extended for the paid path.
Email is the main sign-in identity. Google sign-in can also be enabled when OAuth credentials are configured.
Users who choose Extended are directed into the billing flow after registration.

4.2 Start a new project

Click New Project to clear the workspace.
Open General Settings and enter the project name first.
Add the PDFs in the order you want them to appear in the final package.

4.3 Add PDFs

Click Add PDF.
Select one or more PDF files from your computer.
Each PDF appears as a card in the workspace. Use drag/reorder controls if available to place them in the desired sequence.

4.4 Configure General Settings

General Settings control the overall package output. These values usually apply to the final document rather than one specific cut sheet.

Project name	Required. Used for the cover, save record, and final output naming.
Logo	Optional. Upload a new logo or choose a saved logo from the library.
Font size and margins	Control header/footer spacing and readability.
Footer text	Can use tokens such as `{page}`, `{total}`, `{project}`, and `{date}`.

5. Project and PDF details

Each PDF requires its own metadata because these values are used in the table of contents and content headers.

Luminaire Type	Describes the product family or category for the cut sheet.
Manufacturer	Company or brand shown in the PDF header and contents list.
Model / Product Code	Catalog, ordering code, or model identifier.
Location / Area	Helps identify where the product belongs within the project or plan set.

To update a selected PDF, use Edit cut sheet details from the right panel. To replace the file while keeping the metadata row, use Change PDF.

6. Save, autosave, and versions

The system supports both explicit saving and autosave. Together they are designed to avoid duplicate project records while preserving a stable output target.

Save Project stores the current project state and assigns a stable project/output identity.
Autosave runs when changes are detected and enough required information is present.
The status badge can show Not saved, Unsaved, Saving…, or Saved.
Discard changes returns to the last saved project state or clears a new unsaved project.

Important: saving and generating later should update the same project record rather than create a duplicate entry. That is one of the core protections built into the current app flow.

7. Generate workflow

Generate is intentionally gated by validation. The app checks the critical fields before it starts building the PDF.

Click Generate.
Basic plan users can generate up to 3 distinct projects. Re-generating the same saved project does not consume another slot.
A confirmation modal appears.
If required information is missing, the modal explains what needs to be completed.
When you confirm, generation runs without leaving the page.
After completion, the same modal presents Open and Download actions.

Critical fields checked before Generate

Project name
At least one PDF
Luminaire Type for each PDF
Manufacturer for each PDF
Model / Product Code for each PDF
Location / Area for each PDF

8. Admin tasks

8.1 Manage users

Use the Users button in the app header to create users, reset passwords, and manage roles or groups if those fields are enabled in the admin interface.

8.2 Compatibility

The Compatibility panel is intended for administrators. It checks whether the server has the external PDF tools needed for best results, especially qpdf and Ghostscript.

8.3 Review user projects

Admins can browse users in the left tree, expand a user to see projects and PDFs, and load a project into the workspace for review or support.

9. Troubleshooting

Add PDF does nothing	Confirm the browser allows file selection dialogs, that you are logged in, and that the file is actually a PDF.
Compatibility warning appears	Ask an administrator to open Compatibility and verify server execution permissions, qpdf, and Ghostscript.
Project will not generate	Open the confirmation modal and check the missing required fields list. Complete every flagged field before retrying.
Preview does not show	Select a PDF card first. If the preview still fails, confirm the saved PDF path still exists and the user has permission to view it.
Saved project not in tree	Use the tree refresh button. If still missing, confirm the save completed and that you are viewing the correct user context.

10. Best practices before production use

Replace placeholder values in assets/site-config.js with the real company name, support email, legal email, security email, address, and app URL.
Change the default admin password immediately after deployment.
Install and verify qpdf and Ghostscript for best PDF normalization and recovery.
Serve the site over HTTPS and review cookie/security settings on the production host.
Review the legal pages with counsel so they match your real service, storage, billing, and incident response practices.
Back up /data, /uploads, and /output according to your retention policy.