Improved example in initialiation docs

2 files changed, 74 insertions, 2 deletions

diff --git a/docs/features/initialization.rst b/docs/features/initialization.rst
index 936208f1..315709f0 100644
--- a/docs/features/initialization.rst
+++ b/docs/features/initialization.rst
@@ -6,7 +6,7 @@ capabilities which you may wish to utilize while initializing the app::
 
     #!/usr/bin/env python3
     # coding=utf-8
-    """A simple example cmd2 appliction demonstrating the following:
+    """A simple example cmd2 application demonstrating the following:
         1) Colorizing/stylizing output
         2) Using multiline commands
         3) Persistent history
@@ -28,15 +28,27 @@ capabilities which you may wish to utilize while initializing the app::
             super().__init__(multiline_commands=['echo'], persistent_history_file='cmd2_history.dat',
                              startup_script='scripts/startup.txt', use_ipython=True)
 
+            # Prints an intro banner once upon application startup
             self.intro = style('Welcome to cmd2!', fg='red', bg='white', bold=True)
+
+            # Show this as the prompt when asking for input
             self.prompt = 'myapp> '
 
+            # Used as prompt for multiline commands after the first line
+            self.continuation_prompt = '... '
+
             # Allow access to your application in py and ipy via self
             self.locals_in_py = True
 
             # Set the default category name
             self.default_category = 'cmd2 Built-in Commands'
 
+            # Color to output text in with echo command
+            self.foreground_color = 'cyan'
+
+            # Make echo_fg settable at runtime
+            self.settable['foreground_color'] = 'Foreground color to use with echo command'
+
         @cmd2.with_category(CUSTOM_CATEGORY)
         def do_intro(self, _):
             """Display the intro banner"""
@@ -45,7 +57,7 @@ capabilities which you may wish to utilize while initializing the app::
         @cmd2.with_category(CUSTOM_CATEGORY)
         def do_echo(self, arg):
             """Example of a multiline command"""
-            self.poutput(arg)
+            self.poutput(style(arg, fg=self.foreground_color))
 
 
     if __name__ == '__main__':
diff --git a/examples/initialization.py b/examples/initialization.py
new file mode 100755
index 00000000..e26aac9f
--- /dev/null
+++ b/examples/initialization.py
@@ -0,0 +1,60 @@
+#!/usr/bin/env python3
+# coding=utf-8
+"""A simple example cmd2 application demonstrating the following:
+     1) Colorizing/stylizing output
+     2) Using multiline commands
+     3) Persistent history
+     4) How to run an initialization script at startup
+     5) How to group and categorize commands when displaying them in help
+     6) Opting-in to using the ipy command to run an IPython shell
+     7) Allowing access to your application in py and ipy
+     8) Displaying an intro banner upon starting your application
+     9) Using a custom prompt
+    10) How to make custom attributes settable at runtime
+"""
+import cmd2
+from cmd2 import style
+
+
+class BasicApp(cmd2.Cmd):
+    CUSTOM_CATEGORY = 'My Custom Commands'
+
+    def __init__(self):
+        super().__init__(multiline_commands=['echo'], persistent_history_file='cmd2_history.dat',
+                         startup_script='scripts/startup.txt', use_ipython=True)
+
+        # Prints an intro banner once upon application startup
+        self.intro = style('Welcome to cmd2!', fg='red', bg='white', bold=True)
+
+        # Show this as the prompt when asking for input
+        self.prompt = 'myapp> '
+
+        # Used as prompt for multiline commands after the first line
+        self.continuation_prompt = '... '
+
+        # Allow access to your application in py and ipy via self
+        self.locals_in_py = True
+
+        # Set the default category name
+        self.default_category = 'cmd2 Built-in Commands'
+
+        # Color to output text in with echo command
+        self.foreground_color = 'cyan'
+
+        # Make echo_fg settable at runtime
+        self.settable['foreground_color'] = 'Foreground color to use with echo command'
+
+    @cmd2.with_category(CUSTOM_CATEGORY)
+    def do_intro(self, _):
+        """Display the intro banner"""
+        self.poutput(self.intro)
+
+    @cmd2.with_category(CUSTOM_CATEGORY)
+    def do_echo(self, arg):
+        """Example of a multiline command"""
+        self.poutput(style(arg, fg=self.foreground_color))
+
+
+if __name__ == '__main__':
+    app = BasicApp()
+    app.cmdloop()