diff --git a/main.js b/main.js index 8b0bd62..346f6eb 100644 --- a/main.js +++ b/main.js @@ -1,4 +1,4 @@ -const { app, BrowserWindow, dialog, ipcMain, shell } = require('electron'); +const { app, BrowserWindow, dialog, ipcMain, shell, Menu } = require('electron'); const path = require('path'); const fs = require('fs-extra'); @@ -13,7 +13,7 @@ const { } = require('./services/unrouted'); const CAD_EXTENSIONS = ['prt', 'asm', 'dwr']; -const DEFAULT_DESTINATION = './output/cad'; +const DEFAULT_DESTINATION = 'X:\\'; const SETTINGS_FILENAME = 'cad-router-settings.json'; const LINUX_RUNTIME_DIR = '.cadroute'; @@ -79,6 +79,25 @@ function createWindow() { win.loadFile(path.join(__dirname, 'renderer', 'index.html')); } +function createDocsWindow() { + const docs = new BrowserWindow({ + width: 900, + height: 700, + title: 'CadRoute — Documentazione', + icon: path.join(__dirname, 'build', 'icon.png'), + webPreferences: { contextIsolation: true, nodeIntegration: false }, + }); + docs.loadFile(path.join(__dirname, 'renderer', 'docs', 'index.html')); + docs.setMenuBarVisibility(false); +} + +Menu.setApplicationMenu(Menu.buildFromTemplate([ + { + label: 'Help', + submenu: [{ label: 'Documentazione', click: () => createDocsWindow() }], + }, +])); + app.whenReady().then(async () => { await ensureRuntimeDirectory(); const persistedDestination = await loadPersistedDestination(); diff --git a/package.json b/package.json index 84a7d7e..c3fa43a 100644 --- a/package.json +++ b/package.json @@ -19,7 +19,8 @@ "preload.js", "renderer/**/*", "services/**/*", - "build/icon.png" + "build/icon.png", + "renderer/docs/**/*" ], "win": { "target": "nsis", diff --git a/renderer/docs/index.html b/renderer/docs/index.html new file mode 100644 index 0000000..3ebde20 --- /dev/null +++ b/renderer/docs/index.html @@ -0,0 +1,277 @@ + + + + + + CadRoute — Documentazione + + + + + + +
+ + +
+

CadRoute — Guida utente

+
+

CadRoute automatizza lo smistamento di file CAD provenienti da Creo. Analizza una cartella o un archivio ZIP, riconosce i file CAD e li copia automaticamente nella sottocartella di destinazione corretta, basandosi sulla struttura numerica del nome file.

+
+ +

Formati supportati

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
EstensioneTipoDescrizione
.prtPartFile di componente singolo Creo
.asmAssemblyFile di assemblaggio Creo
.dwrDrawingFile di disegno Creo
altriIgnorati (PDF, immagini, documenti, ecc.)
+
+ + +
+

Requisiti

+

Prima di iniziare, assicurati che la cartella di destinazione sia quella corretta.

+
+ +
+ + +
+

Configurare la destinazione

+

La destinazione è la cartella radice dove CadRoute copierà i file CAD smistati. Va impostata una volta sola e viene ricordata tra le sessioni.

+ +
    +
  1. Individua la sezione Destinazione file CAD nella finestra principale.
  2. +
  3. Clicca Sfoglia per aprire il selettore cartelle, oppure digita il percorso direttamente nel campo di testo.
  4. +
  5. Clicca Salva. La destinazione viene memorizzata e sarà attiva anche alla prossima apertura dell'app.
  6. +
+ +
+ Tip: il percorso di default è X:\. Assicurati che sia quello corretto prima di avviare lo smistamento. +
+
+ + +
+

Smistare i file

+

È possibile smistare una cartella (anche con sottocartelle annidate) o un archivio .zip, tramite i pulsanti o trascinando direttamente nell'area apposita.

+ +
    +
  1. Clicca Process Folder per selezionare una cartella, oppure Process ZIP per selezionare un archivio. In alternativa, trascina la cartella o il file .zip nell'area tratteggiata.
  2. +
  3. L'app scansiona tutti i file e identifica automaticamente quelli CAD.
  4. +
  5. I file CAD vengono copiati nella sottocartella di destinazione corrispondente. I file non CAD vengono saltati.
  6. +
  7. Al termine vengono mostrate le statistiche nell'area di output.
  8. +
+ +
+ Nota: i file originali non vengono mai modificati né cancellati. +
+
+ +
+ + +
+

Leggere i risultati

+

Al termine di ogni operazione l'area di output mostra un riepilogo. Ecco il significato di ogni voce.

+ +
+
+
Scansionati
+
Totale file analizzati (CAD e non).
+
+
+
Copiati
+
File effettivamente scritti su disco (destinazione, non smistati o duplicati).
+
+
+
Saltati
+
File ignorati perché non CAD (PDF, immagini, ecc.).
+
+
+
Non smistati
+
File CAD per cui non è stata trovata una destinazione valida.
+
+
+
Duplicati
+
File CAD già presenti nella destinazione al momento dello smistamento.
+
+
+ +

Sotto le statistiche sono elencati i dettagli di ogni file (massimo 20 voci) con il percorso di destinazione e la motivazione, nel caso di file non smistati o duplicati.

+
+ +
+ + +
+

Convenzione nomi file CAD

+

CadRoute determina automaticamente la sottocartella di destinazione leggendo il nome del file. È fondamentale che i file seguano la convenzione corretta.

+ +

Struttura del nome

+
CODICE.tipo[.versione]
+
+Esempi:
+  ABC12345.prt        → Part, nessuna versione
+  ABC12345.prt.6      → Part, versione 6
+  XYZ67890.asm.10     → Assembly, versione 10
+  DEF11111.drw.15     → Drawing, versione 15
+ +

Gestione versioni

+

Se sono presenti più versioni dello stesso file nella sorgente (es. ABC12345.prt.8 e ABC12345.prt.9), CadRoute mantiene solo la versione più alta e scarta le inferiori.

+ + + + + + + + + + + + + + + + + + + +
ScenarioComportamento
File non presente in destinazioneCopia diretta nella sottocartella corretta
File già presente in destinazioneCopiato in duplicati/ per revisione
Versione inferiore presente nella sorgenteSaltata — la versione più alta prende precedenza
+
+ + +
+

File non smistati

+

Un file CAD finisce in non smistati quando CadRoute non riesce a determinare una destinazione valida. Le cause più comuni sono:

+ + + + + + + + + + + + + + + + + + + +
CausaMessaggio
Codice con meno di 5 cifre"Nome file non conforme: servono almeno 5 cifre…"
Sottocartella non trovata in destinazione"Sottocartella XXX non trovata nella destinazione"
Sottocartella trovata in più percorsi (ambiguo)"Sottocartella XXX trovata in N percorsi diversi"
+ +

Dove si trovano

+

I file non smistati vengono copiati nella cartella __NON_SMISTATI:

+ + +

Visualizzare e pulire

+
    +
  1. Clicca Anteprima non smistati per aprire la lista dei file presenti.
  2. +
  3. Verifica i file, controlla il motivo dell'esclusione nell'area di output.
  4. +
  5. Se vuoi svuotare la cartella, clicca Pulisci cartella (rosso) e conferma. L'operazione è irreversibile.
  6. +
+ +
+ Suggerimento: prima di pulire, sposta manualmente i file che vuoi conservare. La pulizia elimina tutto il contenuto della cartella. +
+
+ + +
+

File duplicati

+

Un file CAD viene classificato come duplicato quando la sua chiave (CODICE.tipo, senza versione) è già presente nella cartella di destinazione al momento dello smistamento.

+ +

I duplicati non sovrascrivono i file già presenti in destinazione: vengono messi da parte nella cartella duplicati/ per permettere una revisione manuale.

+ +

Dove si trovano

+ + +

Gestione versioni nei duplicati

+

Anche all'interno della cartella duplicati/ viene applicata la logica delle versioni: se arriva una versione più alta di un file già presente nei duplicati, la versione vecchia viene eliminata e sostituita con quella nuova.

+ +

Visualizzare e pulire

+
    +
  1. Clicca Anteprima duplicati per aprire la lista dei file presenti.
  2. +
  3. Verifica se i duplicati sono effettivamente superati o se richiedono un intervento manuale.
  4. +
  5. Se vuoi svuotare la cartella, clicca Pulisci cartella (rosso) e conferma.
  6. +
+ +
+ Attenzione: la pulizia è definitiva. Assicurati di non aver bisogno dei file prima di procedere. +
+
+ +
+ + + + diff --git a/renderer/docs/style.css b/renderer/docs/style.css new file mode 100644 index 0000000..e194c5d --- /dev/null +++ b/renderer/docs/style.css @@ -0,0 +1,335 @@ +:root { + color-scheme: light; + --bg: #f6f8fb; + --card: #ffffff; + --text: #0f172a; + --muted: #475569; + --accent: #0b5fff; + --accent-light: #eef3ff; + --border: #dbe2ea; + --sidebar-w: 220px; + --code-bg: #f1f5f9; + --success: #15803d; + --warning: #b45309; + --danger: #b91c1c; +} + +* { box-sizing: border-box; margin: 0; padding: 0; } + +body { + font-family: 'Segoe UI', Tahoma, Geneva, Verdana, sans-serif; + font-size: 14px; + line-height: 1.65; + color: var(--text); + background: var(--bg); + display: flex; + min-height: 100vh; +} + +/* ── SIDEBAR ─────────────────────────────────── */ +nav { + width: var(--sidebar-w); + min-width: var(--sidebar-w); + background: var(--card); + border-right: 1px solid var(--border); + padding: 24px 0 24px; + position: fixed; + top: 0; + left: 0; + height: 100vh; + overflow-y: auto; + display: flex; + flex-direction: column; +} + +.nav-brand { + padding: 0 18px 20px; + border-bottom: 1px solid var(--border); + margin-bottom: 12px; +} + +.nav-brand .logo { + font-size: 16px; + font-weight: 700; + color: var(--accent); + letter-spacing: -0.3px; +} + +.nav-brand .version { + font-size: 11px; + color: var(--muted); + margin-top: 2px; +} + +nav a { + display: block; + padding: 7px 18px; + text-decoration: none; + color: var(--muted); + font-size: 13px; + border-left: 3px solid transparent; + transition: color 100ms, border-color 100ms, background 100ms; +} + +nav a:hover { + color: var(--text); + background: var(--accent-light); +} + +nav a.active { + color: var(--accent); + border-left-color: var(--accent); + background: var(--accent-light); + font-weight: 600; +} + +.nav-section-label { + padding: 14px 18px 4px; + font-size: 10px; + font-weight: 700; + letter-spacing: 0.8px; + text-transform: uppercase; + color: #94a3b8; +} + +/* ── MAIN CONTENT ────────────────────────────── */ +main { + margin-left: var(--sidebar-w); + flex: 1; + padding: 40px 48px 80px; + max-width: 860px; +} + +/* ── TYPOGRAPHY ──────────────────────────────── */ +h1 { + font-size: 26px; + font-weight: 700; + margin-bottom: 8px; + color: var(--text); +} + +h2 { + font-size: 19px; + font-weight: 700; + margin: 48px 0 14px; + padding-bottom: 8px; + border-bottom: 1px solid var(--border); + color: var(--text); + scroll-margin-top: 24px; +} + +h3 { + font-size: 15px; + font-weight: 600; + margin: 22px 0 8px; + color: var(--text); +} + +p { + color: var(--muted); + margin-bottom: 12px; +} + +p:last-child { margin-bottom: 0; } + +/* ── INTRO CARD ──────────────────────────────── */ +.intro-card { + background: var(--accent-light); + border: 1px solid #c7d9ff; + border-radius: 12px; + padding: 18px 20px; + margin-bottom: 4px; +} + +.intro-card p { + color: #1e3a8a; + margin: 0; +} + +/* ── STEP LIST ───────────────────────────────── */ +.steps { + list-style: none; + counter-reset: step; + display: flex; + flex-direction: column; + gap: 10px; + margin: 12px 0; +} + +.steps li { + display: flex; + gap: 14px; + align-items: flex-start; + counter-increment: step; +} + +.steps li::before { + content: counter(step); + min-width: 26px; + height: 26px; + border-radius: 50%; + background: var(--accent); + color: white; + font-size: 12px; + font-weight: 700; + display: flex; + align-items: center; + justify-content: center; + flex-shrink: 0; + margin-top: 1px; +} + +.steps li span { + color: var(--muted); + line-height: 1.6; +} + +/* ── CALLOUT ─────────────────────────────────── */ +.callout { + border-radius: 10px; + padding: 13px 16px; + margin: 16px 0; + font-size: 13px; + border-left: 4px solid; +} + +.callout.info { + background: #f0f9ff; + border-color: #38bdf8; + color: #075985; +} + +.callout.warning { + background: #fffbeb; + border-color: #f59e0b; + color: #78350f; +} + +.callout.tip { + background: #f0fdf4; + border-color: #22c55e; + color: #14532d; +} + +.callout strong { font-weight: 700; } + +/* ── CODE & INLINE CODE ──────────────────────── */ +code { + background: var(--code-bg); + border: 1px solid var(--border); + border-radius: 4px; + padding: 1px 5px; + font-family: 'Cascadia Code', 'Consolas', monospace; + font-size: 12.5px; + color: #be185d; +} + +pre.code-block { + background: #0f172a; + color: #e2e8f0; + border-radius: 10px; + padding: 16px; + margin: 12px 0; + overflow-x: auto; + font-family: 'Cascadia Code', 'Consolas', monospace; + font-size: 13px; + line-height: 1.55; +} + +pre.code-block code { + background: none; + border: none; + padding: 0; + color: inherit; + font-size: inherit; +} + +/* ── BADGE ───────────────────────────────────── */ +.badge { + display: inline-block; + padding: 2px 8px; + border-radius: 20px; + font-size: 11px; + font-weight: 700; + letter-spacing: 0.2px; + vertical-align: middle; + margin: 0 2px; +} + +.badge.prt { background: #dbeafe; color: #1e40af; } +.badge.asm { background: #dcfce7; color: #166534; } +.badge.dwr { background: #fef3c7; color: #92400e; } +.badge.skip { background: #f1f5f9; color: #475569; } + +/* ── TABLE ───────────────────────────────────── */ +table { + width: 100%; + border-collapse: collapse; + margin: 14px 0; + font-size: 13px; +} + +th { + text-align: left; + padding: 9px 12px; + background: var(--code-bg); + border: 1px solid var(--border); + font-weight: 600; + color: var(--text); +} + +td { + padding: 8px 12px; + border: 1px solid var(--border); + color: var(--muted); + vertical-align: top; +} + +tr:nth-child(even) td { background: #fafbfc; } + +/* ── STAT GRID ───────────────────────────────── */ +.stat-grid { + display: grid; + grid-template-columns: repeat(auto-fill, minmax(160px, 1fr)); + gap: 10px; + margin: 14px 0; +} + +.stat-item { + background: var(--card); + border: 1px solid var(--border); + border-radius: 10px; + padding: 12px 14px; +} + +.stat-item .stat-label { + font-size: 11px; + font-weight: 700; + text-transform: uppercase; + letter-spacing: 0.5px; + color: var(--muted); + margin-bottom: 4px; +} + +.stat-item .stat-desc { + font-size: 13px; + color: var(--text); + line-height: 1.4; +} + +.stat-item.ok { border-top: 3px solid #22c55e; } +.stat-item.info { border-top: 3px solid var(--accent); } +.stat-item.warn { border-top: 3px solid #f59e0b; } +.stat-item.muted { border-top: 3px solid #94a3b8; } + +/* ── SEPARATOR ───────────────────────────────── */ +hr { + border: none; + border-top: 1px solid var(--border); + margin: 32px 0; +} + +/* ── SECTION ─────────────────────────────────── */ +section { + margin-bottom: 8px; +}