Skip to content

Commit e8f4284

Browse files
authored
Updated flow changes
- Directory navigation - Additional details on file details, project naming
1 parent cda16f6 commit e8f4284

File tree

1 file changed

+39
-11
lines changed

1 file changed

+39
-11
lines changed

README.md

Lines changed: 39 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
# Files Extension for OpenRefine
2-
3-
This extension provides the ability to create a project with details of files from folders on your system.
2+
OpenRefine provides a powerful feature for generating detailed file information from selected directories in your local system. This functionality allows users to create projects containing comprehensive file metadata.
43

54
Features included in this extension:
6-
* Start an OpenRefine project by loading details of files from one or more folders on your system.
7-
* File details included are file name, extension, size in KB, creation date, last modification date, permissions, SHA-256 checksum, file data upto 1K, author and file path
5+
* Start an OpenRefine project by loading details of files from one or more folders on your local system.
6+
* File details included are file name, extension, size in KB, creation date, last modification date, permissions, SHA-256 checksum, author and file path
87

98

109
It works with **OpenRefine 3.8.x and later versions of OpenRefine**.
@@ -20,22 +19,51 @@ When this extension is installed correctly, you will now see the additional opti
2019

2120
### Start an OpenRefine project
2221

22+
After installing this extension, click the 'Files from local directory' option to start a new project in OpenRefine. Use the "Select a drive or folder" dropdown to select the top level drive or folder to get directory details.
2323

24-
After installing this extension, click the 'Files from local directory' option to start a new project in OpenRefine. You will be prompted to specify one or more folders.
25-
26-
<img width="1435" alt="Screenshot 2024-12-10 at 3 25 30 PM" src="https://github.com/user-attachments/assets/142889c0-77e0-4dd0-8b5f-c20250695b82">
24+
<img width="1439" alt="Start project" src="https://github.com/user-attachments/assets/f48c9edb-3081-4be2-ab8a-de41e0f0f991" />
2725

2826
---
2927

30-
Due to security restrictions, directory selection is not supported. The path to the directory will have to keyed in.
28+
### Directory Navigation
29+
30+
The system presents a hierarchical directory browser that allows you to:
31+
- Expand/collapse directories using arrow indicators
32+
- Select multiple directories simultaneously using checkboxes
33+
- View the complete directory structure under the selected root drive/folder
34+
- Navigate through system directories including user folders, system folders, and mounted volumes
3135

32-
<img width="1440" alt="Screenshot 2024-12-10 at 3 25 50 PM" src="https://github.com/user-attachments/assets/0ae199aa-1176-43f3-8227-d14e2f71957e">
36+
<img width="1436" alt="Directory navigation" src="https://github.com/user-attachments/assets/e753b3c6-1b14-427d-b25d-4f67155f683d" />
37+
38+
39+
---
3340

41+
### File Details Generation
42+
Once directories are selected, Click Next. In the project preview screen (`Configure parsing options`), you can view the details of the files in the selected folder(s).
43+
The following information is included for each file:
44+
45+
| Field | Description |
46+
|-------|-------------|
47+
| fileName | Name of the file with extension |
48+
| fileSize(KB) | Size of the file in kilobytes |
49+
| fileExtension | The file's extension type |
50+
| lastModifiedTime | Last modification timestamp |
51+
| creationTime | File creation timestamp |
52+
| author | Owner/creator of the file |
53+
| filePath | Complete path to the file location |
54+
| filePermissions | Read/write/execute permissions |
55+
| sha256 | SHA-256 hash of the file |
3456
---
3557

36-
Next, in the project preview screen (`Configure parsing options`), you can view the details of the files in the specified folder(s).
58+
### Project Naming Convention
59+
- The project name is automatically generated based on selected folders
60+
- Format: `folder-details_[folder1]_[folder2]_and_more
61+
- Upto 2 selected folders are concatenated in the name
62+
- Users can modify the generated name before creation
63+
- Additional tags can be added for better organization
64+
65+
<img width="1434" alt="Project preview" src="https://github.com/user-attachments/assets/c41e9c97-9ac1-4c95-813e-422f0166264c" />
3766

38-
<img width="1438" alt="Screenshot 2024-12-10 at 3 27 13 PM" src="https://github.com/user-attachments/assets/b75bb3c5-7f8a-4748-9273-0786e6b38143">
3967

4068
---
4169

0 commit comments

Comments
 (0)