Main.RecipeStructure (r1.1 vs. r1.3)
Diffs

 <<O>>  Difference Topic RecipeStructure (r1.3 - 18 Apr 2007 - ShawnDay)

META TOPICPARENT TaporRecipes


Contributing Your Own TAPoR Portal Recipes and Exercises

Line: 28 to 28

 The description of the recipe should provide others with enough information to determine if the recipe is applicable to their tasks and indicate the specific TAPoR tools used. The names of tools should be bold and italicized.

Link to PDF

Changed:
<
<		 To allow users to be able to print out the recipe and exercise, a composite of the recipe and exercise should be provided as a downloaded PDF.
>
>		 This is of course optional, but if provided, allows users to be able to print out the recipe and exercise and follow along conveniently. The typical PDF will provide a complete composite of the recipe and exercise.

List of Ingredients

The list of ingredients should indicate which TAPoR tools are used in the recipe and a link to the tool's 'TryIt' button on the main TAPoR screen. This will allow users to quickly try the tool without having to log into TAPoR. The ingredients could also include an indication of the type of text that should be supplied for use in the recipe.
Line: 65 to 65

 If there are any existing pages or websites which provide information related to your exercise, they can be linked in this section.

Points to Keep in Mind

Changed:
<
<		 Additional thoughts...........
>
>		 Everyone's use of the portal and associated tools is based on relevance to their own particular task. Your usage may illuminate a path for others or trigger a tangential thought that may lead to an exciting new use. There are really no hard and fast rules for contribution to these recipes, and what is provided here are not guidelines, but merely suggestions.

Changed:
<
<		 -- ShawnDay - 26 Jun 2006
>
>		 -- ShawnDay - 18 April 2007


 <<O>>  Difference Topic RecipeStructure (r1.2 - 26 Jun 2006 - ShawnDay)

META TOPICPARENT TaporRecipes


Contributing Your Own TAPoR Portal Recipes and Exercises

Line: 9 to 9

TOC: No TOC in "Main.RecipeStructure"

Changed:
<
<		 The easiest way to author your own recipe is to save an existing recipe and use it as the basis of your own recipe.
>
>

The easiest way to author your own recipe is to save an existing recipe and use it as the basis of your own recipe.

Adding a New Recipe

  1. Decide whether your recipe helps someone locate or identify, analyse or construct;
  2. Choose to edit the TaporRecipes page;
Changed:
<
<
  1. Add a title and description and licks to the recipe and exercise to the list of recipes;
>
>
  1. Add a title and description and links to the recipe and exercise to the list of recipes;

  1. Preview and Save your changes to the recipe page;
  2. Click on the link to your new recipe to create a new page;
  3. Paste the contents of an existing recipe as a guideline to authoring your own.
Line: 25 to 25

 The title of the recipe should be short, concise and follow from the statement 'This recipe will...(your title here). If possible it sould be expressed in active voice.

Description

Changed:
<
<		 The description of the recipe should provide browsers with enough information to determine if the recipe is applicable to their tasks and indicate the specific TAPoR tools used. The names of tools should be bold and italicized.
>
>		 The description of the recipe should provide others with enough information to determine if the recipe is applicable to their tasks and indicate the specific TAPoR tools used. The names of tools should be bold and italicized.

Link to PDF

To allow users to be able to print out the recipe and exercise, a composite of the recipe and exercise should be provided as a downloaded PDF.

List of Ingredients

Changed:
<
<		 The list of ingredients should indicate which TAPoR tools are used in the recipe and a link to their 'TryIt' button on the main TAPoR screen. The ingreditents may also include an indication of the type of text that should be supplied for use in the recipe.
>
>		 The list of ingredients should indicate which TAPoR tools are used in the recipe and a link to the tool's 'TryIt' button on the main TAPoR screen. This will allow users to quickly try the tool without having to log into TAPoR. The ingredients could also include an indication of the type of text that should be supplied for use in the recipe.

Link to an Exercise

Changed:
<
<		 Each recipe should have an exercise linked to it which applies the steps in the recipe to a real-world example.
>
>		 Each recipe should have an exercise linked to it which applies the steps in the recipe to a real-world example. If possible provide provide a link so that users of the exercise can access or download the sample text that you use in your exercise. This sample text should be publicly available.

Recipe Steps

Changed:
<
<		 Recipes steps should provide a simple, general and logical series of steps necessary to accomplish the task which you have defined. Recipe steps should include a link to a discussion item or glossary item if necessary for full understanding. If a step uses a particlular TAPoR tool, a link to the 'TryIt' button for that tool should be provided.
>
>		 Recipe steps should provide a simple, general and logical series of steps necessary to accomplish the task which you have defined. Recipe steps should include a link to a discussion item or glossary item if additional information is necessary for full understanding. If a step uses a particlular TAPoR tool, a link to the 'TryIt' button for that tool should be provided.

Discussion

Changed:
<
<		 Recipe steps should be kept as simple as possible. Often additional discussion may be necessary to clarify a step or to provide alternative availabel in carrying out a step. If necessary this discussion should not stated within the step, but be referenced and listed in the discussion section.
>
>		 Recipe steps should be kept as simple as possible. Often additional discussion may be necessary to clarify a step or to provide alternative available in carrying out a step. If necessary this discussion should not stated within the step, but be referenced and listed in the discussion section.

Glossary

Changed:
<
<		 To ensure clarity, any jargon should be defined in the glossary by creating a new page to define the term, and linked via an include to the glossary section of that recipe and also included in the general glossary page.
>
>		 To ensure clarity, any jargon should be defined in the glossary by creating a new page to define the term, and linked via an include to the glossary section of that recipe and included in the general glossary page.

