FMK 2013 Namenskonventionen, Heike Landschulz

Namenskonventionen

FileMaker Konferenz 2013 Salzburg !www.filemaker-konferenz.com

Heike Landschulz www.landschulz.net Namenskonventionen



Zur Person: - (Uni)Studium zum Dipl. Ing. Verfahrenstechnik chemische Industrie - EDV-Abteilung eines Düngemittelwerkes: • Programmierung für Nebenprozesse • Schulung der Anwender

- ab 1995: Selbständig als FileMaker Programmierer - Kunden: Agenturen und projektabarbeitende Dienstleister - FiBu-Schnittstellen

Aussergewöhnlichste Kunden: - Hutmacher - Firma, die die Quartettspiele der Fussballbundesliga vertreibt - eine hamburger Schokoladenmanufaktur

- ab 1990: Vertrieb bei einem Apple-Händler in Hamburg • hier erster Kontakt mit FileMaker II • sowie Werbeagenturen



Benennung von ... in FileMaker kann ganz einfach so umschrieben werden: !

Machen Sie doch was Sie wollen!

Vielen Dank für Ihre Aufmerksamkeit.



Worum es heute geht: Benennung von Dateien, Tabellen, Layouts, Feldern, ...

Worum es nicht heute geht: - Layoutgestaltung - sinnvolle Beispiele bzw. Beispieldaten - Ein- oder Mehrdateienlösung



Quellenangaben- „FileMaker Entwicklerkonventionen„ (FM) [Stand: 2005]

http://www.filemaker.de/downloads/pdf/FileMaker_Development_Conventions.pdf

- Peter Wagemans (PW), myFMbutler

- Martin Schwarz (MS), schwarzsoft

- Claus Lavendt (CL), DataManix

- Matt Petrowsky (MP), www.filemakermagazine.com http://filemakerstandards.org/display/cs/Naming+Conventions

- Torsten Haack (TH), Mamcoa

- Heike Landschulz (HL)

- diverse Antwortende (NN) in FileMaker Foren

- wikipedia



Generell- Einzahl/Mehrzahl

- Kleinschreibung/Großschreibung

- Sonderzeichen

- Suffixe

- Präfixe

- CamelCase-Schreibweisen



Generell - Fortsetzung 1- _Adressen+Aufträge+Rechnungen V3.2a Kunde Müller /

Hauptdatei- 1. Tabelle

- Netto+Brutto

- &

- FROM, where



Generell - Fortsetzung 2CamelCase Benennung

lowerCamelCase meinDateiName UpperCamelCase MeinDateiName

Klein-/Großschreibung mit Unterstrichen

Einzelner Unterstrich (kleinschreibung) mein_datei_name

Einzelner Unterstrich (Titelschreibung) Mein_Datei_Name

Einzelner Unterstrich (GROßSCHREIBUNG) MEIN_DATEI_NAME



Dateien• Beschränkung durch die Betriebssysteme

- bei 100 Zeichen aufgehört zu zählen Mac: kein Punkt als erstes ZeichenPraxistipp: FileMaker-Server 12 auf Mac lädt keine Dateien - mit Leerzeichen als erstes Zeichen - mit Umlauten im Namen

• möglicherweise Beschränkungen durch Anbindung an ODBC-, JDBC-, XML-Schnittstellen und dem SQL-Befehl

• FM-Empfehlung: keine Versionsnummern im Dateinamen

• Dateiendung auf Windows muß .fmp12 • auf Mac ist sie optional • sollte in Kleinschreibung • Runtime-Endungen sind beliebig



Dateien - Fortsetzung 1FM-Empfehlungen:- Buchstaben aA-zZ in Klein- und Großschreibung - Die Zahlen 0,1,2,3,4,5,6,7,8,9 - Einzelne und doppelte Unterstriche: „_“ und „__“ - Sollten KEINE Leerzeichen enthalten - Sollten NICHT mit einer Zahl beginnen - Sollten NICHT zur Angabe von Versionsinformationen verwendet

werden - Sollten KEINE Punkte enthalten, abgesehen von dem einzelnen Punkt,

der zur Absetzung des Suffix verwendet wird - Sollten in einheitlicher Weise den Singular oder den Plural verwenden - Einzelne Wörter sollten in einheitlicher Weise mit einer der folgenden

Methoden getrennt werden:



Dateien - Fortsetzung 2Empfohlene Methoden zur Kennzeichnung bei Mehrdateien-Lösungen (FM)

