At Eat Your Books we are a bit fanatical about the quality of our data, and so are our members, so it's important to make sure you are as accurate as possible and adhere to EYB's guidelines.
It's important to read through this guide BEFORE you start indexing as it gives an overview of what's expected. (The most recently added or updated information is highlighted in yellow.) Having read these guidelines, please let EYB know if you do not feel you can index a book so we can unassign the book and make it available to another member.
If a book is not started within 14 days of being assigned, it will be unassigned.
In addition to this overview, there is a ? next to each data entry field on the input form; click on this for a detailed explanation of how to complete that field. Before entering each field for the first time, you should review these instructions and refer to them regularly while indexing. The complete indexing manual can be found here: Indexing Form Instructions, and it can also be accessed on the input form by clicking the Help (?) button.
NOTE: This Administration Manual describes how to make a request to index a book, what is required, and an overview of the mechanics of EYB indexing. It DOES NOT explain indexing rules or the philosophy behind indexing: how to format English and foreign titles, how to categorize recipes, how to decide which ingredients to list and which to omit, how to deal with accompaniments versus recipes within recipes, etc. Indexers should consult the Indexing Form Instructions for complete descriptions and illustrations of EYB's indexing guidelines.To help you get started, here's a quick list of the most common mistakes new indexers make:
Do's and Don'ts of Indexing -- How to Avoid the Top 11 Indexing Mistakes
- DON'T capitalize every word in the recipe title. DO capitalize the first word and any proper nouns, place names, words capitalized in EYB ingredient names, etc. --► more info
- DO put the English title first, followed by any foreign-language title after it in parentheses (with the first word of each title capitalized), no matter how it appears in the book. --► more info
- DO check the Recipe Types List for how to categorize many common recipes by Recipe Type, Ethnicity, Course, and Nutrition, plus capitalization of many words in titles. more info
- DON'T list the common pantry ingredients that fall below the thresholds in the Store-Cupboard Ingredients Table, unless they're in the recipe title.
- DON'T list the special ingredient 'store-cupboard ingredients' unless the number of omitted store-cupboard ingredients is more than half the total number of ingredients in the recipe or more than half the total volume of the recipe. If less than half, just omit them. --► more info
- DO categorize recipes as Vegetarian (and Vegan, where applicable) according to the definitions in the Indexing Form Instructions and the guidelines in the Recipe Types List. DO index both Vegetarian and Vegan if applicable wherever the Recipe Types List indicates that both are to be indexed. --► more info
- DON'T make recipes Accompaniments unless they're served in the same Course/alongside each other. DO make Accompaniments reciprocal. --► more info
- DO check the Indexing Form Instructions for special guidelines about certain ingredients, like fresh citrus juice/zest/peel (index the whole fruit, 'lemons', 'oranges', etc.), chocolate (index bittersweet/semisweet as 'dark chocolate'), and common fruits/vegetables (not every variety is indexed). --► more info
- DON'T put public notes about recipes in the Indexer Notes field; DO put them in EYB Comments, and only use Indexer Notes for communicating with EYB staff. DON'T over-comment in the EYB Comments field. DO follow EYB's standard format for substitution comments -- "Can substitute A for B, and C for D." -- and close all comments with a period. --► more info
- DO proofread your work carefully! And one more for good measure...
- DO read and refer to the Indexing Form Instructions for complete indexing guidelines!
- Categorizing Recipes
- Adding Ingredients
- Ingredient Name Variations
- Copying ingredients from a previous recipe
- Requesting new ingredients
- Saving a recipe
- Ending/resuming a data entry session
- Proofreading and editing recipes
- Inserting a missed/new recipe
- Editing and deleting recipes
Submitting a book to EYB on completion
Useful Lists to have open while indexing:
Make sure you have the latest version of your web browser installed.
- The EYB online data entry interface was optimized for Google Chrome, Internet Explorer and Firefox on PCs, but should display and function correctly on most major browsers for PC and Mac; if you experience problems with the data entry form, try updating your browser, or switch to a different browser for your particular platform.
- You should be familiar with how to add accents to characters, as many recipe titles incorporate foreign words that use accents. Without these being added correctly, a word can take on quite a different meaning: pâté (meat paste) vs. pâte (pastry).
More detailed Information
- PC users have several options, but the easiest way to insert accents is to use the Character Map utility built into Windows (XP, Vista, Windows 7). Find it here:
Start » Programs » Accessories » System Tools » Character Map
It's a good idea to add the Character Map to your Start menu (right click on Character Map and select 'Pin to Start Menu') for easy access.
- Mac users can use Option keys or the KeyCaps desk accessory located under the Apple menu.
Log in as usual to Eat Your Books.
- Select the book you wish to index and click the "Request Index" link under the book cover image.
- Under "I would like to Index this book myself," click the Request to Index button. You will be asked to confirm you understand what you are undertaking. EYB will send you an email when the book has been assigned to you.
NOTE: Member indexers may only be assigned one title to index at a time.
You will be sent an email by EYB to let you know that a book has been assigned to you.
Click on the link in the email and you will be taken to the input-form, OR...
- Select "Indexing" from the My Bookshelf tab at the top of the page.
- Check that the 13-digit ISBN, the Book Title, and Author/s match the book you are indexing. If not, please notify Sydney (email@example.com) before starting to index the book so that any errors can be corrected.
- Click on "Index" to the right of the title of the book, which will take you to the input form.
The data input form has been designed for easy and quick inputting of data. Your input speed will significantly improve once you become familiar with the form, the shortcuts, and the drop-down menus. Very often it's only necessary to type the first few letters of any selection.
- The recipe title is the first field; use Tab to go to the next field.
- It is important that you read the Help file (click on the ? next to each field) before you enter your first recipe to understand exactly how it works.
- In the variable selection fields, you will see a list of options once you start typing.
- If you make a mistake the (x) next to each entry will delete it.
- Once you have completed a recipe and checked it, click on " Save and New" to go to a blank data entry form.
Most recipes should be categorized by a pre-defined list of Recipe Types. When indexing your recipes, it is important that you use the categorizations as defined by EYB, otherwise, there will be many inconsistencies across books indexed by members.
The Recipe Types List will assist you in deciding how recipes should be categorized. Although the list is organized by Recipe Types, it also has valuable notes about other categories such as Ethnicity, Course, Nutrition, and Occasion. We suggest you keep this open on your computer so you can search it while you are indexing. See Recipe Types List.
The Ingredients field is fully searchable and will accept as many ingredients as need to be listed for a recipe. NOTE: Ingredients do not need to be entered in the order in which they appear in the recipe, in order of importance, or any particular order. In fact, missed ingredients and other ingredients added after the recipe is first indexed will show up at the bottom of the list of ingredients.
- Shortcuts: For some commonly encountered ingredients, EYB has created 2 or 3-character “shortcut” codes. e.g. ‘lb’ = ‘light brown sugar'. Your data input speed will increase significantly once you are familiar with these codes. See Shortcut codes list
- Entering an ingredient: Once you enter at least 3 characters of the ingredient name, the system will display a drop-down of the first 30 ingredients that match. All fruit and vegetables are entered as plurals.
You can either scroll down to the ingredient you want or continue to type until the ingredient comes to the top of the list, then press Enter to select that ingredient.
For ingredients that have a common name at the start so that you have to type more than one word to see your ingredient, it can be faster to type letters in the middle e.g. instead of typing "chicken br" before you see chicken breasts, type "en ch" - saves you five keystrokes every time.
NOTE: An ingredient is not added until it moves out of the box and displays in the Ingredients list above the box with a delete sign (x) next to it.
- Deleting an ingredient: If you select an incorrect ingredient, delete it by clicking the (x) next to the ingredient.
Some ingredient names differ significantly depending on the country/cuisine. In these cases, EYB has created a master ingredient with one or more linked variations.
- Regional variation: e.g. “eggplants” in the US, Canada, Australia and New Zealand are called “aubergines” in the UK.
- Spelling variation: e.g. the herb mix za’atar can also appear in recipes as zaatar, zahtar, and zathar, among other spellings.
Indexers should list the ingredient that appears in the recipe so that users will see “aubergines” listed in recipes from UK cookbooks.
In the example below, the master ingredient is beets, with a variation beetroots (1). The variation ‘beetroots’ is being selected and will display in the recipe on EYB, but users searching for either ‘beets' or ‘beetroots’ will find this recipe.
Recipes often have several variation recipes that should be indexed separately, and the ingredient lists are very similar. You can copy all the ingredients from the previous recipe into the current one, by clicking 'Add from previous'. Delete any unneeded ingredients by clicking the (x) next to the ingredient name, and add new ones as previously described.
Although there are more than 37,000 ingredients listed in the EYB database, new ones still occasionally need to be added. Once you're sure the ingredient you want to index doesn't exist, enter new ingredient as an ingredient and type the name of the ingredient in the New Ingredients box. Provide any information available about the new ingredient(s) in the Indexer Notes field.
If you know that an ingredient that's used throughout the book is missing, then send an email to firstname.lastname@example.org to request that it be added while you're still indexing the book.
After you have completed your recipe and reviewed it, click 'Save & New' to save your record and call up a new data entry form. The system will automatically assign a Sort Order value on the new form to maintain recipes in book order.
If you wish to end a data entry session before you've finished indexing all the recipes in the book, be sure to click 'Save & New' on your last recipe so that your screen shows a blank data entry form.
When you resume your data entry the system will take you to the next blank data entry form where you left off.
You should proofread each recipe before you save it and move on to the next.
- You should check spellings, category types and correct ingredients.
- Once you move to the next recipe, review any fields that have been carried over. Delete anything that doesn't match the current recipe.
- You should also do a final proofread once you've completed the book and before you submit it to EYB. Review your recipes one-by-one.
- If you find that you've missed a recipe, you should insert it into its correct position. Find the recipe before it, note its Sort Order number, and give the new recipe that number plus 5, e.g. if the missed recipe should have been at number 90, you would look at the recipe before, which will be 80, and make the one you missed 85.
- If you missed several recipes, then number them from the previous number plus 1, 2, etc.; in this way, you can enter up to 9 missed recipes between any two recipes in the book.
If you find that you need to edit or delete a recipe – you may discover an error or duplicate recipe during final review/proofreading – use the Recipes Added list to find the recipe.
- Use the filter to find the recipe in the 'Recipes Added' list.
To edit the recipe, click on the title and it will show in the input form above.
- To delete a recipe, click on the (x) in the Action column to the right of the recipe’s title.
When you’ve finished indexing a book and have proofread it, click on the Submit button.
The book will then be reviewed by EYB before it appears on the live site.