Dgarratt: Updated by push_wiki.py

2026-04-01T15:28:43Z

Updated by push_wiki.py

← Older revision		Revision as of 17:28, 1 April 2026
Line 7:		Line 7:
	== Running TreeDoc ==		== Running TreeDoc ==

	TreeDoc is a Java 21 desktop (Swing) application:		Native install packages for Windows, macOS, and Linux are available from the [[Downloads]] page and are the preferred installation method.

			Alternatively, TreeDoc can be run directly from the distribution archive. It is a Java 21 desktop (Swing) application:

	java -jar Tree.jar		java -jar Tree.jar

Dgarratt: Updated by push_wiki.py

2026-04-01T11:29:49Z

Updated by push_wiki.py

← Older revision		Revision as of 13:29, 1 April 2026
Line 1:		Line 1:
	TreeDoc ~~was created to make the process of documenting~~ folder ~~structures easier. You can~~ select ~~the folder structure root that you want to display~~ and it ~~will generate~~ a text ~~representation of the folder structure~~. ~~You~~ can ~~then copy it~~ to the clipboard or ~~save to~~ a file.		TreeDoc is a desktop utility that generates an ASCII directory tree from a folder you select and displays it in a scrollable text window. The output can be copied to the clipboard or saved as a plain text file.

	~~[[File~~:~~TreeDoc1~~.~~png~~\|~~link~~=\|~~border~~\|~~800px~~]]		== Purpose ==

			TreeDoc is useful for producing a human-readable snapshot of a folder structure — for example, documenting a Commander4j installation layout, comparing the contents of two directories, or quickly exploring an unfamiliar project. The output uses box-drawing characters (├──, └──, │) to show the hierarchy clearly in any monospace environment.

			== Running TreeDoc ==

			TreeDoc is a Java 21 desktop (Swing) application:

			java -jar Tree.jar

			The window opens at 900 × 750 pixels.

			== Generating a Tree ==

			# Click '''Browse''' to choose the root folder, or type a path directly into the folder field.
			# Adjust '''Max Depth''' and '''Max Entries''' if needed (see below).
			# Check '''Include Files''' if you want files shown alongside directories.
			# Click '''Refresh''' to generate the tree.

			The output appears in the central text area. The status bar at the bottom shows the total number of entries printed, and indicates if the output was truncated.

			== Options ==

			{\| class="wikitable"
			\|-
			! Option !! Default !! Description
			\|-
			\| Max Depth \|\| 9999 \|\| Maximum folder depth to traverse. Set to a small number (e.g. 3) to get a high-level overview of a deep tree.
			\|-
			\| Max Entries \|\| 10,000 \|\| Maximum number of lines to print. Prevents the output from becoming unmanageable for very large trees.
			\|-
			\| Include Files \|\| Off \|\| When off, only directory names are shown. When on, files are listed inside their parent directory.
			\|}

			== Output Format ==

			The output is plain UTF-8 text using box-drawing characters:

			project/
			├── src/
			│ ├── main/
			│ └── test/
			├── docs/
			└── build.xml

			Directories are always included. Files appear indented under their parent directory when '''Include Files''' is enabled.

			=== What is Excluded ===

			The following are always omitted regardless of settings:

			* Hidden files and folders (system hidden flag)
			* <code>.DS_Store</code> and <code>.localized</code> (macOS metadata)
			* <code>.app</code> bundles (macOS application packages)
			* Symbolic links (skipped to prevent infinite loops)

			== Saving and Copying Output ==

			The right sidebar provides:

			* '''Save''' — save the output as a <code>.txt</code> file (default filename: <code>tree.txt</code>, UTF-8 encoded)
			* '''Clipboard''' — copy the entire output to the system clipboard
			* '''Clear''' — clear the output area

			== Configuration ==

			TreeDoc saves your last-used folder path and the Include Files checkbox state to <code>xml/config/config.xml</code> automatically on exit. These are restored the next time the application opens.

			If the saved folder path no longer exists, TreeDoc prompts you to choose a new folder on startup.

			== Log Files ==

			Activity is written to <code>logs/TreeDoc.log</code>. Log files rotate at 10 MB and are retained for 14 days.

			See also: [[XML Viewer]], [[Menu4j]], [[Downloads]]

			[[Category:Commander4j]]

Dgarratt at 19:07, 13 September 2025

2025-09-13T19:07:50Z

← Older revision		Revision as of 21:07, 13 September 2025
Line 1:		Line 1:
	TreeDoc was created to make the process of documenting folder structures easier.		TreeDoc was created to make the process of documenting folder structures easier. You can select the folder structure root that you want to display and it will generate a text representation of the folder structure. You can then copy it to the clipboard or save to a file.


	[[File:TreeDoc1.png\|link=\|border\|800px]]		[[File:TreeDoc1.png\|link=\|border\|800px]]

Dgarratt at 19:06, 13 September 2025

2025-09-13T19:06:14Z

← Older revision		Revision as of 21:06, 13 September 2025
Line 1:		Line 1:
	TreeDoc was created to make the process of documenting folder structures easier.		TreeDoc was created to make the process of documenting folder structures easier.


			[[File:TreeDoc1.png\|link=\|border\|800px]]

Dgarratt: Created page with "TreeDoc was created to make the process of documenting folder structures easier."

2025-09-12T11:49:39Z

Created page with "TreeDoc was created to make the process of documenting folder structures easier."

New page

TreeDoc was created to make the process of documenting folder structures easier.

TreeDoc - Revision history

Dgarratt: Updated by push_wiki.py

Dgarratt: Updated by push_wiki.py

Dgarratt at 19:07, 13 September 2025

Dgarratt at 19:06, 13 September 2025

Dgarratt: Created page with "TreeDoc was created to make the process of documenting folder structures easier."