‣ Hilfsdateien mit einem Präfix versehen werden z.B. hd_Tickets.fmp12

‣ Primärdateien sollten ein Suffix erhalten, welcher sich in den Hilfsdateien wiederfindet

z.B. MeineLösung_ABC.fmp12 ABC_hilfsDatei1.fmp12 ABC_hilfsDatei2.fmp12



Tabellen und Felder• Es gilt das generelle und zu Dateien Gesagte • Ausnahme: Tabellennamen können max. 100 Zeichen lang sein

Bekanntes Dialogfenster bei Verwendung nicht erwünschter/erlaubter Zeichen:

Ergebnis z.B. in Formeln: ${-Tabelle1}::Textfeld & "XX"



Tabellen und Felder (NN)Beispiel aus einem Forum und TH

...

...

...

...



Tabellen (FM)Empfehlung für große Projekte: Blindtabellen zur Kategorisierung

FileMaker Entwicklerkonventionen v1.0

- 19 -

2.4 Weiterführende Überlegungen Verwendung von Fülltabellen: In Lösungen mit einer großen Anzahl von Tabellen kann es hilfreich sein, der Liste Ihrer Tabellennamen eine Kategorisierung hinzuzufügen. Da die Entwicklungsumgebung eine solche Möglichkeit nicht bietet, muss sie auf anderem Wege umgesetzt werden. Im unten gezeigten Beispiel haben wir eine relativ kurze Liste, die aber zur Illustration ausreichen sollte. Je länger die Liste, desto offensichtlicher zeigen sich die Vorteile. Wir haben Tabellen angelegt, die bereits anzeigen, dass sie als Kategorieüberschriften dienen. Das Beispiel zeigt „-Buchhaltung-“, „-Kommunikation-“ und „-Registrierung-“. Es handelt sich einfach um Tabellen ohne Felder. Sie können die dazugehörigen Tabellenauftreten aus dem Beziehungsdiagramm entfernen, da sie innerhalb der Lösung nicht verwendet werden. Wie Sie sich vorstellen können, lassen sich umfangreiche Lösungen damit etwas besser organisieren. In unserem Beispiel verwenden wir ein vorangestelltes und ein abschließendes „-“. Sie können natürlich jedes beliebige Zeichen verwenden. Es geht hierbei nur darum, Namen zu verwenden, die sich ganz klar von den Namen „normaler“ Tabellen unterscheiden. Bei manchen Zeichen werden Sie evtl. eine Warnung von FileMaker erhalten, die Sie aber ignorieren können, da Sie die Tabelle nicht verwenden.

Abb. 1

Tabellenauftreten (MP)ein Tabellenauftreten zur internen Entwicklung ohne Beziehungen: @ Abcd



Tabellen und Schlüsselfelder (CL)Benennung Tabellen: CON_Contact, ADR_Address



FelderFM: Sortierung nach Feldname und Gruppierung


- 23 -

5. Einzelne Wörter sollten in einheitlicher Weise mit einer der folgenden Methoden getrennt werden.

Empfohlene Methoden zur Trennung einzelner Wörter (Berechtigungen) lowerCamelCase meinFeldName UpperCamelCase MeinFeldName Einzelner Unterstrich (Kleinschreibung) mein_feld_name Einzelner Unterstrich (Titelschreibung) Mein_Feld_Name Einzelner Unterstrich (GROSSSCHREIBUNG) MEIN_FELD_NAME

6. Felder sollten nach Feldnamen sortiert sein 7. Je nachdem, welches bzw. welche Zeichen Sie als Indikator für Hilfsfelder verwenden,

sollten Sie davon absehen, Feldnamen mit diesem bzw. diesen Zeichen zu beginnen. Im Bereich der Hilfsfelder sind dies der bzw. die Buchstaben „z“ und „zz“ sowie andere Unicode-Zeichen, die für eine Sortierung ans Ende der Liste sorgen, unter der Voraussetzung, dass die Liste nach Namen sortiert ist.

8. Nach Möglichkeit sollte Namengruppierung genutzt werden, z. B. wie folgt: Namen_Vorname Namen_Nachname AdresseStadt AdresseBundesland AdressePostleitzahl reisepassNummer reisepassAusstellendesLand reisepassAblaufDatum reisepassName

