Changes between Version 13 and Version 14 of ShellExampleMacro

Timestamp:

Jan 25, 2011, 8:52:27 PM (13 years ago)

Author:

Nathaniel Madura

Comment:

--

ShellExampleMacro

@@ -4 +4 @@
 
 == Description ==
-
 Wiki Formatter for command line shell examples.
 
 This plugin has only been tested on Trac 0.12, but may work with earlier versions.
-
-== Bugs/Feature Requests == 
-
-Existing bugs and feature requests for ShellExampleMacro are 
-[report:9?COMPONENT=ShellExampleMacro here].
-
-If you have any issues, create a 
-[http://trac-hacks.org/newticket?component=ShellExampleMacro&owner=nmadura new ticket].
-
-== Download ==
-
-Download the current source (0.12.1) from [http://trac-hacks.org/svn/shellexamplemacro/0.12/tags/shellexample-0.12.1.tar.gz here].
-
-== Source ==
-
-You can check out ShellExampleMacro from [http://trac-hacks.org/svn/shellexamplemacro/0.12/trunk/ here] using Subversion, or [source:shellexamplemacro browse the source] with Trac.
 
 == Example ==
@@ -53 +36 @@
 [[Image(ShellExample-example.png)]]
 
+== More Details ==
+This is a [wiki:WikiProcessors WikiProcessor] so it is used with the standard #! notation. This processor injects css code into Trac, so you should get formatted output by default. Any tagged code is inside a span element, and the following classes are used:
+ * se-input
+ * se-input-userreplacement
+ * se-input-string
+ * se-input-continuation
+ * se-input-option
+ * se-input-delayed
+ * se-prompt
+ * se-prompt-start
+ * se-prompt-user
+ * se-prompt-userhostseparator
+ * se-prompt-host
+ * se-prompt-path
+ * se-prompt-end
+ * se-root
+ * se-unprivileged
+ * se-note
+ * se-output
+ * se-output-snipped
+
+{{{
+{{{
+#!ShellExample
+{user@foo ~/path/to}$ foo --user {username}
+}}}
+}}}
+
+results in something like the following (expanded for easier reading):
+{{{
+#!xml
+<div class="code">
+  <pre>
+    <span class="se-prompt">
+        <span class="se-prompt-start">{</span>
+        <span class="se-prompt-user">user</span>
+        <span class="se-prompt-userhostseparator">@</span>
+        <span class="se-prompt-host">foo</span> 
+        <span class="se-prompt-path">~/path/to</span>
+        <span class="se-prompt-end">}</span>
+    </span>
+    <span class="se-unprivileged">$ </span>
+    <span class="se-input">foo <span class="se-input-option">--user</span> <span class="se-input-userreplacement">{username}</span></span>
+  </pre>
+</div>
+}}}
+
+== Bugs/Feature Requests == 
+
+Existing bugs and feature requests for ShellExampleMacro are 
+[report:9?COMPONENT=ShellExampleMacro here].
+
+If you have any issues, create a 
+[http://trac-hacks.org/newticket?component=ShellExampleMacro&owner=nmadura new ticket].
+
+== Download ==
+
+Download the current source (0.12.1) from [http://trac-hacks.org/svn/shellexamplemacro/0.12/tags/shellexample-0.12.1.tar.gz here].
+
+== Source ==
+
+You can check out ShellExampleMacro from [http://trac-hacks.org/svn/shellexamplemacro/0.12/trunk/ here] using Subversion, or [source:shellexamplemacro browse the source] with Trac.
+
 == Recent Changes ==