Skip to main content

User Preferences

Customize your Scriptix experience with export templates and keyboard shortcuts.

Overview​

User preferences in Scriptix allow you to customize export templates and keyboard shortcuts for the transcript editor. These settings are accessed through the Profile page and are available to all users.

Accessing User Preferences​

Navigation:

  1. Log in to Scriptix
  2. Navigate to Profile page
  3. Scroll to preference sections:
    • Account Personalization (Export Templates)
    • Keymap Settings (Keyboard Shortcuts)
    • Security Settings (2FA)

Theme Toggle​

Scriptix supports light and dark mode themes.

Theme Options:

  • Light Mode - Bright interface, light background
  • Dark Mode - Dark interface, reduced eye strain

How to Change Theme:

  • Look for theme toggle (sun/moon icon) in navigation
  • Click to switch between light and dark
  • Theme changes immediately
  • Preference saved to localStorage
  • Persists across sessions

Theme Persistence:

  • Saved to browser localStorage
  • Applied to all pages
  • Theme-aware color system adjusts automatically

Export Templates​

Export templates allow you to customize document export formatting with DOCX templates and AI summarization prompts.

What Are Export Templates​

Purpose:

  • Customize document export formatting
  • Organization-wide templates
  • AI summary generation with custom prompts
  • Consistent output across team

Template Types:

EXPORT_TEMPLATE:

  • DOCX formatting template
  • Example PDF for reference
  • Used when exporting transcripts
  • Requires both DOCX and PDF files

SUMMARIZATION:

  • AI summary generation
  • Custom prompt for AI processing
  • Optional DOCX and PDF files
  • Flexible prompt customization

View Export Templates​

Account Personalization Section:

  • Displays all organization templates
  • Card-based grid layout
  • Responsive: 1-6 columns depending on screen size
  • Hover effect with shadow

Template Card Information:

  • Template name (truncated to 20 chars)
  • Type badge: "AI Summary" or "Export"
  • Template DOCX status
  • Example PDF status
  • Custom prompt indicator (✓ Custom Prompt if present)

Empty State:

  • Shows when no templates exist
  • Message: "No templates found"
  • Instruction: "Click 'Add Template' to create your first export template"
  • Dashed border box with FileText icon

Add Export Template​

Steps:

  1. Navigate to Profile → Account Personalization
  2. Click Add Template button (smoke variant)
  3. Modal opens with form

Create Template Modal:

Template Form Fields:

Name (Required):

  • Text input
  • Descriptive template name
  • Example: "Client Deliverable", "Medical Summary"
  • Validation: Required field

Type (Required):

  • Select dropdown with 2 options:
    • EXPORT_TEMPLATE
    • SUMMARIZATION
  • Default: EXPORT_TEMPLATE
  • Changing type updates prompt to default for that type

Prompt:

  • Textarea input
  • Minimum height: 160px
  • Default prompt provided based on type
  • Placeholder: "Enter custom prompt for document generation..."
  • Help text: "Enter a custom prompt for document generation. Leave empty to use the default system prompt. The prompt will be used to guide the AI in generating documents from transcripts."

Template DOCX:

  • File upload input
  • Accepts: .docx files
  • Dashed border upload box
  • Shows filename when selected
  • File icon with "Upload DOCX" label

Example PDF:

  • File upload input
  • Accepts: .pdf files
  • Dashed border upload box
  • Shows filename when selected
  • File icon with "Upload PDF" label

Validation Rules:

  • Name is required
  • EXPORT_TEMPLATE requires both DOCX and PDF files
  • SUMMARIZATION can work with name and prompt only
  • Error messages shown in red below fields

Save Template:

  1. Fill required fields
  2. Upload files (if EXPORT_TEMPLATE)
  3. Click Save Template button
  4. Loading toast: "Saving templates"
  5. Success toast: "Export template updated successfully"
  6. Modal closes
  7. Template appears in grid

Modal Properties:

  • Size: large
  • Cannot close by clicking outside
  • Footer actions: Cancel (smoke) and Save Template (primary)
  • Theme-aware styling

Manage Templates​

Download Template Files:

DOCX Download:

  1. Click DOCX button on template card
  2. Loading toast: "Downloading..."
  3. File downloads as [template_name].docx
  4. Success toast: "Download started"

PDF Download:

  1. Click PDF button on template card
  2. Loading toast: "Downloading..."
  3. File downloads as [template_name].pdf
  4. Success toast: "Download started"

Special States:

  • 409 status: File archived, error toast: "This file is archived and cannot be downloaded yet. Please try again later."
  • 202 status: File rehydrating, info toast: "This file is being prepared (rehydrating). Try again in a few minutes."
  • Other errors: "Download failed"

Edit Template (ORGADMIN only):

  1. Click Edit button (blue styled)
  2. Edit modal opens
  3. Pre-filled with current values
  4. Update name, type, prompt, or files
  5. Files optional: "Optional - leave empty to keep current"
  6. Click Save Changes
  7. Success toast: "Template updated successfully"

Edit Button Access:

  • Only shown if user has ORGADMIN role
  • Uses TokenExtension.get()?.decoded?.scopes check
  • Styled: blue background, blue border, blue text

Delete Template:

  1. Click Delete button (red styled) on template card
  2. Immediate deletion (no confirmation modal)
  3. Loading toast: "Deleting template..."
  4. Success toast: "Template deleted"
  5. Template removed from grid
  6. Error toast if deletion fails

Card Actions Layout:

  • DOCX button (gray background)
  • PDF button (gray background)
  • Edit button (blue, ORGADMIN only)
  • Delete button (red)
  • All buttons: 8px height, small text