9. Bei abgeleiteten oder Formelfeldern, die nach Entscheidung des Entwicklers keine Hilfsfelder sind, aber eine Notation enthalten sollen, sind bezüglich des Suffixes die Empfehlungen für „Hilfsfelder“ zu befolgen. Zum Beispiel ist „RechnungsbetragGesamt“ zwar ein Formelfeld, aber kein Feld, das Sie vor dem Benutzer „verbergen“ wollen. Allerdings möchten Sie evtl. eine Notation hinzufügen. In diesem Fall würden Sie das Feld „ RechnungsbetragGesamt __lcn“ nennen, um anzugeben, dass das Feld lokal gespeichert ist, berechnet wird und vom Typ „Zahl“ ist. Unter Benennung von Hilfsfeldern finden Sie hierzu weitere Informationen.

3.3.2 Schlüsselfelder FileMaker schreibt keinerlei Art von „relationaler Integrität“ vor oder erzwingt diese, wie es bei SQL-basierten relationalen Datenbankverwaltungssystemen (RDBMS) der Fall ist. Beispielsweise werden Sie nicht gezwungen, einen Primärschlüssel für eine Tabelle anzulegen. Es gibt weder optisch noch aus dem Kontext heraus eine Angabe, dass ein Feld ein Schlüsselfeld ist. In den meisten Fällen ist es wünschenswert oder erforderlich, innerhalb der Lösung Schlüsselfelder zu nutzen. Sie können Notation verwenden, um Felder als Schlüsselfelder zu identifizieren. Sollten Sie sich dazu entscheiden, eine Notation für Schlüsselfelder zu verwenden, wird die folgende Syntax für die standardisierte Vorgehensweise bei der Namensgebung empfohlen. Forderungen für die Syntax bei Schlüsselfeldern:

Bereitstellung allgemein verfügbarer, verstandener und einheitlicher Richtlinien zur Notation von Metadaten bei Schlüsselfeldern.

NN: Tabellenkürzel als Präfix

??? ‣ macht Beziehungsnamen unnötig lang ‣ macht Layouts unnötig unübersichtlich ‣ ist für mich nicht hilfreich - es fehlt im Layout die Beziehung



Felder - Schlüsselfelder

Syntax: [_k]<funktion>(speicherung)(typ)[__]BeschreibenderNameFM

“_” – erforderlichk - Kleinschreibung; erforderlich funktion - Kleinschreibung; erforderlich; verwendet bei Benutzung vorgegebenen Wert Kennzeichnet die Schlüsselfeldkategorie oder gibt den Zweck des Feldes an.

speicherung - Kleinschreibung; optional; verwendet bei Benutzung vorgegebenen Wert Gibt die Speicherart an. - l = Lokale Speicherung (kleingeschriebenes “L”) - g = Globale Speicherung

- p – Primärschlüssel - f – Fremdschlüssel - a – Alternativer Schlüssel - c – Zusammengesetzter / Berechneter Schlüssel - m – Mehrzeilenschlüssel



Felder - Schlüsselfelder - Fortsetzung

Syntax: [_k]<funktion>(speicherung)(typ)[__]BeschreibenderNameFM

typ - Kleinschreibung; optional; verwendet bei Benutzung vorgegebenen Wert Gibt den Feldtyp an.

- t=Text - n=Zahl - d = Datum - i=Zeit - m = Datumsstempel

“__” – erforderlich

BeschreibenderName – Groß-/Kleinschreibung wie festgelegt


- 25 -

• l = Lokale Speicherung (kleingeschriebenes “L”) • g = Globale Speicherung

typ - Kleinschreibung; optional; verwendet bei Benutzung vorgegebenen Wert

Gibt den Feldtyp an. • t = Text • n = Zahl • d = Datum • i = Zeit • m = Datumsstempel

“__” – erforderlich

Ein doppelter Unterstrich sollte verwendet werden, um die Syntax vom beschreibenden Feldnamen zu trennen.

BeschreibenderName – Groß-/Kleinschreibung wie festgelegt Beschreibender Name des Schlüsselfelds

Beispiele: Vollformat: Verwendung aller optionalen Metadaten

Minimalformat: ohne Metadaten

_kplt__RechnungsID _kp_RechnungsID _kcgt__AusgewaehlteTeilnehmer _kc_AusgewaehlteTeilnehmer _kflt__KundenId _kf__KundenId _kmgt__AusgewaehlteTageAnsicht _km__AusgewaehlteTageAnsicht _kflt__Rechnung_rechnungsposition _kf__Rechnung_rechnungsposition

