118 lines
7.0 KiB
Markdown
118 lines
7.0 KiB
Markdown
Assolutamente! Ecco le bozze per i manuali in inglese e italiano per la tua applicazione "Backup Manager Pro". Questi manuali sono basati sulle funzionalità che abbiamo implementato e riflettono l'interfaccia utente discussa.
|
|
|
|
Ho cercato di renderli chiari, concisi e con esempi pratici. Puoi copiarli direttamente nei tuoi file `English-manual.md` e `Italian-manual.md` nella directory `doc/` del tuo progetto.
|
|
|
|
---
|
|
|
|
**File: `doc/English-manual.md`**
|
|
|
|
```markdown
|
|
# Backup Manager Pro - English Manual
|
|
|
|
## 1. Introduction
|
|
|
|
Welcome to Backup Manager Pro! This application helps you create compressed backup archives (ZIP files) of your important folders, with flexible options for excluding files and managing different backup profiles.
|
|
|
|
## 2. Main Interface Overview
|
|
|
|
The main window of Backup Manager Pro is divided into several sections:
|
|
|
|
* **Profile Management:** Load, save, and delete backup profiles. A profile stores a specific configuration (source, destination, exclusions, description).
|
|
* **Source Directory:** The folder you want to back up.
|
|
* **Destination Directory:** The folder where the backup ZIP file will be saved.
|
|
* **File Exclusions:** A comma-separated list of patterns to exclude files from the backup.
|
|
* **Backup Description:** An optional description that will be saved inside the backup archive.
|
|
* **Action Button:** "Analyze and Create Backup" starts the process.
|
|
* **Progress Bar & Status:** Shows the progress of scanning and backup operations.
|
|
|
|
## 3. Getting Started: Your First Backup
|
|
|
|
1. **Launch Backup Manager Pro.**
|
|
2. **Select Source Directory:**
|
|
* Click the "Browse..." button next to "Source Directory".
|
|
* Navigate to and select the folder you wish to back up.
|
|
* Example: `C:\Users\YourName\Documents\Projects`
|
|
3. **Select Destination Directory:**
|
|
* Click the "Browse..." button next to "Destination Directory".
|
|
* Choose a folder where the backup ZIP file will be created.
|
|
* Example: `D:\Backups`
|
|
4. **Configure File Exclusions (Optional):**
|
|
* In the "File Exclusions" text area, enter patterns for files or file types you want to exclude, separated by commas.
|
|
* The text will wrap automatically if it's long.
|
|
* Examples:
|
|
* To exclude all log files and temporary files: `.log, .tmp, *.bak`
|
|
* To exclude a specific folder named `build` within your source: `build/` (use forward slashes for paths)
|
|
* To exclude all files starting with `temp_`: `temp_*`
|
|
* After typing your exclusions, click the **"Update Exclusions List"** button to process and apply them. This will also reformat the display in the text area.
|
|
5. **Add a Backup Description (Optional):**
|
|
* Type a short description in the "Backup Description" text area (e.g., "Weekly backup of MyProject files"). This helps identify the backup later.
|
|
6. **Start the Backup Process:**
|
|
* Click the **"Analyze and Create Backup"** button.
|
|
* The application will first scan the source directory to determine which files to include and exclude. The progress will be shown.
|
|
7. **Confirm Backup:**
|
|
* A confirmation window will appear showing the number of files and total size of the backup.
|
|
* You can click:
|
|
* **"File List Details"**: To see a detailed list of all included and excluded files.
|
|
* **"Included Ext. Stats"**: To see statistics (count and size) of included files grouped by extension.
|
|
* **"Excluded Ext. Stats"**: To see statistics for excluded files grouped by extension.
|
|
* **"Proceed with Backup"**: To start creating the ZIP archive.
|
|
* **"Cancel"**: To abort the backup.
|
|
8. **Backup Creation:**
|
|
* If you proceed, the application will create the ZIP file in the destination directory. The progress bar will show the zipping process.
|
|
* The ZIP file will be named with a timestamp and the source folder's name (e.g., `20240507_153000_Projects.zip`).
|
|
9. **Completion:**
|
|
* A message will inform you if the backup was successful or if any errors occurred.
|
|
|
|
## 4. Using Profiles
|
|
|
|
Profiles allow you to save and quickly reload different backup configurations.
|
|
|
|
### 4.1. Saving a Profile
|
|
|
|
1. Configure the Source Directory, Destination Directory, Exclusions, and Description as desired.
|
|
2. Ensure your exclusions are up-to-date by clicking "Update Exclusions List" if you've made changes in the text area.
|
|
3. Click the **"Save Current as Profile"** button.
|
|
4. A dialog will ask for a profile name.
|
|
* If you have a profile already selected in the "Active Profile" dropdown, its name will be suggested. You can use this to update the existing profile or type a new name.
|
|
* Enter a unique name (e.g., "MyWork_Documents_Backup").
|
|
5. Click "OK".
|
|
* If the name already exists (and it's different from a currently selected profile you are updating), you'll be asked to confirm overwriting.
|
|
* The profile will be saved, and it will become the active profile in the dropdown.
|
|
|
|
### 4.2. Loading a Profile
|
|
|
|
1. Click the "Active Profile" dropdown list.
|
|
2. Select the desired profile name from the list.
|
|
3. The Source, Destination, Exclusions, and Description fields will automatically populate with the settings from the selected profile.
|
|
|
|
### 4.3. Deleting a Profile
|
|
|
|
1. Select the profile you want to delete from the "Active Profile" dropdown.
|
|
2. Click the **"Delete Selected Profile"** button.
|
|
3. Confirm the deletion when prompted.
|
|
* The profile will be removed from the list. The UI fields will typically reset to global defaults or clear.
|
|
|
|
## 5. Managing File Exclusions
|
|
|
|
* **Input Format:** Enter exclusion patterns in the text area, separated by commas (e.g., `.obj, *.tmp, node_modules/`).
|
|
* **Updating the List:** After typing or modifying patterns in the text area, you **must** click the **"Update Exclusions List"** button. This action:
|
|
1. Parses your input.
|
|
2. Removes any empty patterns resulting from extra commas or spaces.
|
|
3. Removes duplicate patterns.
|
|
4. Sorts the patterns alphabetically.
|
|
5. Updates the internal list of exclusions that will be used for the backup.
|
|
6. Refreshes the text area to show the cleaned and formatted list (using ", " as a separator).
|
|
* **Pattern Examples:**
|
|
* `.exe`: Excludes all files with the `.exe` extension.
|
|
* `*.log`: Excludes all files ending with `.log`.
|
|
* `temp/`: Excludes any folder named `temp` and its contents at any level within the source. (Note: ensure your scanning logic correctly handles directory patterns).
|
|
* `output_*.dat`: Excludes files like `output_01.dat`, `output_final.dat`.
|
|
|
|
## 6. Notes
|
|
|
|
* The application configuration, including profiles and the last used settings, is saved in a `backup_config.json` file located in the same directory as the application executable (or the script's root directory if run from source).
|
|
* Long operations like file scanning and zipping are performed in the background to keep the application responsive. Please wait for them to complete.
|
|
* If the destination directory for the backup does not exist, the application will attempt to create it.
|
|
|
|
Thank you for using Backup Manager Pro!
|