|
| 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!) |
0 commit comments