Batch User Interface Guide

::: Disable Command line commands from diplaying

@ECHO OFF

::: Define Size of the Console Window

Mode Con: cols=125 lines=25

::: Select Name of the Command Window

TITLE Introduction to Batch User Interfaces.

:intro

::: Define Variable Names For Page text

Call :nullsentences

::: Establishes handling of page selection

    Set returnpage=intro
    Set targetpage=setup

::: Assigns text to the User Interface Screen Header.

    Set headertext=Introduction to Batch User Interface and Choice Command

::: Assigns text to the screens textfield

    Set Sentence1=Welcome to my Advanced batch Interface Tutorial.
    Set Sentence2=We'll be covering everything needed to be able to reproduce
    Set Sentence3=the format of this batch file.
    Set Sentence4=All the commands used to achieve this style of user interface
    Set Sentence5=are simple to master, however provide a much better user
    Set Sentence6=experience than typical batch inteface menus.
    Set sentence7=All commands will appear in Yellow
    Set sentence8=                                                         Let's take a look...

GOTO pagenext

:setup

    Set returnpage=intro
    Set targetpage=bldscr1

Call :nullsentences

    Set headertext=Setting up your Script.

    Set Sentence1=The First line of your script will be:
    Set Sentence2=^@ECHO OFF
    Set Sentence3=The next command you have a bit of freedom with, as it depends on what size you
    Set Sentence4=want your console to display at. "cols" defines how wide, "lines" defines how high.
    Set Sentence5=Mode con: cols=125 lines=25
    Set Sentence6=Next up, it's time to choose a title for your program.
    Set Sentence7=TITLE Introduction to Batch User Interfaces.
    Set Sentence8=Now that we've set up the basic properties of our console, Let's build our display...

GOTO pageboth

:bldscr1

    Set returnpage=setup
    Set targetpage=bldscr2

Call :nullsentences

    Set headertext=Creating your Screen Template

    Set sentence1=To save alot of time and effort, Create a template for the screens display that allows you to
    Set sentence2=easily change the information presented to the user by changing a few variables then calling the screen.
    Set sentence3=It's up to you to choose what sort of border you wish to place around your text field and what variable names you
    Set sentence4=wish to use to diplay the text. To make life easier, Variables with descriptive names are best.
    Set sentence5=Your screen should be called from each page that wishes to use it. To call a label, use the following
    Set sentence6=CALL :screen
    Set sentence7=Substitute screen for the label name you wish to use / call.
    Set sentence8=Next up, we'll look at the screen template for this program.

GOTO pageboth

:::

:bldscr2

    Set returnpage=bldscr1
    Set targetpage=bldscr3

