Skip to content
This repository has been archived by the owner on Oct 15, 2024. It is now read-only.

Commit

Permalink
RENAME: updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tom-wa committed Apr 24, 2016
1 parent 888412a commit 28cf3c1
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 1 deletion.
28 changes: 28 additions & 0 deletions src/plugins/rename/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 ##

Expand Down
2 changes: 1 addition & 1 deletion src/plugins/rename/rename.c
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* \file
* @file
*
* \brief A plugin that converts keys to metakeys and vice versa
*
Expand Down

0 comments on commit 28cf3c1

Please sign in to comment.