This is an old revision of the document!
<- [[: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: sholarly 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 part 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. (last edit --- //[[predrag.cvitanovic@physics.gatech.edu|Predrag Cvitanovic]] 2009-03-30 05:08//) ~~DISCUSSION~~
