> cheers Lukas, can you check how it has rendered, i am not sure the > copy/paste has quite worked?
Looks good, except for the part on keywords. Probably the mail messed up some line wrappings. Lukas > > Mike > > On Sun, Apr 18, 2010 at 10:57 AM, Lukas Renggli <[email protected]> wrote: >>> yes i was going to copy it into the new help section. Can someone with >>> access to book.seaside.st send me the original markup? or tell me how >>> I can view the pier source. I have added a link for now. >> >> +value:toc+ >> >> !Parts, Chapters, Sections, Subsections >> >> Do not use the heading markup !, it cannot be properly converted to >> Latex. Instead add a new structure for every section using the ==Add== >> command. Name the section according to their latex label, only use >> lowercase characters and no spaces. This is the name that will appear >> in the URL. For the title capitalize the individual words. >> >> Chapters, sections and subsections are displayed in the order they are >> created. They can be rearranged using the ==Order== command. >> >> !Figures >> >> To embed a figure create a link of the form >> >> =+foo.png|width=100%+ >> >> The line embeds the figure and sets the width of the image. For the >> width use a percentage between 50% and 100%. Only upload PNG files >> without transparency, no JPEG or GIF files. Do not upload files that >> have spaces in their name. As the name property use the name of the >> file you upload. Edit the title property, it will become the caption >> of the image and show up in the index of figures. >> >> If the figure does not exist yet, it will show as a red link. Clicking >> on it allows you to create it. Chose "Book Figure" as the structure >> type to create. Then on the next page edit the title (caption) and >> upload the image. >> >> !Keyword Index >> To add a keyword to the index use ==\+index:WAComponent\+==. To add a >> two level keyword use the syntax >> ==\+index:WAComponent!renderContentOn:\+==. Note that this markup does >> not generate any output. Preferably put it at the beginning of the >> paragraph. >> >> !Source Code >> For inlined source code use the syntax ==\==100 factorial\== ==. For >> blocks of code that should be highlighted using the Smalltalk parser >> begin each line with == \== ==. Use 4 spaces to indent the code, no >> tabs. >> >> ==Integer>>factorial >> == ^ self < 2 >> == ifTrue: [ 1 ] >> == ifFalse: [ self * (self - 1) factorial ] >> >> To have non highlighted code begin each line with a single =====. >> >> =squeak -headless seaside.image >> >> !References >> >> To create references to chapters, sections or figures use the normal >> link-syntax but prepend it with ==ref:==, for example: >> >> =*ref:foo.png* >> =*ref:../components* >> >> @here >> This will create a link of the form *Form 123>....@here* and *Section >> 4>....@here*. >> >> !Paragraph >> Avoid unnecessary line breaks in paragraphs. Don't use wrapped text, >> that is clumsy and almost impossible to edit afterwards from the web >> browser. In TextMate use the command ''Unwrap Paragraph >> (Ctrl\+Alt\+Q)'' to properly format the paragraph before pasting into >> Pier. >> >> Use the syntax ==\@@important This is the paragraph text.== to >> annotate a paragraph. >> >> @@important This is an ==\@@important== paragraph. >> >> @@blockquote This is a ==\@@blockquote== paragraph. >> >> @@note This is a ==\@@note== paragraph. >> >> @@advanced This is an ==\@@advanced== paragraph. >> >> @@todo This is a ==\@@todo== paragraph. >> >> !Navigation >> | j | Previous Page >> | k | Next Page >> | p | Parent Page >> | i | Table of Contents >> >> -- >> Lukas Renggli >> www.lukas-renggli.ch >> >> _______________________________________________ >> Pharo-project mailing list >> [email protected] >> http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project >> > > _______________________________________________ > Pharo-project mailing list > [email protected] > http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project > -- Lukas Renggli www.lukas-renggli.ch _______________________________________________ Pharo-project mailing list [email protected] http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/pharo-project
