hunk ./README 10 + hunk ./README 13 - for usage and examples. + for usage and examples; also, when running each tool you can type + '?' to see a list of available commands. For now, these tools do + not modify content.wiki directly; each generates a file suitable + for pasting into content.wiki. See utils/README for more detailed + information. + hunk ./README 22 - * pdf frontpage can be viewed with "make pdf" hunk ./README 32 - archives/ (suitable for email and sequence.complete.org), and also - the wiki versions (Old_news.html and News.html). + archives/ (suitable for email and sequence.complete.org). hunk ./README 40 - * Check the archives/*.pdf file, and regenerate archives/*.tex until - it all fits on one pdf page. - hunk ./README 58 - * Email summary and url to lwn@lwn.net: + * If desired, email summary and url to lwn@lwn.net (I, byorgey, + almost never did this, but apparently it used to be done + regularly) hunk ./README 69 - + archives/yyyymmdd.txt to haskell@haskell.org + + + archives/yyyymmdd.txt to haskell@haskell.org and + haskell-cafe@haskell.org + hunk ./README 77 - * For good issues, post url to programming.reddit.com, suggested title: - "Haskell Weekly News: headline summary" + * For good issues, post url to programming.reddit.com, suggested + title: "Haskell Weekly News: headline summary". In practice, Don + Stewart will do this for you so no need to trouble yourself. =) hunk ./README 81 -Record: +Finally, record and push: hunk ./README 83 - * darcs add - * darcs record --all - * darcs tag - * darcs push + * darcs add archives/yyyymmdd.* + * darcs record -a -m 'Issue XXX' + * darcs push -a hunk ./utils/README 3 +It is generally useful to create symlinks to these utilities in the +main hwn directory. + hunk ./utils/README 9 -gmane: +gmane: + + Start from the command line by passing it one of the options + 'Haskell', 'Cafe', 'Libraries', 'Prime', or 'GHC' to look at + haskell@, haskell-cafe@, libraries@, haskell-prime@, and ghc-users@ + respectively. It will pull down thread subjects from GMane and + allow you to select those threads which you wish to include in the + HWN. Type '?' at the prompt for a list of supported commands. A + typical workflow is to hit 'n' repeatedly for threads you don't want + to include, and for threads you do want to include, hit 'a' (to list + it under the 'Announcements' section, or 'z' (to list it under the + 'Discussions' section), then 'T' to auto-select the title from the + subject (stripping any leading ANN: or ANNOUNCE: or similar), then + 'u' to open up your favorite editor to compose a paragraph + summarizing the thread. The editor will start with the contents of + the message, so usually you can just cut and paste portions of the + message to create the summary, although it is often necessary to add + some additional inline links (using the [http://blah.blah/ text] + format). Once you are done preparing an item for inclusion, ty[e + 'j' to move to the next item. You can always type 'k' to go + backwards through the list and change/edit previous items. hunk ./utils/README 33 + Takes no arguments. Pulls blog titles from the planet haskell feed + from which you can select. Type '?' to see the available options. + A typical workflow is to type 'y' for posts you do want to include + ('n' for ones you don't), then 'A' to automatically parse the + author's name from the title (which is often in the form "Author: + Title"), or 'a' and 't' to enter the author/title manually; then 'j' + to move to the next item. You can also use 'u' to edit a summary of + the post if desired---especially useful for posts with opaque titles. + + One pitfall is that the Planet Haskell RSS feed only retains a + certain number of items---so if you wait too long between uses of + the planethaskell tool you will miss some posts. One solution is to + subscribe to Planet Haskell in the RSS aggregator of your choice; + then even if some of the posts since the last HWN have fallen off + the end of the PH RSS feed, you can still recover links to them from + your RSS reader's history. Of course, this requires more manual + work so is best avoided! Usually a week's worth of posts will all + fit within Planet Haskell's RSS history length, but two weeks of + posts almost certainly will not. + + One thing to be aware of is that there are many interesting + Haskell-related blog posts which are not syndicated on Planet + Haskell. A useful place to find these is on the Haskell Reddit; + however, pulling blog posts from reddit is not (yet) automated. + hunk ./utils/README 60 + Takes no arguments; pulls quotes from the #haskell IRC channel. It + works by grepping through the IRC logs for occurrences of the string + @remember, so sometimes it finds extraneous things (such as people + talking *about* the @remember command) and it also has no conception + of whether a quote has already been encountered before. Obviously, + it also won't find quotes that were funny but happened not to be + @remembered. + hunk ./utils/README 69 + + This utility should be called from the main hwn directory, and + handles actually generating the HWN in various formats (text, + html...) from content.wiki. When called with no arguments it simply + builds the various HWN formats and dumps them in the same directory. + When called with -p it does the following: + + * Builds the HWN (including spell-checking) and puts it in + archives/yyyymmdd.* + * Replaces content.wiki with content.pristine + * Increments the issue number contained in the file 'issue'