Call :nullsentences

    Set sentence1=:screen The label name for this programs Screen template
    Set sentence2=cls Clears the Console screen
    Set sentence3=color 02 Sets the default Color of the background and text
    Set sentence4=IF ^%%avprev^%%==0 Set prev=*ESC[90m(P)revious*ESC[32m The variables ^%%avprev^%%/^%%avnext^%% Display current navigation options.
    Set sentence5=IF ^%%avprev^%%==1 Set prev=*ESC[35m(P)revious*ESC[32m
    Set sentence6=IF ^%%avnext^%%==0 Set next=*ESC[90m(N)ext*ESC[32m
    Set sentence7=IF ^%%avnext^%%==1 Set next=*ESC[35m(N)ext*ESC[32m
    Set sentence8=*ESC is to be substituted for the ANSI escape symbol. Continued...

GOTO pageboth

:bldscr3

    Set returnpage=bldscr2
    Set targetpage=bldscr4

Call :nullsentences

    Set headertext=Creating your Screen Template

    Set sentence1=Adjust the border for your header to the style you desire.
    Set sentence2=^ECHO ====================================================================================================================
    Set sentence3=^ECHO ^%%header^%%*ESC[32m Displays the text stored to the Variable header
    Set sentence4=^ECHO ====================================================================================================================
    Set sentence5=
    Set sentence6=
    Set sentence7=
    Set sentence8=Continued...

GOTO pageboth

:bldscr4

    Set returnpage=bldscr3
    Set targetpage=bldscr5

Call :nullsentences

    Set sentence1=Space out (our group) your sentences as you wish.
    Set sentence2=^ECHO = ^%%sentence1^%% Displays the text stored to the Variable Sentence1
    Set sentence3=^ECHO =
    Set sentence4=^ECHO = ^%%sentence2^%%
    Set sentence5=^ECHO =
    Set sentence6=^ECHO = ^%%sentence3^%%
    Set sentence7=This Tutorial uses 8 sentences with spaces to keep information clearly divided.
    Set sentence8=

GOTO pageboth

:bldscr5

    Set returnpage=bldscr4
    Set targetpage=prptmp1

Call :nullsentences

    Set sentence1=Display the navigation options Available to the user, and return to the place in the program
    Set sentence2=from which you called your screen.
    Set sentence3=^ECHO ====================================================================================================================
    Set sentence4=^ECHO  ^%%prev^%%                                                                                                 ^%%next^%%
    Set sentence5=^ECHO ====================================================================================================================
    Set sentence6=^GOTO :EOF
    Set sentence7=If you have other options for the user to take, You can easily Incorperate them into your Header Variable.
    Set sentence8=In labels that offer additional options, use: Set header=Option (1) Option (2) Option (3)  etc...

GOTO pageboth

:prptmp1

    Set returnpage=bldscr5
    Set targetpage=prptmp2
    Set headertext=Preparing to use your template.

Call :nullsentences

    Set sentence1=Chances are, your not going to fill every sentence on every screen your program uses.
    Set sentence2=Because of this, you need to clear the variables before getting ready to call your screen.
    Set sentence3=To do this. create another function to call from pages that call your screen.
    Set sentence4= :nullsentences
    Set sentence5= Set Sentence1=
    Set sentence6= Set Sentence2= Repeat this for the number of sentences your screen uses.
    Set sentence7= Set Sentence8= You can also copy the Setting component of this function when you're preparing sentences.
    Set sentence8= GOTO :EOF

GOTO pageboth

:prptmp2

    Set returnpage=prptmp1
    Set targetpage=explainchoice
    Set headertext=Putting the template to use.

Call :nullsentences

    Set sentence1=Prior to Setting your Sentence Variables, you want to refresh them.
    Set sentence2=Call :nullsentences
    Set sentence3=Now Set your Sentences.
    Set sentence4=Set sentence1=*ESC[36mPrior to Setting your *ESC[37mSentence*ESC[36m Variables, you want to refresh them.*ESC[32m
    Set sentence5=Set sentence2=*ESC[33mCall :nullsentences*ESC[32m
    Set sentence6=Set sentence3=*ESC[36mNow Set your Sentences.*ESC[32m
    Set sentence7=Next up, I'll be explaining CHOICE Selection and Basic Navigation for your Interface
    Set sentence8=

GOTO pageboth

:explainchoice

    Set returnpage=prptmp2
    Set targetpage=optionselect
    Set headertext=CHOICE and Navigation

Call :nullsentences

    Set sentence1=The CHOICE command is what allows your user to interact with the user Interface.
    Set sentence2=For paging through labels, as this program has so far, assigning label names to variables
    Set sentence3=is the way to go. In each 'page', prior to the choice command:
    Set sentence4=^Set targetpage=nextpagelabelname
    Set sentence5=^Set returnpage=lastpagelabelname
    Set sentence6=^CHOICE /N /C:pn /M ""^%%1
    Set sentence7=IF ERRORLEVEL ==2 GOTO ^%%targetpage^%%
    Set sentence8=IF ERRORLEVEL ==1 GOTO ^%%returnpage^%%

GOTO pageboth

:optionselect

    Set returnpage=explainchoice
    Set targetpage=usetmplte
    Set headertext=^CHOICE and Navigation

Call :nullsentences

    Set sentence1=For multi Directional paging, this program uses the following function
    Set sentence2=^:pageboth
    Set sentence3=^Set avnext=1
    Set sentence4=^set avprev=1
    Set sentence5=^Call :screen
    Set sentence6=^CHOICE /N /C:pn /M ""^%%1
    Set sentence7=^IF ERRORLEVEL ==2 GOTO ^%%targetpage^%%
    Set sentence8=^IF ERRORLEVEL ==1 GOTO ^%%returnpage^%%

GOTO pageboth

:usetmplte

    Set returnpage=optionselect
    Set targetpage=wrapup
    Set headertext=Putting it all together.
    Set avnext=1
    set avprev=1

cls
IF %avprev%==0 Set prev=(P)revious
IF %avprev%==1 Set prev=(P)revious
IF %avnext%==0 Set next=(N)ext
IF %avnext%==1 Set next=(N)ext
ECHO ============================================================================================================================
ECHO = %headertext%
ECHO ============================================================================================================================
ECHO =
ECHO = Using the screen template becomes as simple as Copying code and changing the value of the variables and label names:
ECHO =
ECHO = :nameofcurrentlabel
ECHO = Call :nullsentences
ECHO = Set Sentence1= blah blah
ECHO = Set Sentence2= blah blah
ECHO = Set Sentence3= blah blah
ECHO = Set Sentence4= blah blah
ECHO = Set Sentence5= blah blah
ECHO = Set Sentence6= blah blah
ECHO = Set Sentence7= blah blah
ECHO = Set Sentence8= blah blah
ECHO = Set returnpage=nameofpreviouslabel
ECHO = Set targetpage=nameofnextlabel
ECHO = Set headertext=Desired Header Text
ECHO = GOTO pageboth Or Call :screen followed by other choices as required.
ECHO ============================================================================================================================
ECHO = %prev%                                                                                                         %next%
ECHO ============================================================================================================================
CHOICE /T 5 /C pn /N /D n >nul
IF ERRORLEVEL ==2 GOTO %targetpage%
IF ERRORLEVEL ==1 GOTO %returnpage%

:wrapup

    Set returnpage=usetmplte
    Set targetpage=wrapup
    Set headertext=The TakeAway.

Call :nullsentences

    Set sentence1=As you will have learned by now, with just a few commands, a very simple yet informative User Interface
    Set sentence2=can be made for batch files.
    Set sentence3=A little bit of formatting to display information clearly
    Set sentence4=A touch of Color to highlight important information or show availble options
    Set sentence5=Is all it takes to make batch programs a more enjoyable experience.
    Set sentence6=
    Set sentence7=For a copy of this program, Visit: https://pastebin.com/jbXyaPwN
    Set sentence8=

GOTO prevpage

:::

:nullsentences

    Set sentence1=
    Set sentence2=
    Set sentence3=
    Set sentence4=
    Set sentence5=
    Set sentence6=
    Set sentence7=
    Set sentence8=
GOTO :EOF

:pagenext

    Set avnext=1
    set avprev=0
Call :screen
CHOICE /T 5 /C pn /N /D n >nul
IF ERRORLEVEL ==2 GOTO %targetpage%
IF ERRORLEVEL ==1 GOTO %returnpage%

:pageboth
    Set avnext=1
    set avprev=1
Call :screen
CHOICE /T 5 /C pn /N /D n >nul
IF ERRORLEVEL ==2 GOTO %targetpage%
IF ERRORLEVEL ==1 GOTO %returnpage%

:prevpage
    Set avnext=0
    set avprev=1
Call :screen
CHOICE /T 5 /C pn /N /D n >nul
IF ERRORLEVEL ==2 GOTO %targetpage%
IF ERRORLEVEL ==1 GOTO %returnpage%

:screen
cls
color 02
IF %avprev%==0 Set prev=(P)revious
IF %avprev%==1 Set prev=(P)revious
IF %avnext%==0 Set next=(N)ext
IF %avnext%==1 Set next=(N)ext
ECHO ============================================================================================================================
ECHO = %headertext%
ECHO ============================================================================================================================
ECHO =
ECHO = %sentence1%
ECHO =
ECHO = %sentence2%
ECHO =
ECHO = %sentence3%
ECHO =
ECHO = %sentence4%
ECHO =
ECHO = %sentence5%
ECHO =
ECHO = %sentence6%
ECHO =
ECHO = %sentence7%
ECHO =
ECHO = %sentence8%
ECHO =
ECHO ============================================================================================================================
ECHO = %prev%                                                                                                         %next%
ECHO ============================================================================================================================
GOTO :EOF


:::

:end
exit