File: requirements.dxx

package info (click to toggle)
anymeal 0.29-3-2
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 5,236 kB
  • ctags: 1,280
  • sloc: sh: 11,718; cpp: 11,352; perl: 2,730; lex: 1,098; makefile: 91
file content (101 lines) | stat: -rw-r--r-- 5,238 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
/** \page requirements Requirements
    This page contains the requirements, I specified for the 1.0 version of
    this application. <B>This requirements are only met by the software version
    1.0</B> (and all later versions). The requirements may be subject to
    change.

    @section client Client
    General features:
    \li AnyMeal is able to import Mealmaster recipes (ingredient can be
    specified in two-columns as well) and store them in the
    database. Erroneous recipes can be exported to Mealmaster files to allow
    fast import without extensive user-interaction.
    The Mealmaster file containing the erroneous recipes also contains
    the error-messages.
    \li The user can select a single recipe for being displayed.
    \li The user can select a bunch of recipes to be exported in Mealmaster,
    docbook or HTML.
    \li A database wizard helps the user to setup MySQL.

    @subsection clientSearch Search features
    \li The recipes are searchable using the following criteria:
    title, category, ingredients, user selection. The search results are
    sorted by title.

    @subsection clientMaintain Maintaining the data
    \li A single recipe can be selected for editing. The changes can be
    transferred to the database or be discarded.

    @section database Database
    AnyMeal is a database client software. It is able to retrieve and store
    recipes in a database (and delete them).
    \li The application accesses a <EM>MySQL</EM>-database. The design must
    allow AnyMeal to easily be extended to connect to another type
    of database (with another SQL dialect). The database resides in a
    LAN-network, so that security-issues don't need to be considered.
    \li AnyMeal upgrades the database created by an old client if required.
    \li The passwords for connecting to the databases are stored safely.
   
    @section wishes Wish List
    The following features are wishes, which are not implemented at the
    moment:
    \li The user-interface allows collapsing of categories and ingredients
    (f.e. merge "Indian Desserts" into "desserts" and "indian").
    \li Internationalisation of xsl-script
    \li Display statistics after import.
    \li A single recipe or menu (small list of recipes) can be printed out.
    \li A context help including recipe-sources, FAQ, ...
    \li Backend for ODBC, SQLite, Metakit and Postgresql.
    \li Progressbar for sql-queries. More responsieness. User-break at any
    time.
    \li Maintaining a list of available ingredients and using it for creating
    shopping lists.
    \li Shopping list, which can be completed and refined (access price-list
    of shops, compute total) and printed, assignment of shopping task.
    \li Scaling of recipes: Allow scaling of amount for display.
    \li Conversion of quantity in editor, when unit is changed. Conversion of
    all ingredient-quantities, when yield is changed.
    \li Convert titles to lower case
    \li Alternatively list by categories or by title.
    \li Assemble a meal (starters, main dish, dessert, ...) and meal-planner
    (using a calendar). Also see: <A HREF="http://www.ffts.com/">ffts.com</A>.
    \li Spell-check for recipes.
    \li Interactive combo-box for ingredient-selection in search-dialog.
    Automatic completion for dialog-boxes, listviews.
    \li Import of other formats (Rezkonv, CookML (cml), mastercook, krecipes,
    mango )!?
    \li Filter and store duplicate recipes during import or later.
    \li speech-output
    \li Dialog for maintaining categories, units, ingredients (merge, delete,
    rename).
    \li Full-text search
    \li Test multi-user environment.
    \li Allow categorisation on import.
    \li Import recipes from Internet (by downloading and importing file)
    \li Compute nutrition of ingredients using free USDA nutrition database 
    Add a constraint solver.
    \li Use KDE I/O-handlers for access to arbitrary sources.
    \li Web-server
    \li Move recipes from one database to another
    \li Support drag and drop.
    \li SOAP components with examples for seamless integration in
    Apache-Webservers
    \li Additional fields: Preparation time, authors, source, e-mail, address,
    date, notes, ingredient-ranges, cuisine (ethnicity), photo(s), recipe
    approval system, rating system, locations/restaurants (+rating), course,
    season, type, preparation method, source, required equipment
    \li Use USDA nutrition database (problem: matching of ingredient-names)
    \li Use UPC database (http://www.upcdatabase.com/) for inventory
    recording, RFID?
    \li Braille-interface? See http://mielke.cc/brltty/,
    http://libbraille.org/, http://accessibility.kde.org/developer/
    \li Stable program under MS-Windows. Problems are: right now Xalan-C
    crashes, when doing xpath-searches; Qt-Windows-3.x is not available for
    free. */

/* Has to be revised:
   There is a special search feature, which distinguishes AnyMeal from
   other cooking-related software:
   \li Recipes may be searched and sorted by a measure, which is indicating,
   how well a recipe fits a set of given ingredients. This allows the user to
   find the best recipe for a composition of given ingredients. */