s c h e m a t i c s : c o o k b o o k

/ WebHome / AuthorGuide / Cookbook.CreatingRecipes

This Web


WebHome 
WebChanges 
TOC (with recipes)
NewRecipe 
WebTopicList 
WebStatistics 

Other Webs


Chicken
Cookbook
Erlang
Know
Main
Plugins
Sandbox
Scm
TWiki  

Schematics


Schematics Home
Sourceforge Page
SchemeWiki.org
Original Cookbook
RSS

Scheme Links


Schemers.org
Scheme FAQ
R5RS
SRFIs
Scheme Cross Reference
PLT Scheme SISC
Scheme48 SCM
MIT Scheme scsh
JScheme Kawa
Chicken Guile
Bigloo Tiny
Gambit LispMe
GaucheChez

Lambda the Ultimate
TWiki.org

Creating Recipes

This page discusses both reasons for creating recipes and provides guidance on creating recipes. area.

How To Create Recipes

Use the NewRecipe page (accessible from the bar on the left in the VoidSkin) to quickly create a recipe using the standard template.

A recipe consists of five main sections:

  1. The problem definition concisely presents the problem
  2. The solution presents the preferred solution
  3. The discussion discusses tradeoffs inherent in the solution and other possible solutions
  4. See Also references other related recipes
  5. Comments are material that isn't directly relevant to the recipe. Often they discuss meta issues.

Reasons For Creating Recipes

There are two main reasons for creating recipes:

See Also

AuthorGuide

-- NoelWelsh - 06 May 2004

-- GordonWeakliem - 07 May 2004

Comments

If there are two very different solutions, and neither is superior in the general case, can they both be documented in the Solution section. I think the two-solutions situation often arises when the Problem statement is general enough that more information is needed before the best general-case solution can be determined. But making two seperate topics to distinguish the two problems might confuse the user who conceptualizes his/her problem more vaguely. Making two separate topics also means that some background material they share in common might want to be moved elsewhere. Perhaps there could be subheadings under Solution, or "Solution #1" and "Solution #2" headings, rather than relegating all but one solution to the "Discussion" section?

-- NeilVanDyke - 26 May 2004

CookbookForm
TopicType: Recipe
ParentTopic: AuthorRecipes
TopicOrder: 020

 
 
Copyright © 2004 by the contributing authors. All material on the Schematics Cookbook web site is the property of the contributing authors.
The copyright for certain compilations of material taken from this website is held by the SchematicsEditorsGroup - see ContributorAgreement & LGPL.
Other than such compilations, this material can be redistributed and/or modified under the terms of the GNU Lesser General Public License (LGPL), version 2.1, as published by the Free Software Foundation.
Ideas, requests, problems regarding Schematics Cookbook? Send feedback.
/ You are Main.guest