Skip to content

Commit

Permalink
Documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
Thomilist committed Sep 13, 2022
1 parent 34dcdff commit 76ac720
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 20 deletions.
31 changes: 13 additions & 18 deletions include/Settings.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -201,31 +201,31 @@ namespace mcon
<< STR("MathML X\n")
<< STR("UnicodeMath X\n")
<< STR("\n")
<< STR(" Command Command aliases Possible arguments Example\n")
<< STR(" Command Command aliases Possible arguments Example\n")
<< STR("----------------------------------------------------------------------------------------------------\n")
<< STR("1. Show help h help ? [no arguments] h\n")
<< STR("1. Show help h help ? [no arguments] h\n")
<< STR("\n")
<< STR("2. Show current settings s show settings [no arguments] s\n")
<< STR("2. Show current settings s show settings [no arguments] s\n")
<< STR("\n")
<< STR("3. Open user guide g guide userguide [no arguments] g\n")
<< STR("3. Open user guide g guide userguide [no arguments] g\n")
<< STR("\n")
<< STR("4. Open download page download [no arguments] download\n")
<< STR("4. Open download page download [no arguments] download\n")
<< STR("\n")
<< STR("5. Set update checking check enabled true check false\n")
<< STR("5. Set update checking check enabled true check false\n")
<< STR(" disabled false\n")
<< STR("\n")
<< STR("6. Set decimal separator d dec ds sep period . d ,\n")
<< STR("6. Set decimal separator d dec ds sep period . d ,\n")
<< STR(" comma ,\n")
<< STR("\n")
<< STR("7. Set output mode m mode keys keystrokes m clip\n")
<< STR("7. Set output mode m mode keys keystrokes m clip\n")
<< STR(" clip clipboard\n")
<< STR("\n")
<< STR("8. Set input format i in input Mathcad mathcad i mathcad\n")
<< STR("8. Set input format i in input mathcad i mathcad\n")
<< STR("\n")
<< STR("9. Set output format o out output Mathcad mathcad o latex\n")
<< STR(" LaTeX Latex latex\n")
<< STR(" MathML mathml\n")
<< STR(" UnicodeMath unicodemath Unicode unicode\n")
<< STR("9. Set output format o out output mathcad o latex\n")
<< STR(" latex\n")
<< STR(" mathml\n")
<< STR(" unicodemath unicode\n")
<< STR("\n")
<< std::endl;

Expand Down Expand Up @@ -343,12 +343,7 @@ namespace mcon

void Settings::ToLowerCase(String& a_string)
{
#ifdef WIN32
std::transform(a_string.begin(), a_string.end(), a_string.begin(), std::towlower);
#else
std::transform(a_string.begin(), a_string.end(), a_string.begin(), std::tolower);
#endif

return;
}
}
6 changes: 4 additions & 2 deletions userguide.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,8 @@ The supported input character set can be extended with additional, user-made `.j
- Set input format
- Set output format

All configuration commands are case-insensitive. Should the user enter a non-ASCII character in a command, it may cause an "unknown character" error. The error message may specify that "the character was not found in any of the supplied character sets". The character sets referred to in the error message have nothing do with with the character sets in `/resources/character-sets/`. Indeed, the error message should be of no concern, since none of the commands use characters from outside the ASCII set.

### Show help

This command displays help about the configuration commands.
Expand Down Expand Up @@ -133,15 +135,15 @@ Example: `m clip`
This command sets the input format. This is the format of the source math that the user copies to the clipboard. If the clipboard contents do not correspond to the input format setting, math-converter will not function correctly.

Command aliases: `i in input`<br>
Available arguments: `Mathcad mathcad`<br>
Available arguments: `mathcad`<br>
Example: `i mathcad`

### Set output format

This command sets the output format. This is the math format to convert to for use at the destination.

Command aliases: `o out output`<br>
Available arguments: `Mathcad mathcad LaTeX Latex latex MathML mathml UnicodeMath unicodemath Unicode unicode`<br>
Available arguments: `mathcad latex mathml unicodemath unicode`<br>
Example: `o latex`

## Contact
Expand Down

0 comments on commit 76ac720

Please sign in to comment.