VS Code Tips - Revision history

Emilie Nielsen at 02:03, 8 January 2026

2026-01-08T02:03:14Z

← Older revision		Revision as of 12:03, 8 January 2026
Line 65:		Line 65:
	<br>{{Video\|name=Animation_geo_data_viewer.mp4\|width=900}}		<br>{{Video\|name=Animation_geo_data_viewer.mp4\|width=900}}
	<br>		<br>


			{{Tips Navigation
			\|uplink=[[Main_Page\| Back to Main Page]]
			}}

Emilie Nielsen: /* File Navigation */

2024-04-05T00:52:51Z

File Navigation

← Older revision		Revision as of 10:52, 5 April 2024
Line 20:		Line 20:
	*Select File > Open Folder and navigate to the model folder. This will open the model folder into the 'Explorer' panel.		*Select File > Open Folder and navigate to the model folder. This will open the model folder into the 'Explorer' panel.
	*Now, from the Explorer panel, it is possible to navigate through the model folders and edit control files.		*Now, from the Explorer panel, it is possible to navigate through the model folders and edit control files.
	*Using the <u>[https://~~wiki~~.~~tuflow~~.com/~~w/index.php~~?~~title~~=~~VS_Code_Tips&action=submit#Open_File~~ Open File]</u> plugin, it is possible to easily navigate between files.		*Using the <u>[https://marketplace.visualstudio.com/items?itemName=Fr43nk.seito-openfile Open File]</u> plugin, it is possible to easily navigate between files.
	<br>		<br>
	{{Video\|name=Animation_file_navigation.mp4\|width=900}}		{{Video\|name=Animation_file_navigation.mp4\|width=900}}

Emilie Nielsen: /* Other Useful Plugins */

2023-12-04T06:27:32Z

Other Useful Plugins

← Older revision		Revision as of 16:27, 4 December 2023
Line 61:		Line 61:
	:*Geo Data Viewer by Random Fractals inc is a free plugin available for download <u>[https://marketplace.visualstudio.com/items?itemName=RandomFractalsInc.geo-data-viewer here]</u>.		:*Geo Data Viewer by Random Fractals inc is a free plugin available for download <u>[https://marketplace.visualstudio.com/items?itemName=RandomFractalsInc.geo-data-viewer here]</u>.
	:*Has the ability to view a map of GIS layers right inside of VS Code. This is helpful for double checking that the layer looks correct without loading it into a GIS application.		:*Has the ability to view a map of GIS layers right inside of VS Code. This is helpful for double checking that the layer looks correct without loading it into a GIS application.
			:*An example of its functionality is shown below.
	<b>Note:</b> This extension only supports certain file formats, including Shapefile. It does not support GeoPackage or GeoTiff files.		<b>Note:</b> This extension only supports certain file formats, including Shapefile. It does not support GeoPackage or GeoTiff files.
			<br>{{Video\|name=Animation_geo_data_viewer.mp4\|width=900}}
			<br>

Emilie Nielsen: /* Other Useful Plugins */

2023-12-04T06:12:10Z

Other Useful Plugins

← Older revision		Revision as of 16:12, 4 December 2023
Line 46:		Line 46:
	<br>{{Video\|name=Animation_OpenFile.mp4\|width=900}}		<br>{{Video\|name=Animation_OpenFile.mp4\|width=900}}
	<br>		<br>

	===Path Autocomplete===		===Path Autocomplete===
	:*Path Autocomplete by Mihai Vilcu is a free plugin available for download <u>[https://marketplace.visualstudio.com/items?itemName=ionutvmi.path-autocomplete here]</u>.		:*Path Autocomplete by Mihai Vilcu is a free plugin available for download <u>[https://marketplace.visualstudio.com/items?itemName=ionutvmi.path-autocomplete here]</u>.
Line 53:		Line 54:
	:<li>Toggle on the 'Trigger Outside Strings' in the settings on the right.		:<li>Toggle on the 'Trigger Outside Strings' in the settings on the right.
	</ol>		</ol>
	:*An example of its functionality is shown below. ~~<br>~~		:*An example of its functionality is shown below.
	{{Video\|name=\|width=~~1000~~}}~~<br>~~		<br>{{Video\|name=Animation_path_autocomplete.mp4\|width=900}}
			<br>

	===Geo Data Viewer===		===Geo Data Viewer===
	:*Geo Data Viewer by Random Fractals inc is a free ~~pluggin~~ available for download <u>[https://marketplace.visualstudio.com/items?itemName=RandomFractalsInc.geo-data-viewer here]</u>.		:*Geo Data Viewer by Random Fractals inc is a free plugin available for download <u>[https://marketplace.visualstudio.com/items?itemName=RandomFractalsInc.geo-data-viewer here]</u>.
	:*Has the ability to view a map of GIS layers right inside of VS Code. This is helpful for double checking that the layer looks correct without loading it into a GIS application.		:*Has the ability to view a map of GIS layers right inside of VS Code. This is helpful for double checking that the layer looks correct without loading it into a GIS application.
	<b>Note:</b> This extension only supports certain file formats, including Shapefile. It does not support GeoPackage or GeoTiff files.		<b>Note:</b> This extension only supports certain file formats, including Shapefile. It does not support GeoPackage or GeoTiff files.

Emilie Nielsen: /* Path Autocomplete */

2023-12-04T06:08:18Z

Path Autocomplete

← Older revision		Revision as of 16:08, 4 December 2023
Line 53:		Line 53:
	:<li>Toggle on the 'Trigger Outside Strings' in the settings on the right.		:<li>Toggle on the 'Trigger Outside Strings' in the settings on the right.
	</ol>		</ol>
			:*An example of its functionality is shown below. <br>
			{{Video\|name=\|width=1000}}<br>

	===Geo Data Viewer===		===Geo Data Viewer===
	:*Geo Data Viewer by Random Fractals inc is a free pluggin available for download <u>[https://marketplace.visualstudio.com/items?itemName=RandomFractalsInc.geo-data-viewer here]</u>.		:*Geo Data Viewer by Random Fractals inc is a free pluggin available for download <u>[https://marketplace.visualstudio.com/items?itemName=RandomFractalsInc.geo-data-viewer here]</u>.

Emilie Nielsen: /* Other Useful Plugins */

2023-12-03T23:49:46Z

Other Useful Plugins

← Older revision		Revision as of 09:49, 4 December 2023
Line 41:		Line 41:
	In addition to the TUFLOW plugin, some useful plugins for working with TUFLOW include: <br>		In addition to the TUFLOW plugin, some useful plugins for working with TUFLOW include: <br>
	===Open File===		===Open File===
	:*Open File by Frank Stuetzer or similar is a free plugin available for download [https://marketplace.visualstudio.com/items?itemName=Fr43nk.seito-openfile here].		:*Open File by Frank Stuetzer or similar is a free plugin available for download <u>[https://marketplace.visualstudio.com/items?itemName=Fr43nk.seito-openfile here]</u>.
	:*Right-click on a filename and select 'Open file under cursor'. If the file is found by VS Code, then the selected file will open in a new tab.		:*Right-click on a filename and select 'Open file under cursor'. If the file is found by VS Code, then the selected file will open in a new tab.
	:*To open multiple files, hold down Alt while selecting the filenames, then right click and select 'Open file under cursor'. If the files are found by VS Code, then the selected files will each open in a new tab.		:*To open multiple files, hold down Alt while selecting the filenames, then right click and select 'Open file under cursor'. If the files are found by VS Code, then the selected files will each open in a new tab.
Line 47:		Line 47:
	<br>		<br>
	===Path Autocomplete===		===Path Autocomplete===
	:*Path Autocomplete by Mihai Vilcu is a free plugin available for download [https://marketplace.visualstudio.com/items?itemName=ionutvmi.path-autocomplete here].		:*Path Autocomplete by Mihai Vilcu is a free plugin available for download <u>[https://marketplace.visualstudio.com/items?itemName=ionutvmi.path-autocomplete here]</u>.
	:*Adds auto-complete when it determines a filename is being written. For this feature to work, set the 'triggerOutsideStrings' to true (as described in the plugin details). <br>		:*Adds auto-complete when it determines a filename is being written. For this feature to work, set the 'triggerOutsideStrings' to true (as described in the plugin details). <br>
	<ol>		<ol>
Line 54:		Line 54:
	</ol>		</ol>
	===Geo Data Viewer===		===Geo Data Viewer===
	:*Geo Data Viewer by Random Fractals inc is a free pluggin available for download [https://marketplace.visualstudio.com/items?itemName=RandomFractalsInc.geo-data-viewer here].		:*Geo Data Viewer by Random Fractals inc is a free pluggin available for download <u>[https://marketplace.visualstudio.com/items?itemName=RandomFractalsInc.geo-data-viewer here]</u>.
	:*Has the ability to view a map of GIS layers right inside of VS Code. This is helpful for double checking that the layer looks correct without loading it into a GIS application.		:*Has the ability to view a map of GIS layers right inside of VS Code. This is helpful for double checking that the layer looks correct without loading it into a GIS application.
	<b>Note:</b> This extension only supports certain file formats, including Shapefile. It does not support GeoPackage or GeoTiff files.		<b>Note:</b> This extension only supports certain file formats, including Shapefile. It does not support GeoPackage or GeoTiff files.

Emilie Nielsen: /* Running TUFLOW */

2023-12-03T23:49:06Z

Running TUFLOW

← Older revision		Revision as of 09:49, 4 December 2023
Line 27:		Line 27:

	==Running TUFLOW==		==Running TUFLOW==
	To run TUFLOW through VS Code, the [https://marketplace.visualstudio.com/items?itemName=NilsSoderman.batch-runner Batch Runner] extension is required. Once installed, TUFLOW can be run by either:		To run TUFLOW through VS Code, the <u>[https://marketplace.visualstudio.com/items?itemName=NilsSoderman.batch-runner Batch Runner]</u> extension is required. Once installed, TUFLOW can be run by either:
	*Right clicking the batch file in the explorer panel and selecting 'Run Batch File', or		*Right clicking the batch file in the explorer panel and selecting 'Run Batch File', or
	<br>		<br>

Emilie Nielsen: /* File Navigation */

2023-12-03T23:48:47Z

File Navigation

← Older revision		Revision as of 09:48, 4 December 2023
Line 20:		Line 20:
	*Select File > Open Folder and navigate to the model folder. This will open the model folder into the 'Explorer' panel.		*Select File > Open Folder and navigate to the model folder. This will open the model folder into the 'Explorer' panel.
	*Now, from the Explorer panel, it is possible to navigate through the model folders and edit control files.		*Now, from the Explorer panel, it is possible to navigate through the model folders and edit control files.
	*Using the '[https://wiki.tuflow.com/w/index.php?title=VS_Code_Tips&action=submit#Open_File Open File]' plugin, it is possible to easily navigate between files.		*Using the <u>[https://wiki.tuflow.com/w/index.php?title=VS_Code_Tips&action=submit#Open_File Open File]</u> plugin, it is possible to easily navigate between files.
	<br>		<br>
	{{Video\|name=Animation_file_navigation.mp4\|width=900}}		{{Video\|name=Animation_file_navigation.mp4\|width=900}}

Emilie Nielsen: /* Install TUFLOW Plugin */

2023-12-03T23:48:29Z

Install TUFLOW Plugin

← Older revision		Revision as of 09:48, 4 December 2023
Line 7:		Line 7:
	The TUFLOW plugin provides syntax highlighting support. <b>Thanks to Daniel Copelin for creating the TUFLOW plugin.</b> One feature of VS Code is that it includes an explorer window from a root folder, so it is easy to navigate the files within a project.<br>		The TUFLOW plugin provides syntax highlighting support. <b>Thanks to Daniel Copelin for creating the TUFLOW plugin.</b> One feature of VS Code is that it includes an explorer window from a root folder, so it is easy to navigate the files within a project.<br>
	==Install TUFLOW Plugin==		==Install TUFLOW Plugin==
	The TUFLOW ~~plugin~~ can be installed like any other VS Code plugins. In the VS Code application:		The <u>[https://marketplace.visualstudio.com/items?itemName=danielcopelin.tuflow TUFLOW Plugin]</u> can be installed like any other VS Code plugins. In the VS Code application:
	<ol>		<ol>
	<li>Select 'Extensions' from the toolbar on the right-hand side.		<li>Select 'Extensions' from the toolbar on the right-hand side.

Emilie Nielsen: /* Introduction */

2023-12-03T23:46:34Z

Introduction

← Older revision		Revision as of 09:46, 4 December 2023
Line 1:		Line 1:
	=Introduction=		=Introduction=
	Visual Studio Code (commonly referred to as VS Code) is a free source code editor developed by Microsoft. It can be downloaded [https://code.visualstudio.com/Download here]. It supports a variety of file types and can be used to work with TUFLOW control files.		Visual Studio Code (commonly referred to as VS Code) is a free source code editor developed by Microsoft. It can be downloaded <u>[https://code.visualstudio.com/Download here]</u>. It supports a variety of file types and can be used to work with TUFLOW control files.
	Thousands of free plugins exist for VS Code and some of them are useful when working with TUFLOW models.<br>		Thousands of free plugins exist for VS Code and some of them are useful when working with TUFLOW models.<br>
	<br>		<br>