Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
  • Table occurrences: are always suffixed (not prefixed) with their "base table" name and separated using the » character ( Right-pointing Double Angle Quotation Mark – \x00BB ) using a space on either side of the ». The prefix is TitleCamelCase and indicates the functional area or use within the solution.
    Option-Shift-Pipe (Mac) or Alt+0187 (Win)

    Schedule » People

    good

    A Persons Schedule

    bad

    This method of table occurrence naming is the inverse of the more popular method of using the "base table" name first. This requires a very strong focus to pre-define functional areas in your solution before hand! Sorting of table occurrence names is based on functional domain instead of base table name. Note, however, it's very easy to rename table occurrences if the functional realm changes for a particular group of table occurrences.

Note: The goal of using FunctionalArea » Tablename is to force a degree of self documentation for the distinct areas of your solution. The FunctionalArea itself can be extended as long as it stays TitleCamelCase. For example:

No Format
NavigationAll » Menuitems
NavigationByAccess » Menuitems
NavigationPortal » Menuitems

Where Menuitems is a self explanatory table name and the keyword All may indicate a Cartesian product relationship, the keyword ByAccess indicates the involvement of a possible User table and the keyword Portal clearly indicates its use as a portal table occurrence.

Tip
titleWeb compatible variation

The use of the Right-pointing Double Angle Quotation Mark is simply for readability within the realm of a FileMaker solution intended for use within a FileMaker client/server setup. When implementing a web publishing strategy within your solution it is suggested you use the best practice of the various Solution development models. If this is either not possible or preferred, the variation of table occurrence naming would simply replace » with a double underscore __ and remove spaces. Therefore the resulting examples above would look like so:

No Format
NavigationAll__Menuitems
NavigationByAccess__Menuitems
NavigationPortal__Menuitems

Using a double underscore differentiates a TableOccurrence__Basetable from id_ForeignKey or key_CONSTANT when scanning through code.

@todo: should we come up with a list of suggested terms

  • Table occurrences: which are dedicated for internal development and have no relationships are prefixed with the @ symbol and one space
    This sorts developer table occurrences at the top of the list for selecting tables

    @ People

    good

    Developer People Table

    bad

Info
titleDuplicating Table Occurrences

Some of the comments below provide information about how to access the « and » characters on Windows using Alt key combinations. Keep in mind that simply holding down the Option key (Mac) or Control key (Win) allows you to drag-duplicate a table occurrence. You can also use the duplicate button with the double plus signs. This an easy way to not have to "remember" what the key combination is for the » character.