Recipe Style Guide: Difference between revisions

From Burleson Family Wiki
No edit summary
No edit summary
 
Line 1: Line 1:
=Our Recipe Style Guide=
= Recipe Style Guide v1.3 =


==General Format==
This guide defines the required editorial standards for all recipes posted on this wiki.
* Use a consistent layout with clear section headings.
* Title in ALL CAPS or Title Case, underlined with =.
* Subheadings underlined with -.
* Ingredients as a bulleted list (-).
* Instructions as a numbered list (1., 2., etc.).
* Use a single blank line between list items.
* Use a double blank line between major sections.
* Keep lines within 72–80 characters for readability.
* Use left alignment with minimal indentation.


==Section Order==
== 1. Page Title ==
# Recipe Title
* Use Title Case (capitalize key words).
# Servings, Prep Time, Cook Time (inline)
* If needed, disambiguate with parentheses. 
# Ingredients
  Example: <code>Chili (Vegetarian)</code>
# Instructions
# Optional Sections: Notes, Variations, Make Ahead, Storage, Tags


==Measurement Abbreviations==
== 2. Intro Paragraph ==
* Write a 1–2 sentence overview of the dish.
* Optional: origin, use case (holiday, quick meal), or dietary label.


Use these standard abbreviations (lowercase):
== 3. Ingredients ==
* tsp = teaspoon
* Use a bulleted list (<code>*</code>).
* tbsp = tablespoon
* One item per line.
* oz = ounce(s)
* Include necessary prep terms (e.g., chopped, minced, grated).
* lb = pound(s)
* Use only US customary measurements; metric optional.
* g = gram(s)
* Fractions:
* kg = kilogram(s)
** Use slash notation only (e.g., <code>3/4</code>)
* ml = milliliter(s)
** Combine whole + fraction with a dash and no spaces (<code>1-1/2</code>).
* l = liter(s)
** Do NOT use typographic characters like <code>½</code> or <code>¼</code>.
* c = cup(s)
* pkg = package
* pt = pint
* qt = quart


==Measurement Formatting==
* Abbreviations must follow this exact list (no periods or plurals):
* Use fractions (e.g., 1/2, 3/4) instead of decimals when practical.
* Write quantity first, then unit, then ingredient (e.g., 1 c flour).
* Use lowercase units with no periods (e.g., tbsp, not Tbsp.).
* Describe ingredient preparation after the name (e.g., onion, diced).
* Optional ingredients or notes can appear in parentheses.


==Language and Phrasing==
{| class="wikitable"
* Use imperative mood in instructions: Add, Mix, Simmer, etc.
! Unit !! Abbreviation
* Avoid vague terms like some or a pinch unless contextually appropriate.
|-
* Be consistent with ingredient names (e.g., always use bell pepper).
| teaspoon || tsp
* Keep language concise and precise.
|-
| tablespoon || tbsp
|-
| cup || cup
|-
| ounce || oz
|-
| pound || lb
|-
| gram || g
|-
| kilogram || kg
|-
| liter || L
|-
| milliliter || mL
|-
| inch || in
|-
| degree Fahrenheit || °F
|-
| degree Celsius || °C
|}


==Optional Sections==
*Examples:*
* Notes – substitutions, tips, or clarifications
<pre>
* Variations – optional changes or regional styles
* 1-1/2 tsp ground cinnamon
* Make Ahead – prep steps that can be done in advance
* 3 tbsp olive oil
* Storage – how to store the finished dish
* 3/4 cup chopped walnuts
* Nutrition – only if accurate and brief
* 1 lb boneless chicken thighs
* Tags – dietary/category labels (e.g., vegan, gluten-free, spicy)
</pre>


==Formatting Summary==
== 4. Instructions ==
* Title: uppercase or title case, underlined with =
* Use numbered steps (<code>#</code>).
* Headings: underlined with -
* One action per step, clear and concise.
* Bullets: - for ingredients
* Do not re-specify ingredient prep in this section.
* Numbers: 1., 2., etc. for instructions
 
* Spacing: blank line between items, double between sections
== 5. Source (Required) ==
* Line width: 72–80 characters max
Use a <code>== Source ==</code> section.
* Examples:
** <code>Original recipe</code>
** <code>Adapted from Joy of Cooking</code>
** <code>Based on https://example.com/my-recipe</code>
 
== 6. Optional Sections ==
Add only if applicable:
* <code>== Tips ==</code>
* <code>== Variations ==</code>
* <code>== Storage ==</code>
* <code>== Nutrition ==</code>
 
== 7. Categories (Required) ==
* Every recipe must include at least one category:
<pre>
[[Category:Desserts]]
[[Category:Gluten-Free]]
</pre>
 
== 8. Images ==
* Use the following format:
<pre>
[[File:Example.jpg|thumb|Descriptive caption]]
</pre>
* Use natural light, relevant, high-quality images when possible.
 
== 9. Templates (Optional) ==
* If using a recipe info template:
<pre>
{{RecipeInfo|prep=10m|cook=25m|serves=4}}
</pre>
 
== 10. Formatting Marker ==
All pages formatted to this standard should end with the following:
<pre>
----
''Formatted to [[Project:Recipe Style Guide v1.3]] on ~~~~~ by ChatGPT''
</pre>
 
----
 
''This style guide was finalized June 15, 2025.''

Latest revision as of 10:25, 15 June 2025

Recipe Style Guide v1.3

This guide defines the required editorial standards for all recipes posted on this wiki.

1. Page Title

  • Use Title Case (capitalize key words).
  • If needed, disambiguate with parentheses.
 Example: Chili (Vegetarian)

2. Intro Paragraph

  • Write a 1–2 sentence overview of the dish.
  • Optional: origin, use case (holiday, quick meal), or dietary label.

3. Ingredients

  • Use a bulleted list (*).
  • One item per line.
  • Include necessary prep terms (e.g., chopped, minced, grated).
  • Use only US customary measurements; metric optional.
  • Fractions:
    • Use slash notation only (e.g., 3/4)
    • Combine whole + fraction with a dash and no spaces (1-1/2).
    • Do NOT use typographic characters like ½ or ¼.
  • Abbreviations must follow this exact list (no periods or plurals):
Unit Abbreviation
teaspoon tsp
tablespoon tbsp
cup cup
ounce oz
pound lb
gram g
kilogram kg
liter L
milliliter mL
inch in
degree Fahrenheit °F
degree Celsius °C
  • Examples:*
* 1-1/2 tsp ground cinnamon
* 3 tbsp olive oil
* 3/4 cup chopped walnuts
* 1 lb boneless chicken thighs

4. Instructions

  • Use numbered steps (#).
  • One action per step, clear and concise.
  • Do not re-specify ingredient prep in this section.

5. Source (Required)

Use a == Source == section.

6. Optional Sections

Add only if applicable:

  • == Tips ==
  • == Variations ==
  • == Storage ==
  • == Nutrition ==

7. Categories (Required)

  • Every recipe must include at least one category:
[[Category:Desserts]]
[[Category:Gluten-Free]]

8. Images

  • Use the following format:
[[File:Example.jpg|thumb|Descriptive caption]]
  • Use natural light, relevant, high-quality images when possible.

9. Templates (Optional)

  • If using a recipe info template:
{{RecipeInfo|prep=10m|cook=25m|serves=4}}

10. Formatting Marker

All pages formatted to this standard should end with the following: 

----
''Formatted to [[Project:Recipe Style Guide v1.3]] on ~~~~~ by ChatGPT''

This style guide was finalized June 15, 2025.

Retrieved from "https://family.pdxist.com/index.php?title=Recipe_Style_Guide&oldid=1256"