Next Steps/Further Information

If there are any existing pages or websites which provide information related to your recipe, they can be linked in this section.
Line: 59 to 59

 To allow users to be able to print out the recipe and exercise, a composite of the recipe and exercise should be provided as a downloaded PDF.

Exercise Steps

Changed:
<
<		 Unlike recipe steps, exercise steps should provide an illustration of the results and thinking behind application of individual recipe steps to a real-world example. Exercise steps should link to TAPoR tools used and can also graphically show the actuall results returned from using those tools. A user should be able to follow through the exercise steps by actually carrying out the exercise themselves or simply by following the results your illustrate. If you apply the tools to a specifci text, a link to that text should be provided for other users.
>
>		 Unlike recipe steps, exercise steps should provide a demonstration of the results and thinking behind application of individual recipe steps to a real-world example. Exercise steps should link to TAPoR tools used and can also graphically show the actual results returned from using those tools. A user should be able to follow through the exercise steps by carrying out the exercise themselves or simply by following the results your illustrate. If you apply the tools to a specific text, a link to that text should be provided for other users.

Next Steps/Further Information

If there are any existing pages or websites which provide information related to your exercise, they can be linked in this section.
Line: 68 to 68

 Additional thoughts...........
Changed:
<
<		 -- ShawnDay - 12 Jun 2006
>
>		 -- ShawnDay - 26 Jun 2006


 <<O>>  Difference Topic RecipeStructure (r1.1 - 12 Jun 2006 - ShawnDay)
Line: 1 to 1
Added:
>
>
META TOPICPARENT TaporRecipes


Contributing Your Own TAPoR Portal Recipes and Exercises


The TAPoR community benefits from shared experience and learning how others make use of the portal. You can share your experience by adding your own recipes to the collection. This page describes the structure and intent of recipes and exercises. Recipes are intended to describe the basic steps necessary to accomplish a task in TAPoR and indicate the tools that are used in the recipe. Try to define your recipes as simply and as generally as possible. To ensure general familiarity, concepts and jargon should be defined on the recipe page.

The easiest way to author your own recipe is to save an existing recipe and use it as the basis of your own recipe.

Adding a New Recipe

  1. Decide whether your recipe helps someone locate or identify, analyse or construct;
  2. Choose to edit the TaporRecipes page;
  3. Add a title and description and licks to the recipe and exercise to the list of recipes;
  4. Preview and Save your changes to the recipe page;
  5. Click on the link to your new recipe to create a new page;
  6. Paste the contents of an existing recipe as a guideline to authoring your own.

Parts of a Recipe

Title

The title of the recipe should be short, concise and follow from the statement 'This recipe will...(your title here). If possible it sould be expressed in active voice.

Description

The description of the recipe should provide browsers with enough information to determine if the recipe is applicable to their tasks and indicate the specific TAPoR tools used. The names of tools should be bold and italicized.

Link to PDF

To allow users to be able to print out the recipe and exercise, a composite of the recipe and exercise should be provided as a downloaded PDF.

List of Ingredients

The list of ingredients should indicate which TAPoR tools are used in the recipe and a link to their 'TryIt' button on the main TAPoR screen. The ingreditents may also include an indication of the type of text that should be supplied for use in the recipe.

Link to an Exercise

Each recipe should have an exercise linked to it which applies the steps in the recipe to a real-world example.

Recipe Steps

Recipes steps should provide a simple, general and logical series of steps necessary to accomplish the task which you have defined. Recipe steps should include a link to a discussion item or glossary item if necessary for full understanding. If a step uses a particlular TAPoR tool, a link to the 'TryIt' button for that tool should be provided.

Discussion

Recipe steps should be kept as simple as possible. Often additional discussion may be necessary to clarify a step or to provide alternative availabel in carrying out a step. If necessary this discussion should not stated within the step, but be referenced and listed in the discussion section.

Glossary

To ensure clarity, any jargon should be defined in the glossary by creating a new page to define the term, and linked via an include to the glossary section of that recipe and also included in the general glossary page.

Next Steps/Further Information

If there are any existing pages or websites which provide information related to your recipe, they can be linked in this section.

Parts of an Exercise

Title

The title of the exercise should be identical to the recipe which it applies and as mentioned should be short, concise and follow from the statement 'This exercise will...(your title here).

Description

The description of the exercise should also be identical to the recipe.

Link to PDF

To allow users to be able to print out the recipe and exercise, a composite of the recipe and exercise should be provided as a downloaded PDF.

Exercise Steps

Unlike recipe steps, exercise steps should provide an illustration of the results and thinking behind application of individual recipe steps to a real-world example. Exercise steps should link to TAPoR tools used and can also graphically show the actuall results returned from using those tools. A user should be able to follow through the exercise steps by actually carrying out the exercise themselves or simply by following the results your illustrate. If you apply the tools to a specifci text, a link to that text should be provided for other users.

Next Steps/Further Information

If there are any existing pages or websites which provide information related to your exercise, they can be linked in this section.

Points to Keep in Mind

Additional thoughts...........

-- ShawnDay - 12 Jun 2006


Topic: RecipeStructure . { View | Diffs | r1.3 | > | r1.2 | > | r1.1 | More }

Revision r1.1 - 12 Jun 2006 - 01:27 - ShawnDay
Revision r1.3 - 18 Apr 2007 - 13:11 - ShawnDay