models/dev_notes.html at main · caltechlibrary/models · GitHub

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
<!DOCTYPE html>
<html lang="en-US">
<head>
    <title>models</title>
    <link rel="stylesheet" href="https://caltechlibrary.github.io/css/site.css">
    <link rel="stylesheet" href="https://media.library.caltech.edu/cl-webcomponents/css/code-blocks.css">
    <script type="module" src="https://media.library.caltech.edu/cl-webcomponents/copyToClipboard.js"></script>
    <script type="module" src="https://media.library.caltech.edu/cl-webcomponents/footer-global.js"></script>
</head>
<body>
<header>
<a href="https://library.caltech.edu"><img src="https://media.library.caltech.edu/assets/caltechlibrary-logo.png" alt="Caltech Library logo"></a>
</header>
<a href="#main-content" class="visually-hidden">skip to main content</a>
<nav>
<ul>
    <li><a href="/">All Library Apps</a></li>
    <li><a href="index.html">Home</a></li>
    <li><a href="LICENSE">LICENSE</a></li>
    <li><a href="INSTALL.html">INSTALL</a></li>
    <li><a href="user_manual.html">User Manual</a></li>
    <li><a href="about.html">About</a></li>
    <!-- <li><a href="search.html">Search</a></li> -->
    <li><a href="https://github.com/caltechlibary/models">Code Repository</a></li>
</ul>
</nav>
<section id="main-content">
<h1 id="development-notes">Development Notes</h1>
<h2 id="naming-things">Naming things</h2>
<dl>
<dt>Check</dt>
<dd>
This refers to “checking” a model to see if it makes sense as a model.
An example would be a model read in as hand coded YAML.
</dd>
<dt>Register</dt>
<dd>
This refers to associating a render method with the model
</dd>
<dt>Render</dt>
<dd>
This takes the model structure, passes it to the registered method to
generate a model representation. An example representation of the model
might be an SQL statement or as an HTML form. It is important to note
that this renders the model as opposed to the data held by the model.
</dd>
</dl>
<h2 id="named-ideas-to-concider-implementation">Named Ideas to concider
implementation</h2>
<dl>
<dt>Define</dt>
<dd>
This refers to associating a type definition available to elements of a
model. An example would be the definition of textarea, text, or date
type making them available to be model. This is the method you’d use to
define specialized types like ORCID, ROR, ISNI, etc.
</dd>
<dt>Validate</dt>
<dd>
This refers to the confirming correctness of the data the model is
holding. This is the only method that will operates on the data the
model is holding. Calling Validate on the model will then loop through
all the elements in the model invoking their Validate method.
</dd>
</dl>
</section>
<footer-global></footer-global>
</body>
</html>