Updates:
        Cc: stephane.ducasse

Comment #3 on issue 3523 by [email protected]: Nested comments
http://code.google.com/p/pharo/issues/detail?id=3523

I think your problem comes from writing the documentation
in the usual tools like class browser, etc. where you edit
a string (with all the '' escaping)

Maybe you should use the EDIT SUPPORT of help system.
Example:

  1. Create a simple subclass of CustomHelp for a new
     book.

        CustomHelp
                subclass: #MyHelpBook
        
                instanceVariableNames: ''
        
                classVariableNames: ''
        
                poolDictionaries: ''
        
                category: 'MyApp-Help'

  2. Implement a class side method to name the book:

        bookName
        
            ^'Help for MyApp'

  3. Now edit page you want by evaluating

        MyHelpBook edit: #page1 

     => this opens a new workspace where you can
        write your documentation similar to class
        comments. If you change the title of the window
        you will give your page a name.
     => If you accept the contents of this workspace
        it will be saved in the method #page1

  4. Implement the method to return the books pages:

        pages
        
          ^#(page1)

You dont have to fight with string escaping then


Reply via email to