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

improved the README.md

This commit is contained in:
Leonardo Brandenberger 2021-11-12 10:54:37 +01:00
parent ba6046ac93
commit ed97f2300c
1 changed files with 43 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

84
README.md
View File

@ -1,64 +1,66 @@
# Texteditor
Texteditor is a program to edit a text by in- and output into the console.
# Usermanual
# ADD a paragraph
#Texteditor
Texteditor is a program to edit a text by using the input and is then able to output it as desired via the console.
#Usermanual
#ADD a paragraph
```ADD```
First please enter the command add to add a new paragraph at the end of text. Then enter the text you want to add .
Adds custom text to the last paragraph.<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.
```ADD [n]```
If you want to add a paragraph between existing paragraphs then please use the command add and then enter the
paragraphnumber it should get. After that enter the text you want to add to that paragraph.
# DUMMY Text
Adds custom text to the desired paragraph.<br/> <br/>
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.
#DUMMY Text
```DUMMY```
First please enter the command dummy to enter a pre written paragraph into the text.
Inserts a 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.
```DUMMY [n]```
If you want to enter a pre written dummy paragraph between existing paragraphs then please enter the command dummy and
then enter the paragraphnumber it should get.
# REPLACE a Text
Inserts a dummy text in the selected paragraph.<br/> <br/>
Enter the command dummy with a paragraph number to insert a pre-written dummy text in the corresponding paragraph.
#REPLACE a Text
```REPLACE```
First please enter the command replace then enter the characters that you want to replace. After that please enter the
new characters that should replace the old characters. If don't enter a paragraphnumber, the change will be made in the
last paragraph.
Replaces desired words in the whole text 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
need to input the characters wich will replace the previous characters.
```REPLACE [n]```
If you want to replace a text from a specific paragraph, please enter the command and the paragraphnumber and then enter
the characters you want to replace. After you entered the characters you want to replace please enter now the new
characters that should replace the old characters.
# DELETE a Text
Replaces desired words in the chosen paragraph [n] text with a desired replacement.<br/> <br/>
Enter the command replace with a desired paragraph where the characters should be replaced,
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.
#DELETE a Text
```DEL```
First please enter the command del to delete the last paragraph.
Deletes the last paragraph.<br/> <br/>
Enter the command del to delete the last paragraph.
```DEL [n]```
If you want to delete a specific paragraph then please enter the command del and then the paragraph you want to delete.
# INDEX
Deletes the selected paragraph.<br/> <br/>
Enter the command del with a paragraph number, the corresponding paragraph will then be deleted.
#INDEX the words
```INDEX```
Please enter the command index to show the index.
# PRINT the Text
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.
#Print the Text
```PRINT```
Please enter the command print to print out the current text you have. To change the output format, use the
commands ```FORMAT FIX``` and ```FORMAT RAW```
# FORMAT the Text
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).
If no settings have been set the standard to output is the RAW format.
#FORMAT the Text
```FORMAT RAW```
Please enter the command format raw to change the print format to raw. After you changed the format to raw, each
paragraph will be printed on one line with it's paragraph number.
Sets the format to raw.<br/> <br/>
Enter the command format raw to change the print format to raw. After you changed the format to raw you can use the command ```PRINT``` again
and each paragraph will be printed on one line with its corresponding paragraph number.
```FORMAT FIX [n]```
Please enter the command format fix and the line length which should be used. After you changed the format to fix, the
defined line length will be used to print the text.
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
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.