ZHAW-IT21b_WIN
/
gruppe06-hufflepuff-projekt2-texteditor
3
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

changes in README.md

This commit is contained in:
schrom01 2021-11-12 15:15:38 +01:00
parent e64590d931
commit 35f92874a8
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -3,26 +3,26 @@ Texteditor is a program to edit a text by using the input and is then able to ou
#Usermanual #Usermanual
#ADD a paragraph #ADD a paragraph
```ADD``` ```ADD```
Adds custom text to the last paragraph.<br/> <br/> Adds a paragraph with custom text.<br/> <br/>
Enter the command add to add a new paragraph at the end of text. After submitting the add command you will be prompted to enter the text to add as last paragraph. Enter the command add to add a new paragraph at the end of text. After submitting the add command you will be prompted to enter the text to add as last paragraph.
```ADD [n]``` ```ADD [n]```
Adds custom text to the desired paragraph.<br/> <br/> Adds a paragraph with custom text at a specific position in text.<br/> <br/>
Enter the command add with the paragraph number where it should be added. Enter the command add with the paragraph number where it should be added.
After submitting the add [n] command you will be prompted to enter the text to add in the corresponding paragraph. After submitting the add [n] command you will be prompted to enter the text to add in the corresponding paragraph.
#DUMMY Text #DUMMY Text
```DUMMY``` ```DUMMY```
Inserts a dummy text at the end of the text.<br/> <br/> Inserts a paragraph with dummy text at the end of the text.<br/> <br/>
Enter the command dummy to enter a pre-written paragraph into the text as your last paragraph. Enter the command dummy to enter a pre-written paragraph into the text as your last paragraph.
```DUMMY [n]``` ```DUMMY [n]```
Inserts a dummy text in the selected paragraph.<br/> <br/> Inserts a paragraph with dummy text at a specific position.<br/> <br/>
Enter the command dummy with a paragraph number to insert a pre-written dummy text in the corresponding paragraph. Enter the command dummy with a paragraph number to insert a pre-written dummy text paragraph to a spcific position.
#REPLACE a Text #REPLACE a Text
```REPLACE``` ```REPLACE```
Replaces desired words in the whole text with a desired replacement.<br/> <br/> Replaces desired words in the last paragraph with a desired replacement.<br/> <br/>
Enter the command replace, after submitting the command replace enter the characters that should be replaced. After submitting the characters you will be Enter the command replace, after submitting the command replace enter the characters that should be replaced. After submitting the characters you will be
need to input the characters wich will replace the previous characters. need to input the characters wich will replace the previous characters.
@ -44,13 +44,13 @@ Enter the command del with a paragraph number, the corresponding paragraph will
#INDEX the words #INDEX the words
```INDEX``` ```INDEX```
Diplays the index of words used 3 times or more.<br/> <br/> Diplays the index of words used 3 times or more.<br/> <br/>
Enter the command index to display the words that are displayed more than three times in a paragraph with their corresponding paragraphs. Enter the command index to display the words that are displayed more than three times in the text with their corresponding paragraphs.
#Print the Text #Print the Text
```PRINT``` ```PRINT```
Prints the text with the previously set format option.<br/> <br/> Prints the text with the previously set format option.<br/> <br/>
Enter the command print to print out the current text you have. The Text will be printed with the settings set before (see FORMAT the Text). Enter the command print to print out the current text you have. The Text will be printed with the settings set before (see FORMAT the Text).
If no settings have been set the standard to output is the RAW format. If no settings have been set the standard to output is the FIX format and a line length of 20.
#FORMAT the Text #FORMAT the Text
```FORMAT RAW``` ```FORMAT RAW```
@ -62,5 +62,5 @@ and each paragraph will be printed on one line with its corresponding paragraph
Sets the format fix with the maximum line length.<br/> <br/> Sets the format fix with the maximum line length.<br/> <br/>
Enter the command format fix and the max line length which will be used. After you changed the format to fix you can use the command ```PRINT``` again Enter the command format fix and the max line length which will be used. After you changed the format to fix you can use the command ```PRINT``` again
and the text will be displayed with the max length in mind and a new line will be created if no space is left for a paragraph. and the text will be displayed with the max length in mind and a new line will be created if no space is left for a paragraph.
If the word is too long to fit the paragraph it will be displayed as whole, ignoring the max length. If a word is too long to fit the line length, it will be displayed as whole, ignoring the max length.