topic naming convention
"Anton van Straaten" <[email protected]>
| Newsgroups | gmane.lisp.scheme.plt.schematics |
|---|---|
| Message-ID | <[email protected]> |
Before converting too many more cookbook chapters to the new structure, I wondered whether we should consider changing the naming convention a bit. Currently, most chapters are called XxxRecipes, where Xxx is the base name of the chapter, like String or Number. With the new structure, chapters include a separate Section topic which uses a query to generate a list of the actual recipes in the chapter. I've been calling this XxxRecipeSection. I'm thinking it might make sense to change chapters to use a name like XxxChapter, and have recipe sections be called XxxRecipes, so e.g. we'd have StringChapter and StringRecipes, instead of the current StringRecipes and StringRecipeSection. The latter would be nothing but a list of recipes, with no extraneous content (you can see this in StringRecipeSection etc. right now). I could imagine, if someone knows they're looking for a particular recipe in a particular chapter, that they might choose to call up the recipe section directly and just scan through the list, without having to sift through the intro material etc. Having a more concise name for these pure recipe list pages could be useful. A minor side benefit of this is that it would save some changing of the TopicParent as we convert to the new structure - currently, recipes have XxxRecipe as their parent; the conversion requires that this be changed to XxxRecipeSection. With the above naming scheme, no parent changes would be needed. Still, the naming convention should be decided on its own merits. Any reactions or other suggestions? Anton ------------------------------------------------------- This SF.Net email is sponsored by the new InstallShield X. From Windows to Linux, servers to mobile, InstallShield X is the one installation-authoring solution that does it all. Learn more and evaluate today! http://www.installshield.com/Dev2Dev/0504