From 3a0bb20e873865b628d6c8ce94e98047eb98f13b Mon Sep 17 00:00:00 2001 From: Thomas Waser Date: Sun, 24 Apr 2016 08:39:42 +0200 Subject: [PATCH] RENAME: updated README.md --- src/plugins/rename/README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/src/plugins/rename/README.md b/src/plugins/rename/README.md index 3bcb22e350c..1b7e30b89d4 100644 --- a/src/plugins/rename/README.md +++ b/src/plugins/rename/README.md @@ -16,6 +16,34 @@ with the required names or case. If keys are renamed, their original name is stored in the `origname` MetaKey. +There are 2 types of transformations: +* basic +* advanced + + +## BASIC TRANSFORMATIONS ## + +are applied before and after the advanced transformations. + +### GET ### +`get/case` +* toupper +* tolower +* unchanged // this is the default value if no configuration is given +converts the whole keyname below the parentKey to upper- or lowercase. if no configuration or `unchanged` is used no transformation is done here. + +### SET ### +`set/case` +* toupper +* tolower +* keyname +* unchanged // this is the default value if no configuration is given + +`toupper` or `tolower` tells the rename plugin to convert the whole keyname below below the parentKey to lower or uppercase. +`unchanged` returnes the key to it's original name +`keyname` tells the plugin to keep the name of the advanced transformation + +## ADVANCED TRANSFORMATIONS ## ## CUT ##