Use Templates​

Templates are used when exporting documents from the transcript editor or caption editor.

When Exporting:

  1. Select document to export
  2. Click Export button
  3. Choose export format
  4. Select template from dropdown (if available)
  5. Export with template formatting applied

Template Application:

  • DOCX template styles applied to export
  • AI summary generated using custom prompt (if SUMMARIZATION)
  • Branded output with consistent formatting

Keyboard Shortcuts​

Customize keyboard shortcuts for the transcript editor.

Keymap Settings​

Purpose:

  • Add custom keyboard shortcuts
  • Configure transcript editor controls
  • Store key combinations with function names

Access: Profile → Keymap Settings section

View Keyboard Shortcuts​

Keymap Display:

  • Card-based grid layout
  • Responsive: 1-6 columns depending on screen size
  • Each card shows:
    • Title: "Keymap user setting transcript editor"
    • "Custom" badge
    • Keyboard icon with key combination
    • Command icon with function value
    • Delete button

Card Information:

  • Key combination (e.g., "Ctrl + f" or "Ctrl + Shift + f")
  • Value/function (stored preference)
  • Parsed from JSON value
  • Displays "N/A" if parsing fails

Empty State:

  • No cards shown when no keymaps exist
  • "Add Keymap" button displayed on right

Add Keyboard Shortcut​

Steps:

  1. Navigate to Profile → Keymap Settings
  2. Click Add Keymap button (smoke variant)
  3. Modal opens with form

Create Shortcut Modal:

Modal Properties:

  • Size: small
  • Title: "Create new shortcut"
  • Caption: "Create new shortcut caption"
  • Footer: Cancel and Create buttons

Form Fields:

Key (Required):

  • Text input field
  • Label: "Key"
  • Placeholder: 'ex. "Ctrl + f" or "Ctrl + Shift + f"'
  • Records keyboard input automatically
  • Focus detection for key capture

Value (Required):

  • Text input field
  • Label: "Value"
  • Placeholder: "Enter a value for the shortcut"
  • Function name or identifier

Key Capture Functionality:

  • Focus on key input field
  • Press desired key combination
  • Listens for keydown and keyup events
  • Up to 3 keys supported
  • Keys joined with " + " separator
  • Clear combination link appears when keys pressed
  • Click "Clear combination" to reset

Supported Modifiers:

  • Ctrl (Control key)
  • Shift
  • Alt
  • Meta (Windows/Command key)

Key Capture Behavior:

  • Maximum 3 keys at once
  • If 4th key pressed, removes first key
  • Keys stored in Set to prevent duplicates
  • Combination set on keyup event
  • Event.preventDefault() prevents browser defaults

Save Shortcut:

  1. Enter key combination (or type manually)
  2. Enter value/function name
  3. Click Create button
  4. Validation: Both key and value required
  5. Loading toast: "Saving custom key..."
  6. Success toast: "Custom key added"
  7. Modal closes
  8. Form resets
  9. New keymap appears in grid

Validation:

  • Key required: "Key required" error
  • Value required: "Value required" error
  • Red error text below field if validation fails

Storage Format:

  • Key: KEYMAP_INPUT_KEY constant
  • Value: JSON stringified object with key and value
  • Example: {"key": "Ctrl + f", "value": "search"}

Delete Keyboard Shortcut​

Delete Process:

  1. Click Delete button on keymap card
  2. Immediate deletion (no confirmation)
  3. Loading toast: "Deleting custom key..."
  4. Success toast: "Custom key deleted"
  5. Card removed from grid
  6. Error toast if deletion fails

Delete Button:

  • Red background, red border, red text
  • Trash icon (12px)
  • Full width on card
  • Height: 7px (28px in pixels)
  • "Delete" text shown on larger screens only (sm:inline)

Reseller Branding​

For reseller organizations, custom branding is applied automatically.

What's Customized:

  • Logo in navigation
  • Primary brand color in UI
  • Document exports (may include branding)
  • Email notifications (may include branding)

Managed By:

  • Organization administrators
  • Set in Organization Details form (Profile page)
  • Applies to all users in organization

User Impact:

  • Users see reseller logo and colors
  • Cannot change organization branding
  • Individual theme preference still available

Language & Localization​

Supported Interface Languages:

  • English (en)
  • Dutch (nl)
  • French (fr)
  • German (de)

Language Detection:

  • May auto-detect from browser settings
  • Uses i18next with browser language detection
  • Fallback language: English

What's Translated:

  • UI text and labels
  • Button text
  • Error messages
  • Form validation messages
  • Toast notifications

Access Control​

Export Templates:

  • View: All users can view
  • Create/Edit: All users can create
  • Edit (admin features): ORGADMIN role only
  • Delete: All users can delete their templates

Keyboard Shortcuts:

  • View: All users
  • Create: All users
  • Delete: All users (own shortcuts)

Security Settings (2FA):

  • View status: All users
  • Enable: All users
  • Disable: All users (requires 2FA code or backup code)

Data Storage​

Export Templates:

  • Stored at organization level
  • Files uploaded to server
  • DOCX and PDF files archived after period
  • Rehydration process for archived files (202 status)

Keyboard Shortcuts:

  • Stored as user preferences
  • Key: KEYMAP_INPUT_KEY constant
  • Value: JSON stringified object
  • Retrieved via user preferences API

Theme Preference:

  • Stored in browser localStorage
  • Not synced across devices
  • Persists across sessions on same device

Personalize your experience! Customize preferences to optimize your workflow and increase productivity.

Next Steps​

Complete your setup: