[MO-java-dev] CVS: no-stone-unturned/doc/xdocs a_longer_example.xml,NONE,1.1 htmlbook.css,1.12,1.13

[Steve F. <sm...@us...>]

Update of /cvsroot/mockobjects/no-stone-unturned/doc/xdocs
In directory usw-pr-cvs1:/tmp/cvs-serv30180/doc/xdocs

Modified Files:
	htmlbook.css 
Added Files:
	a_longer_example.xml 
Log Message:
started rework of main example. Wrote a sketch for the steps

--- NEW FILE: a_longer_example.xml ---
<part status="todo">
  <title>Iteration 1</title>

  <preface>
    <title>Requirements</title>

    <para>
      Our customers have commissioned us to write a web-based address book.
      Anyone can add and remove themselves from the list, but only the list owner can see the whole list.
      If we start by assuming that there's just one list, we have the following tasks:
    </para>

    <itemizedlist>
      <listitem><para>
        anyone can see all the entries in the book. The book is retrieved from a file.
      </para></listitem>
      <listitem><para>
        anyone can search the entries in the book.
      </para></listitem>
      <listitem><para>
        anyone can add their name and email address to the book.
      </para></listitem>
      <listitem><para>
        anyone can remove an entry from the book.
      </para></listitem>
    </itemizedlist>
  </preface>

  <chapter>
    <title>Search for an entry in the book</title>
    <subtitle>
      In which we stub out the servlet environment and then mock up access to the file system.
      Our output, and its associated test, is very simple.
    </subtitle>

    <itemizedlist>
      <listitem><para>
        accept a name and find no result.
      </para></listitem>
      <listitem><para>
        accept a name and return a result from a hard-coded collection.
      </para></listitem>
      <listitem><para>
        Retrieve the entries from a file, specified as a servlet property.
        Values are held in memory.
      </para></listitem>
    </itemizedlist>
  </chapter>

  <chapter>
    <title>List all the entries in the book</title>
    <subtitle>
      In which we contemplate more deeply the rendering of our entries that
      we may display the entire address book at once.
    </subtitle>

    <itemizedlist>
      <listitem><para>
        show an empty book.
      </para></listitem>
      <listitem><para>
        show all the entries
      </para></listitem>
      <listitem><para>
        Sort the results alphabetically
      </para></listitem>
     </itemizedlist>
  </chapter>

  <chapter>
    <title>Add a name and address</title>
    <subtitle>
      In which we allow the common people to add their own name and address to the book which introduces us
      to failures and catastrophes that might occur during a transaction.
    </subtitle>
    <itemizedlist>
      <listitem><para>
        accept a name and address, add to store, and rewrite the file.
      </para></listitem>
      <listitem><para>
        lock the file while it's being written.
      </para></listitem>
    </itemizedlist>
  </chapter>

</part>

<part status="todo">
  <title>Iteration 2</title>

  <chapter>
    <title>Port to database</title>
    <subtitle>
      Show how to test code that uses heavyweight resources, by mocking their implementation.
      Refactor (before or after) a persistence layer.
    </subtitle>
  </chapter>

  <chapter>
    <title>Remove a name</title>
    <subtitle>
      Different queries, different failure modes.
    </subtitle>
  </chapter>

  <chapter>
    <title>Allow multiple entries for a name.</title>
    <subtitle>
      In which our customer changes his mind.
    </subtitle>
    <para>
      What about the previous task? Do we remove all entries for a name or ask to choose?
      Go back to the customer.
    </para>
  </chapter>
</part>

<part status="todo">
  <title>Iteration 3</title>
  <subtitle>
    Our customer decides to stay at home more and needs a more responsive user interface.
  </subtitle>

  <chapter>
    <title>Search a name</title>
  </chapter>

  <chapter>
    <title>Remove a name</title>
    <para>Pick entry as well?</para>
  </chapter>

  <chapter>
    <title>List all names</title>
    <para>
      Click on name to see its entries.
    </para>
  </chapter>
</part>
Index: htmlbook.css
===================================================================
RCS file: /cvsroot/mockobjects/no-stone-unturned/doc/xdocs/htmlbook.css,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- htmlbook.css	21 Aug 2002 19:16:43 -0000	1.12
+++ htmlbook.css	21 Aug 2002 21:32:16 -0000	1.13
@@ -5,6 +5,8 @@
 H1 {  font-family: Arial, Helvetica, sans-serif; margin-top: 5%; }
 H2 {  margin-top: 3%; font-style: italic;}
 
+H3.subtitle { font-weight: normal; }
+
 DIV.chapter H2 { font-family: Arial, Helvetica, sans-serif;
                  font-weight: normal; font-size: 200%; }
 DIV.preface H2 { font-family: "Century Schoolbook", Times, serif;