Skip to content

Commit 6805085

Browse files
authored
Merge pull request #2 from Laim/dev-branch
- Change Drag and Drop to accept folder and change txtRoot to the dragged directory, see issue [#1](#1) - Split Models.cs out to separate class files - Created EULA.md - Created HELP.md - Updated README.md - Created VERSIONS.md (legacy versions) - Updated F1 link in frmMain - Started adding some temporary comments so I know what is what - Changed donate button so it specifies who its going to (RL Vision) - Changed Laim link to Snap2HTML-NG
2 parents 0863908 + effdd4a commit 6805085

File tree

15 files changed

+1011
-985
lines changed

15 files changed

+1011
-985
lines changed

EULA.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# EULA
2+
RL Vision in case of Snap2HTML, or Laim McKenzie in case of Snap2HTML-NG, can not be held responsible for any damages whatsoever, direct or indirect, caused by this software or other material from RL Vision in case of Snap2HTML, or Laim McKenzie in case of Snap2HTML-NG.

HELP.md

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
# Search
2+
The built in search box accepts the following modifiers:
3+
4+
Wildcards \* and ? can be used. \* matches zero or more characters. ? matches exactly one character.
5+
6+
Prefix your search with > to search only the current folder. >> searches the current folder and its sub folders.
7+
8+
**Tip**: Search for \* to list all files. This is especially useful together with the export functionality to get all data out of the html file.
9+
10+
# Search Pattern
11+
The Search Pattern in the GUI is a new feature to Snap2HTML-NG. This allows you to only pull files that match a certain cirteria. Similar to the Search function in the HTML file;
12+
13+
Wildcards \* and ? can be used. \* matches zero or more characters in that position. ? matches exactly one character in that position.
14+
15+
Characters other than the wildcard are literal characters. The Search Pattern "\*w" searches for all file names in the path ending with the letter "W". The Search Pattern "l\*" searches for all file names beginning with the letter "L".
16+
17+
Note due to how .NET Framework is designed, if you use an aserisk wild card for specifying file types, such as "\*.mp4", this will return files with extensions that match and _begin_ with mp4. If you use the ? wildcard somewhere within the search pattern, it will resolve this issue.
18+
19+
For example using "\*.txt" will return "\*.txt, \*.txtt" etc.
20+
21+
# File Linking
22+
23+
Linking allows you open the listed files directly in your web browser. This is designed to be flexible, which also sometimes makes it tricky to get right.
24+
25+
Only files can be linked. Folders are automatically linked to browse the path in the snapshot.
26+
27+
Different browsers handle local links in different ways, usually for security reasons.
28+
29+
For example, Internet Explorer will not let you open links to files on your local machine at all. (*You can however copy the
30+
link and paste into the location field.*)
31+
32+
Here are some examples that shows how to use it:
33+
34+
## Link to fully qualified local path
35+
**Root folder**: "c:\my_root\"
36+
37+
**Link to**: "c:\my_root\"
38+
39+
**Use snapshot from**: [anywhere locally]
40+
41+
## Link to relative local path
42+
**Root folder**: "c:\my_root\"
43+
44+
**Link to**: "my_root\"
45+
46+
**Use snapshot from**: "c:\snapshot.html"
47+
48+
## Link to same folder as snapshot is saved in
49+
**Root folder**: "c:\my_root\"
50+
51+
**Link to**: [leave textbox empty]
52+
53+
**Use snapshot from**: "c:\my_root\snapshot.html"
54+
55+
## Link to a web server with mirror of local folder
56+
**Root folder**: "c:\my_www_root\"
57+
58+
**Link to**: "http://www.example.com/"
59+
60+
**Use snapshot from**: [anywhere]
61+
62+
## Link to a relative path on a web server with mirror of local folder
63+
**Root folder**: "c:\my_www_root\subfolder"
64+
65+
**Link to**: "subfolder/"
66+
67+
**Use snapshot from**: "http://www.example.com/snapshot.html"
68+
69+
# Command Line
70+
You can automate Snap2HTML by starting it from the command line with the
71+
following options:
72+
73+
## Simple
74+
Snap2HTMl.exe "c:\path\to\root\folder"
75+
76+
**Note**: Starts the program with the given root path already set
77+
78+
## Full
79+
80+
Snap2HTMl.exe -path:"root folder path" -outfile:"filename" [-link:"link to path"] [-title:"page title"] [-hidden] [-system] [-silent]
81+
82+
### Paramters
83+
84+
-path:"root folder path" - The root path to load.
85+
86+
**Example**: -path:"c:\temp"
87+
88+
-outfile:"filename" - The filename to save the snapshot as. Don't forget the html extension!
89+
90+
**Example**: -outfile:"c:\temp\out.html"
91+
92+
-link:"link to path" - The path to link files to.
93+
94+
**Example**: -link:"c:\temp"
95+
96+
-title:"page title" - Set the page title. If omitted, title is generated based on path.
97+
98+
-hidden - Include hidden items
99+
100+
-system - Include system items
101+
102+
-silent - Run without showing the window (only if both -path and -outfile are used)
103+
104+
**Notes**:
105+
106+
When both -path and -outfile are specified, the program will automatically start generating the snapshot, and quit when done.
107+
108+
Always surround paths and filenames with quotes ("")!
109+
110+
In silent mode, in case or error the program will just quit without telling why.
111+
112+
Do not include the [square brackets] when you write your command line. (Square brackets signify optional command line parameters)
113+
114+
# Template Design
115+
If you know html and javascript you may want to have a look at the file "template.html" in the application folder. This is the base for the output, and you can modify it with your own enhancements and design changes.
116+
117+
If you make something nice you are welcome, to send it to me and I might distribute it with future versions of the program or add a link below!
118+
119+
- Showcases:
120+
- Amstrad CPC Memory Engraved: https://acpc.me (Amazing!)

README.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,38 @@
22

33
This application is a modified version of [Snap2HTML](https://github.com/rlv-dan/Snap2HTML) by RL Vision.
44

5-
Snap2HTML takes a "snapshot" of the folder structure on your harddrive and saves it as an HTML file. What's unique about Snap2HTML is that the HTML file uses modern techniques to make it feel like a "real" application, displaying a treeview with folders that you can navigate to view the files contained within.
5+
Snap2HTML-NG takes a "snapshot" of the folder structure on your Hard Drive or Network Drive and saves it as an HTML file.
66

7-
There is also a built in file search and ability to export data as plain text, csv or json. Still, everything is contained in a single HTML file that you can easily store or distribute.
7+
What's unique about Snap2HTML-NG is that the HTML file uses modern techniques to make it feel like a real File Explorer, displaying a treeview with directories that you can navigate to view the files contained within.
8+
There is also a built-in file search and ability to export data as plain text, CSV, or JSON. Everything is contained in a single HTML file that you can easily store or distribute.
9+
10+
Snap2HTML-NG file listings can be used in many ways. An example of some is:
11+
12+
- As a complement to your backups (**this is not a backup solution**).
13+
- You can also keep a file list of external HDDs and other computers; in case you need to look something up or to save for historic reasons and documentation.
14+
- Helping friends or family with Troubleshooting, you can ask them to send a snapshot of their directories so you can better understand their problem.
15+
16+
It's up to you to decide what Snap2HTML-NG can be used for!
817

918
## Screenshots
1019

1120
WinForms application for generating the direcotry listings:
1221

13-
<img src="https://github.com/Laim/Snap2HTML-NG/assets/14845036/4d8915f7-7dbb-4994-8059-3942710f3f9b">
22+
[![Screenshot of Application](https://github.com/Laim/Snap2HTML-NG/assets/14845036/4d8915f7-7dbb-4994-8059-3942710f3f9b)]
1423

1524
The finished HTML app:
1625

17-
<img src="https://github.com/Laim/Snap2HTML-NG/assets/14845036/a7a1ed83-93e3-46e2-a40c-c9b31e2d8412">
26+
[![Screenshot of HTML output](https://github.com/Laim/Snap2HTML-NG/assets/14845036/a7a1ed83-93e3-46e2-a40c-c9b31e2d8412)]
1827

1928
## Snap2HTML-NG Changes
2029

2130
This is some of the changes so far.
2231

2332
- Search Pattern filtering on Scan
24-
- Writable Directory Path Textbox
33+
- Writable Directory Path Textbox
34+
- Project upgraded to .NET Framework 4.8
35+
- Drag and Drop Optimization
36+
37+
## Privacy Notice
38+
39+
Snap2HTML-NG does not connect to the internet. It does not phone home, check for updates, submit telemetry, spy on you or any other crap like that. It simply doesn't do anything behind your back and any data related to the program is yours. As it should be.

0 commit comments

Comments
 (0)