channelflow.org

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
<- [[:chaosbook]]

====== How to edit and complete chapter chapname.tex ======

Edits fall into three general classes:
  *  trivial ones about wordings and grammar: implement without comments (svn keeps track of them)
  *  less trivial ones about suggested revisions of the order of discussions and so on: if you rewrote a block of text, mark the edits something like this (so the other people can easily see what you did by scanning through the file):

    %%NW:                         in the line preceeding  a small edit, and
    %%NW:start edit
    ... block of text ...
    %%NW:finish edit

  *  places where you think the exposition is unclear: use comment enviroment, such as 

    \NW{This makes no sense to me, or am I in love?} (if you are Niall).

===== Editing protocol =====

  * the source LaTeX is in chapter/chapname.tex
  * update the date in \Chapter{chapname}{22apr2007}{Blah blah}
  * brief motivational preface
  * edits:
     * while a major rewite is in progress, keep  (do not delete) the previous text in the public version of the book

            \PublicPrivate{
            Old Text stays here...
                                 }{ % switch \PublicPrivate
            until New Text is finalized
                                 }% end \PublicPrivate

  * when you remove equation, figure, table, section, remark, example, \index{} etc., check the ENTIRE manuscript for references to the edited item, update them
  * follow ChaosBook conventions whenever possible, rather then introducing new symbols. Define a frequently used symbols by a def.tex macro. That helps harmonize notation across ChaosBook.
  * add \index{} entry in the text for any important concept
  * \example{}{}: illustrative examples, preferably "physical" applications, can refer to literature
  * add relevant tables
  * Fig/fig*.eps - the biggest problem: we need quality figures, lots of them
  * FigSrc/*/ save the figure source program in the appropriate subdirectory
  * \Resume: Summary of the key results
  * \Remarks: scholarly remarks, all pointers to the literature (no references in the text proper, this is a self contained textbook)
  * refsChapname.tex: references, Physical Review style. Bracket the unused ones by the  \PublicPrivate{ }{place ref here}, do not delete them.
  * chapter/appendChapname.tex: appendices, if appropriate
  * Problems/exerChapname.tex: exercises
  * Problems/soluChapname.tex: solutions
  * add soluChapname to Problems/solutions.tex
  * run through a spell checker (American rather than Queen's or Central European spelling)
  * finish __all parts__ of the chapter (mother does not work here)

Notational coherence and proper cross-referencing with the rest of the textbook should be ensured as far as possible.

===== Style and notation =====

ChaosBook follows the [[http://authors.aps.org/STYLE/|Physical Review Style and Notation Guide]]; 
[[http://forms.aps.org/author/styleguide.pdf|pdf version]].

  * each chapter has its references, so cited by [chapter.citation], for example: "as noted by Newton [17.26]."
    * [[http://authors.aps.org/STYLE/ms.html#footnotes|reference format]]. Include the article title if you have it.
    * order references by the order they are cited in the chapter. Rename the reference if reused in another chapter.
  * [[http://authors.aps.org/STYLE/style_jabbr.html|journal names are abbreviated]]
  * Style: if in doubt, apply the Gibson filter.
  * logarithms: 
    * <latex>\ln</latex> if base //e//
    * <latex>\log_{10}</latex> if base //10//
    * <latex>\log</latex> if base does not matter


(last edit  --- //[[predrag.cvitanovic@physics.gatech.edu|Predrag Cvitanovic]] 2009-04-15//)




~~DISCUSSION~~
channelflow.org

User Tools

Site Tools

Page Tools
