FMK 2013 Namenskonventionen, Heike Landschulz

Namenskonventionen

Heike Landschulz www.landschulz.net
Namenskonventionen

FileMaker Konferenz 2013 Salzburg

!

www.ﬁlemaker-konferenz.com

Zur Person:
-
(Uni)Studium zum Dipl. Ing. Verfahrenstechnik chemische Industrie
-
EDV-Abteilung eines Düngemittelwerkes:

• Programmierung für Nebenprozesse

• Schulung der Anwender

-
ab 1990: Vertrieb bei einem Apple-Händler in Hamburg

• hier erster Kontakt mit FileMaker II

• sowie Werbeagenturen

- 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
Namenskonventionen


!


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

Machen Sie doch was Sie wollen!

Vielen Dank für Ihre Aufmerksamkeit.

Namenskonventionen


!


Worum es heute geht:

Benennung von Dateien, Tabellen, Layouts, Feldern, ...

Worum es nicht heute geht:

- Layoutgestaltung
- sinnvolle Beispiele bzw. Beispieldaten
- Ein- oder Mehrdateienlösung

Namenskonventionen


!


Quellenangaben
- „FileMaker Entwicklerkonventionen„ (FM) [Stand: 2005]
http://www.filemaker.de/downloads/pdf/
FileMaker_Development_Conventions.pdf
- wikipedia
- Peter Wagemans (PW), myFMbutler
- Martin Schwarz (MS), schwarzsoft
- Claus Lavendt (CL), DataManix
- Torsten Haack (TH), Mamcoa
- Matt Petrowsky (MP), www.filemakermagazine.com

http://filemakerstandards.org/display/cs/Naming+Conventions

- diverse Antwortende (NN) in FileMaker Foren
- Heike Landschulz (HL)
Namenskonventionen


!


Generell
- Einzahl/Mehrzahl
- Kleinschreibung/Großschreibung
- Sonderzeichen
- Suffixe
- Präﬁxe
- CamelCase-Schreibweisen

Namenskonventionen


!


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

- 1. Tabelle
- Netto+Brutto
- &
- FROM, where

Namenskonventionen


!


Generell - Fortsetzung 2
CamelCase Benennung
lowerCamelCase

UpperCamelCase

MeinDateiName

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

Namenskonventionen


!


Dateien
• Beschränkung durch die Betriebssysteme
-
bei 100 Zeichen aufgehört zu zählen
Mac: kein Punkt als erstes Zeichen

Praxistipp:
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

Namenskonventionen


!


Dateien - Fortsetzung 1
FM-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:

Namenskonventionen


!


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

‣
Hilfsdateien mit einem Präﬁx versehen werden

z.B. hd_Tickets.fmp12

‣
Primärdateien sollten ein Suffix erhalten, welcher sich in den
Hilfsdateien wiederﬁndet

z.B.
MeineLösung_ABC.fmp12

ABC_hilfsDatei1.fmp12

ABC_hilfsDatei2.fmp12

Namenskonventionen


!


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"
Namenskonventionen


!


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

...

...

...

...

Namenskonventionen


!


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

Abb. 1

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

Namenskonventionen


!


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

Namenskonventionen


!


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.
FM: Sortierung nach Feldname und Gruppierung
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 NotationPräﬁx sollen, sind bezüglich des Suffixes die
NN: Tabellenkürzel als enthalten
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.

Felder

3.3.2 Schlüsselfelder

FileMaker schreibt keinerlei Art von „relationaler Integrität“ vor oder erzwingt diese, wie es
lang
??? ‣ macht Beziehungsnamen unnötig(RDBMS) der Fall ist.
bei SQL-basierten relationalen Datenbankverwaltungssystemen
‣ macht Layouts unnötig unübersichtlich
Beispielsweise werden Sie nicht gezwungen, einen Primärschlüssel für eine Tabelle anzulegen.
‣ ist für mich nicht hilfreich - Angabe, dass ein Feld ein
Es gibt weder optisch noch aus dem Kontext heraus eine es fehlt im Layout die Beziehung
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.
Namenskonventionen

Felder - Schlüsselfelder
FM
Syntax: [_k]<funktion>(speicherung)(typ)[__]BeschreibenderName
“_” – erforderlich 
k - Kleinschreibung; erforderlich  
funktion - Kleinschreibung; erforderlich; verwendet bei Benutzung
vorgegebenen Wert Kennzeichnet die Schlüsselfeldkategorie oder gibt den
Zweck des Feldes an.
  - p – Primärschlüssel
- f – Fremdschlüssel
- a – Alternativer Schlüssel
- c – Zusammengesetzter / Berechneter Schlüssel
- m – Mehrzeilenschlüssel
speicherung - Kleinschreibung; optional; verwendet bei Benutzung
vorgegebenen Wert Gibt die Speicherart an.  

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

Namenskonventionen


!


•
•


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

typ - Kleinschreibung; optional; verwendet bei Benutzung vorgegebenen Wert
Felder - Schlüsselfelder - Fortsetzung
Gibt den Feldtyp an.

•
FM t = Text
• n = Zahl
Syntax: [_k]<funktion>(speicherung)(typ)[__]BeschreibenderName
• d = Datum
typ - i = Zeit
• Kleinschreibung; optional; verwendet bei Benutzung vorgegebenen
• m = den Feldtyp
Wert Gibt Datumsstempelan. 
- t=Text
 “__” – erforderlich
- n=Zahl
Ein doppelter
Unterstrich sollte verwendet werden, um die Syntax vom
- d = Datum
beschreibenden Feldnamen zu trennen.
- i=Zeit
- m = Datumsstempel  
 “__” – erforderlich  – Groß-/Kleinschreibung wie festgelegt
BeschreibenderName
Beschreibender Name des Schlüsselfelds
BeschreibenderName – Groß-/Kleinschreibung wie festgelegt  
 Beispiele:
Vollformat: Verwendung aller
Minimalformat: ohne Metadaten
optionalen Metadaten
_kplt__RechnungsID
_kp_RechnungsID
_kcgt__AusgewaehlteTeilnehmer
_kc_AusgewaehlteTeilnehmer
_kflt__KundenId
_kf__KundenId
_kmgt__AusgewaehlteTageAnsicht
_km__AusgewaehlteTageAnsicht
_kflt__Rechnung_rechnungsposition _kf__Rechnung_rechnungsposition
Namenskonventionen


!


Felder - Fortsetzung 2
MS

‣ 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_ﬁrma (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

Namenskonventionen


!


Layouts
FM

• max. Länge: 100 Zeichen
• Beachtung ODBC, PHP, ... Zugriffe
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

‣
keine Leerzeichen
‣
nicht mit einer Ziffer anfangen
‣
als Sonderzeichen nur _ bzw. __ enthalten
‣
empfohlene Syntax:

<FunktionsPräﬁx>>[__]BeschreibenderName[__]<TabellenauftretenName>

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


!


Layouts - Fortsetzung
MS

‣ 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

Namenskonventionen


!


Eigene Funktionen
FM

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

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...“ 

Namenskonventionen


!


Vielen Dank unseren Sponsoren

Danke für das Bewerten dieses Vortrages
Namenskonventionen


!


FMK 2013 Namenskonventionen, Heike Landschulz

Recommandé

Recommandé

Contenu connexe

En vedette

En vedette (6)

Similaire à FMK 2013 Namenskonventionen, Heike Landschulz

Similaire à FMK 2013 Namenskonventionen, Heike Landschulz (8)

Plus de Verein FM Konferenz

Plus de Verein FM Konferenz (20)

FMK 2013 Namenskonventionen, Heike Landschulz