Without going into too much detail, a command-method is a method which lives in "ConsoleCommands.cs". They are, also, the commands the end-user will enter into the console's prompt at run-time. Instead of duplicating information, I will provide you with a link to the Console.Waterworks (C.W.) wiki. It contains a more comprehensive write-up about what command-methods are. The link for that is as follows:
- ["Writing Command-Methods" Wiki Page in Console.Waterworks Repository](https://gitlab.com/craig.oates/Console.Waterworks/wikis/Writing-Command-Methods)
- ["Writing Command-Methods" Wiki Page in Console.Waterworks Repository](https://git.abbether.net/craig.oates/Console.Waterworks/wikis/Writing-Command-Methods)
You can see what command-methods are included with WetPancakeCLI by reading the source code in "ConsoleCommands.cs". You can do that by using the following link:
I have, also, provided examples in the "Snippets" section to help explain what they are. Feel free to copy the stubbed out code examples, in "Snippets". It should help reduce the amount of boilerplate code you need to write. The link for Snippets is as follows:
Up above, I said command-methods are the names of the commands the end-user enters into the console at run-time. To help explain what I mean, please consider the following image.
@ -17,9 +17,9 @@ For the best results, I recommend you stick to the following guidelines:
To get a sense of how a template (.txt) file should look, you can read the files W.P. already uses, The link for the folder they are kept in is as follows:
A good way to see the types of results these files create is by using "Script.fsx" with F# Interactive (FSI). You can, also, use the console project (WetPancakeCLI) which is another project within the repository. More information for both is available at:
@ -23,7 +23,7 @@ That snippet of code is all what is in "Program.cs". Once you know what is happe
What is happening is a new `CW_Liaison` object is created and is told to `run`. This is where C.W. creates the input-loop which runs indefinitely until the end-user closes the console (or the program crashes). The first argument passed into `run` refers to the name-space of the `ConsoleCommands` class. In this case it is `WetPancakeCLI`. The second one refers to the information displayed in the console when you run it. When set to `true`, the console displays information found in "AssemblyInfo.cs". If you use `false`, the only thing you will see is the prompt. You can check the name-space of the `ConsoleCommand` class via the following link:
@ -31,4 +31,4 @@ What is happening is a new `CW_Liaison` object is created and is told to `run`.
How C.W. creates and manages the input-loop is out of this wiki's scope. Although, if you would like to know more about how is is created, you can use the following link:
Welcome to the wiki of Wet Pancake. The aim of this wiki is to teach you how to use Wet Pancake -- as a NuGet package and command-line interface (C.L.I.). If you want to work within the repositories source code, this wiki will, also, show you how to do that. Feel free to use the sidebar, on the right, or the links below to navigate to the section you want.
@ -15,7 +15,7 @@ Before continuing, I recommend you are familiar with the following:
@ -12,10 +12,10 @@ That's the simple version at least.
The reason the program runs this way is because I built it with Console.Waterworks (C.W.). If you would like to know about C.W., I recommend you use the following links:
- [Console.Waterworks.Core Repository](https://gitlab.com/craig.oates/Console.Waterworks.Core) (This is the .Net Core version.)
- [Console.Waterworks.Core Wiki](https://gitlab.com/craig.oates/Console.Waterworks.Core/wikis/home) (The .Net Core version operates the same way as the traditional .Net one. So, this wiki is not as comprehensive and mostly serves as a place to set-up the .Net Core version of C.W.)
- [Console.Waterworks.Core Repository](https://git.abbether.net/craig.oates/Console.Waterworks.Core) (This is the .Net Core version.)
- [Console.Waterworks.Core Wiki](https://git.abbether.net/craig.oates/Console.Waterworks.Core/wikis/home) (The .Net Core version operates the same way as the traditional .Net one. So, this wiki is not as comprehensive and mostly serves as a place to set-up the .Net Core version of C.W.)
Because this wiki is not about learning the intricacies of how C.W. works, I will provide a basic overview of what it is. If you find yourself still needing more information, please use the links above. They go into a lot more detail and you can also inspect C.W's code if you want. If you want to work with the source code in this project, you do need a basic understanding of how C.W. works. Without it, you will find it difficult and some design decisions might seem odd. At a basic level,C.W. is a NuGet package which helps you write console programs. **From a distance**, C.W. programs look **a bit like** an M.V.C. program. To help explain, here is an illustration of C.W's basic structure/flow:
@ -5,7 +5,7 @@ Although there are slight variations, you will use Wet Pancake (W.P.) as a two-s
It is worth pointing out, most functions are asynchronous. If you are unsure about the function being asynchronous or not, use Visual Studio's intellisense. All public functions within W.P. contain XML comments (I.E. intellisense comments). If you are having trouble with intellisense, you can read the source code to see what the it should say. Having said that, all public functions should include `Async` at the end of its name if they are asynchronous. The link for the (public facing) source code is available using the following link:
To help explain the typical flow of W.P., please consider the diagram below.
@ -24,13 +24,12 @@ Within W.P., you will find eight functions, which are:
Instead of repeating the code here, I recommend you open up "ProduceServices.fs". As stated above, all the functions have XML comments to help explain what each function does. If you prefer, I have prepared a A.P.I. overview for these functions for you to look at. Links to the source code and A.P.I. overview are as follows:
To help you get a sense of how these functions look in the wild, I have provided some examples in the Snippets section. If they are not enough, you can take a look at how I have used W.P. in the WetPancakeCLI project. The links for both are as follows:
If you go through the "help" section, you will notice most of the commands have input arguments. From your point-of-view, they are typical (input) types (int, string Etc.). There are limitations to these arguments but they are outside the scope of this wiki. If you would like to know more about about these limitations, please use the following link:
- [Coerce List (part of Console.Waterworks wiki)](https://gitlab.com/craig.oates/Console.Waterworks/wikis/Coercion-Types-List)
- [Coerce List (part of Console.Waterworks wiki)](https://git.abbether.net/craig.oates/Console.Waterworks/wikis/Coercion-Types-List)
You should not notice the limitations for the most part. Although, if you are wanting to work with this projects source code, I highly recommend you use the above link. If you do not want to use the quick-guide or the built-in "help" command, you can view the list of available commands with the following link:
@ -19,7 +19,7 @@ Instead of running through every line of code in the project, I will provide a s
This is the public facing part of the library -- the A.P.I. if you will. When people add WetPancake (W.P.) to their project, they will call the functions in this file. The function called in this file will then call the private/internal functions within the rest of the library.
@ -28,7 +28,7 @@ This is the public facing part of the library -- the A.P.I. if you will. When pe
The functions in this file deals with file access. The most notable type is the built-in sample files. These samples consist of plain-text (.txt) files and live in the "TextFiles" folder. DataAccess.fs, also, provides functions for selecting one of the sample files at random.
@ -37,7 +37,7 @@ The functions in this file deals with file access. The most notable type is the
This file provides functions which "cleans" the (plain) text of a file when loaded in memory. The functions available include trimming/splitting text and replacing/removing characters.
@ -50,7 +50,7 @@ The main purpose of this file is to process the data after it has entered the sy
Before any data (I.E. plain-text) reaches the functions in this file, I will have already ran it through "DataCleaning.fs" and its appropriate functions.
@ -61,7 +61,7 @@ If you have not read any of the project's source code, I recommend you do for th
I tend to look at this file like it is a head of department. "ProductServices.fs" delegates its big tasks to this file which, inturn, breaks it down even further. In this instance, "DataServices.fs" is overseeing the creation of the the final result (I.E. the Markov text). This is because it is a task it received from "ProductServices.fs".
@ -73,7 +73,7 @@ When you load a .txt file, DataStructuring.fs cleans and processes it. This is i
The code in this file constructs the `map` which other parts of the system uses to generate the final text. I will not go into detail about how it does it here. Instead, I will provide links to other pages in this wiki. This will explain how a Markov Chain works and how it relates to the creation of a `map`. The links are as follows:
@ -82,7 +82,7 @@ The code in this file constructs the `map` which other parts of the system uses
This is a small file but far reaching. The functions in here are accessible to any file within the project. It is a glorified "helper class". With that said, the module residing in this file is an `internal` one. So, it is important to remember, developers will **not** have access to anything in here when they use W.P. as a NuGet package.
@ -90,7 +90,7 @@ The main purpose of this folder is to store the sample/template .txt files. This
As an aside, when a developer adds W.P. to their project, "TextFiles" is also added. If the developer wants to, he/she is free to add their sample (.txt) files to "TextFiles". Because of this, I recommend keeping this folder clean and focused -- no storing of none .txt files.
*There is nothing special about these files. They are files I had lying around on my computer.*
@ -109,5 +109,5 @@ I have broke the file down into the sections which mimics the file structure/gen
If you are unsure what the bindings refer to (at the top of the file), they are paths to the sample/template files in "TextFiles". For more information on the files in "TextFiles", please use the following link:
Usually, `Pancake` will throw an exception if something goes wrong. The useful way to find out what exceptions are thrown, you can use Visual Studio's Intellisense. If you are having any trouble with that, you can look at the actual code. Another way to find out is to look at the (As a NuGet) A.P.I. page. The links for the code and extra information about Intellisense are as follows:
- [NuGet A.P.I.](https://gitlab.com/craig.oates/Wet-Pancake/blob/master/WetPancake/ProductServices.fs) (the public facing part of WetPancake in "As a NuGet" section)
- [NuGet A.P.I.](https://git.abbether.net/craig.oates/Wet-Pancake/blob/master/WetPancake/ProductServices.fs) (the public facing part of WetPancake in "As a NuGet" section)
