Differences

This shows you the differences between two versions of the page.

--- visual3d:documentation:pipeline:file_commands:file_rename [2024/06/19 12:50] – sgranger
+++ visual3d:documentation:pipeline:file_commands:file_rename [2024/07/17 15:45] (current) – created sgranger
@@ Line 1: / Line 1: @@
-{{\\
+====== File Rename ======
-renames the specified file(s). this can also be done manually by going to file->rename.
-|<code>\\ file_rename\\ ! /existing_file_name=all_files\\ ! /new_file_name=\\ ! /use_search_replace=false\\ ! /search_for=\\ ! /replace_with=\\ ! /remove_file_path=false\\ ! /rename_static_calibration_files=true\\ ; \\ </code>  |  filerenamedialog.png|
+\\
+Renames the specified file(s). This can also be done manually by going to File->Rename.
+|<code>\\ File_Rename\\ ! /EXISTING_FILE_NAME=ALL_FILES\\ ! /NEW_FILE_NAME=\\ ! /USE_SEARCH_REPLACE=FALSE\\ ! /SEARCH_FOR=\\ ! /REPLACE_WITH=\\ ! /REMOVE_FILE_PATH=FALSE\\ ! /RENAME_STATIC_CALIBRATION_FILES=TRUE\\ ; \\ </code>  |  {{:FileRenameDialog.png}}|
 \\
-==== parameters ====
+=== Parameters ===
-  * **existing_file_name:** all_files can be specified here, or an individual c3d file can be selected\\
+  * **EXISTING_FILE_NAME:** ALL_FILES can be specified here, or an individual C3D file can be selected\\
-  * **new_file_name:** if renaming an individual c3d file, the new name can be specified here\\
+  * **NEW_FILE_NAME:** If renaming an individual C3D file, the new name can be specified here\\
-  * **use_search_replace:** specify true or false to use the search/replace function. this must be used in conjunction with the search_for and replace_with parameters.\\
+  * **USE_SEARCH_REPLACE:** Specify TRUE or FALSE to use the search/replace function. This must be used in conjunction with the SEARCH_FOR and REPLACE_WITH parameters.\\
-  * **search_for:** specifies what text will be removed. this must be used in conjunction with the replace_with and replace_with parameters.\\
+  * **SEARCH_FOR:** Specifies what text will be removed. This must be used in conjunction with the REPLACE_WITH and REPLACE_WITH parameters.\\
-  * **replace_with:** specifies what text will be put in place of "search_for" text. this must be used in conjunction with the search_for and use_search_replace parameters.\\
+  * **REPLACE_WITH:** Specifies what text will be put in place of "SEARCH_FOR" text. This must be used in conjunction with the SEARCH_FOR and USE_SEARCH_REPLACE parameters.\\
-  * **remove_file_path:** specify true or false to remove file path.
+  * **REMOVE_FILE_PATH:** Specify TRUE or FALSE to remove file path.
-**note:** since users use similar naming conventions for c3d files, visual3d stores the file path from where the c3d file was original loaded to differentiate between different files. only remove the file path if you have a very good reason, and if you do, be careful when comparing between subjects, sessions, conditions, etc.\\
+**NOTE:** Since users use similar naming conventions for C3D files, Visual3D stores the file path from where the C3D file was original loaded to differentiate between different files. Only remove the file path if you have a very good reason, and if you do, be careful when comparing between subjects, sessions, conditions, etc.\\
-  * **rename_static_calibration_files:**specify true or false to also perform search/replace on the static trial.\\
+  * **RENAME_STATIC_CALIBRATION_FILES:**Specify TRUE or FALSE to also perform search/replace on the static trial.\\
-==== example1: search/replace ====
+=== Example1: Search/Replace ===
-the search/replace function in this command can be used to rename the c3d files in the workspace.
+The search/replace function in this command can be used to rename the C3D files in the workspace.
-in the following example, the c3d files have the name "sub01_walk001.c3d" but they are renamed to "sub01_new_name001.c3d".
+In the following example, the C3D files have the name "Sub01_Walk001.c3d" but they are renamed to "Sub01_NEW_NAME001.c3d".
 <code>
-file_rename
+File_Rename
-! /existing_file_name=all_files
+! /EXISTING_FILE_NAME=ALL_FILES
-! /new_file_name=
+! /NEW_FILE_NAME=
-/use_search_replace=true
+/USE_SEARCH_REPLACE=TRUE
-/search_for=walk
+/SEARCH_FOR=WALK
-/replace_with=new_name
+/REPLACE_WITH=NEW_NAME
-! /remove_file_path=false
+! /REMOVE_FILE_PATH=FALSE
-! /rename_static_calibration_files=true
+! /RENAME_STATIC_CALIBRATION_FILES=TRUE
 ;
 </code>
 \\
-[[visual3d:documentation:pipeline:general_information:pipeline_commands_reference|back to pipeline commands reference]]
+[[Visual3D:Documentation:Pipeline:General_Information:Pipeline_Commands_Reference|Back to Pipeline Commands Reference]]
-}}