3.3.3 Hilfsfelder Die Konventionen zur Benennung von Hilfsfeldern sollen eine einheitliche Methode bereitstellen, die den unterschiedlichen Bedürfnissen von Entwicklern gerecht wird. Außerdem sollen einige der häufigsten Probleme behoben werden, die bei der Benennung von Feldern auftreten, die der Endanwender nicht sehen soll. Forderungen an die Notation für Hilfsfelder:

Bereitstellung allgemein verfügbarer, verstandener und einheitlicher Richtlinien zur Notation von Metadaten bei Hilfsfeldern.

Erkennen eines Hilfsfelds Angabe der Funktion eines anpassbaren Hilfsfelds Angabe der Speicherart Angabe des Datentyps Kennzeichnung eines Hilfsfelds als Wiederholfeld Sortierung von Hilfsfeldern an das Ende der Feldliste, bei gleichzeitiger alphabetischer

Sortierung innerhalb der Schlüsselfelder. Dies reduziert für den Entwickler den manuellen Sortieraufwand und sortiert die Felder zugleich so, dass der Anwender sie nicht direkt sieht.

1. Sollten nur folgende Zeichen enthalten:

Die Buchstaben aA-zZ in Klein- und Großschreibung Die Zahlen 0,1,2,3,4,5,6,7,8,9 Einzelne und doppelte Unterstriche: „_“ und „__“



Felder - Fortsetzung 2MS ‣ ID_Motiv (Primary Key)

‣ fk_001 (Foreign Key) ‣ Betrag_n (Zahlen) ‣ Anschrift_ct (Formel mit Ergebnis Text)

PW ‣ _K1_XXX (Primary Key) ‣ _K2_aaa, _K3_bbb (Foreign Keys)

NN ‣ ___pk_Abc (Primary Key) ‣ __fk_Xyz (Foreign Key) ‣ c_firma (Textfeld) ‣ n_betrag (Zahlenfeld) ‣ _f_briefanrede (Formel)

HL ‣ ID_RECHNUNG_Z (Primary Key) ‣ ID_Adresse_Z (Foreign Key) ‣ Name_T ‣ Name_komplett_FT ‣ Zahlungsziel_FD



Layouts

‣ keine Leerzeichen ‣ nicht mit einer Ziffer anfangen ‣ als Sonderzeichen nur _ bzw. __ enthalten ‣ empfohlene Syntax: <FunktionsPräfix>>[__]BeschreibenderName[__]<TabellenauftretenName>

• max. Länge: 100 Zeichen • Beachtung ODBC, PHP, ... Zugriffe

FM

Zitat: „Fehlende Möglichkeit, gleichzeitig einen benutzerfreundlichen und einen für den Entwickler zweckmäßigen Namen zu vergeben: Bis einschließlich FileMaker 9 besteht keine Möglichkeit, einen Namen zu vergeben, der sowohl benutzerfreundlich als auch für den Entwickler informativ ist. Als Entwickler müssen Sie sich für eine der beiden Vorgehensweisen entscheiden.“

Hinweis: Es ist möglich mehrere Layout mit demselben Namen anzulegen. s. FMM 2011_0506 S. 15 und FMM2012_01 S. 5 Arnold Kegebein

Heute gibt es vermutlich die Empfehlung, die Layouts in Ordnern zu gruppieren.



Layouts - FortsetzungMS ‣ F_Adresse --> Formularlayout

‣ L_Adresse --> Listenlayout

PW ‣ Tickets Detail ‣ Tickets List --> Navigation über die Layout ID

CL ‣ CON_Detail ‣ CON_List

HL ‣ KVA_Liste ‣ KVA_Eingabe ‣ KVA_Druck ‣ KVA_Liste_Druck



Eigene Funktionendurch einheitliche Namensgebung Zusammengehörigkeit dokumentieren: • UrlHervorheben • UrlLetztesZeichen • UrlZurueckgebenAlle • UrlZurueckgebenEinen

FM

empfohlene Syntax: EigeneFunktionName[__][CFxxx] xxx: pub --> zuerst aufgerufene Eigene Funktion pvt --> „indirekte“ EF; wird von einer anderen EF aufgerufen

Parameter: „... sollten das Standardformat aller FileMaker-Funktionen verwenden...“



Vielen Dank unseren Sponsoren

Danke für das Bewerten dieses Vortrages

Documents

FMK 2013 Namenskonventionen, Heike Landschulz