-
Notifications
You must be signed in to change notification settings - Fork 1
/
alps-to-html.html
917 lines (846 loc) · 33 KB
/
alps-to-html.html
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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.4" />
<title>ALPS Mapping Guidelines for HTML</title>
<style type="text/css">
/* Sans-serif font. */
h1, h2, h3, h4, h5, h6,
div.title, caption.title,
thead, p.table.header,
div#toctitle,
span#author, span#revnumber, span#revdate, span#revremark,
div#footer {
font-family: Arial,Helvetica,sans-serif;
}
/* Serif font. */
div.sectionbody {
font-family: Georgia,"Times New Roman",Times,serif;
}
/* Monospace font. */
tt {
font-size: inherit;
}
body {
margin: 1em 5% 1em 5%;
}
a {
color: blue;
text-decoration: underline;
}
a:visited {
color: fuchsia;
}
em {
font-style: italic;
color: navy;
}
strong {
font-weight: bold;
color: #083194;
}
tt {
font-size: inherit;
color: navy;
}
h1, h2, h3, h4, h5, h6 {
color: #527bbd;
margin-top: 1.2em;
margin-bottom: 0.5em;
line-height: 1.3;
}
h1, h2, h3 {
border-bottom: 2px solid silver;
}
h2 {
padding-top: 0.5em;
}
h3 {
float: left;
}
h3 + * {
clear: left;
}
div.sectionbody {
margin-left: 0;
}
hr {
border: 1px solid silver;
}
p {
margin-top: 0.5em;
margin-bottom: 0.5em;
}
ul, ol, li > p {
margin-top: 0;
}
ul > li { color: #aaa; }
ul > li > * { color: black; }
pre {
padding: 0;
margin: 0;
}
span#author {
color: #527bbd;
font-weight: bold;
font-size: 1.1em;
}
span#email {
}
span#revnumber, span#revdate, span#revremark {
}
div#footer {
font-size: small;
border-top: 2px solid silver;
padding-top: 0.5em;
margin-top: 4.0em;
}
div#footer-text {
float: left;
padding-bottom: 0.5em;
}
div#footer-badges {
float: right;
padding-bottom: 0.5em;
}
div#preamble {
margin-top: 1.5em;
margin-bottom: 1.5em;
}
div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
div.admonitionblock {
margin-top: 1.0em;
margin-bottom: 1.5em;
}
div.admonitionblock {
margin-top: 2.0em;
margin-bottom: 2.0em;
margin-right: 10%;
color: #606060;
}
div.content { /* Block element content. */
padding: 0;
}
/* Block element titles. */
div.title, caption.title {
color: #527bbd;
font-weight: bold;
text-align: left;
margin-top: 1.0em;
margin-bottom: 0.5em;
}
div.title + * {
margin-top: 0;
}
td div.title:first-child {
margin-top: 0.0em;
}
div.content div.title:first-child {
margin-top: 0.0em;
}
div.content + div.title {
margin-top: 0.0em;
}
div.sidebarblock > div.content {
background: #ffffee;
border: 1px solid #dddddd;
border-left: 4px solid #f0f0f0;
padding: 0.5em;
}
div.listingblock > div.content {
border: 1px solid #dddddd;
border-left: 5px solid #f0f0f0;
background: #f8f8f8;
padding: 0.5em;
}
div.quoteblock, div.verseblock {
padding-left: 1.0em;
margin-left: 1.0em;
margin-right: 10%;
border-left: 5px solid #f0f0f0;
color: #777777;
}
div.quoteblock > div.attribution {
padding-top: 0.5em;
text-align: right;
}
div.verseblock > pre.content {
font-family: inherit;
font-size: inherit;
}
div.verseblock > div.attribution {
padding-top: 0.75em;
text-align: left;
}
/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
div.verseblock + div.attribution {
text-align: left;
}
div.admonitionblock .icon {
vertical-align: top;
font-size: 1.1em;
font-weight: bold;
text-decoration: underline;
color: #527bbd;
padding-right: 0.5em;
}
div.admonitionblock td.content {
padding-left: 0.5em;
border-left: 3px solid #dddddd;
}
div.exampleblock > div.content {
border-left: 3px solid #dddddd;
padding-left: 0.5em;
}
div.imageblock div.content { padding-left: 0; }
span.image img { border-style: none; }
a.image:visited { color: white; }
dl {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
dt {
margin-top: 0.5em;
margin-bottom: 0;
font-style: normal;
color: navy;
}
dd > *:first-child {
margin-top: 0.1em;
}
ul, ol {
list-style-position: outside;
}
ol.arabic {
list-style-type: decimal;
}
ol.loweralpha {
list-style-type: lower-alpha;
}
ol.upperalpha {
list-style-type: upper-alpha;
}
ol.lowerroman {
list-style-type: lower-roman;
}
ol.upperroman {
list-style-type: upper-roman;
}
div.compact ul, div.compact ol,
div.compact p, div.compact p,
div.compact div, div.compact div {
margin-top: 0.1em;
margin-bottom: 0.1em;
}
div.tableblock > table {
border: 3px solid #527bbd;
}
thead, p.table.header {
font-weight: bold;
color: #527bbd;
}
tfoot {
font-weight: bold;
}
td > div.verse {
white-space: pre;
}
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
div.tableblock > table[frame="hsides"] {
border-left-style: none;
border-right-style: none;
}
div.tableblock > table[frame="vsides"] {
border-top-style: none;
border-bottom-style: none;
}
div.hdlist {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
div.hdlist tr {
padding-bottom: 15px;
}
dt.hdlist1.strong, td.hdlist1.strong {
font-weight: bold;
}
td.hdlist1 {
vertical-align: top;
font-style: normal;
padding-right: 0.8em;
color: navy;
}
td.hdlist2 {
vertical-align: top;
}
div.hdlist.compact tr {
margin: 0;
padding-bottom: 0;
}
.comment {
background: yellow;
}
.footnote, .footnoteref {
font-size: 0.8em;
}
span.footnote, span.footnoteref {
vertical-align: super;
}
#footnotes {
margin: 20px 0 20px 0;
padding: 7px 0 0 0;
}
#footnotes div.footnote {
margin: 0 0 5px 0;
}
#footnotes hr {
border: none;
border-top: 1px solid silver;
height: 1px;
text-align: left;
margin-left: 0;
width: 20%;
min-width: 100px;
}
div.colist td {
padding-right: 0.5em;
padding-bottom: 0.3em;
vertical-align: top;
}
div.colist td img {
margin-top: 0.3em;
}
@media print {
div#footer-badges { display: none; }
}
div#toc {
margin-bottom: 2.5em;
}
div#toctitle {
color: #527bbd;
font-size: 1.1em;
font-weight: bold;
margin-top: 1.0em;
margin-bottom: 0.1em;
}
div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
margin-top: 0;
margin-bottom: 0;
}
div.toclevel2 {
margin-left: 2em;
font-size: 0.9em;
}
div.toclevel3 {
margin-left: 4em;
font-size: 0.9em;
}
div.toclevel4 {
margin-left: 6em;
font-size: 0.9em;
}
span.aqua { color: aqua; }
span.black { color: black; }
span.blue { color: blue; }
span.fuchsia { color: fuchsia; }
span.gray { color: gray; }
span.green { color: green; }
span.lime { color: lime; }
span.maroon { color: maroon; }
span.navy { color: navy; }
span.olive { color: olive; }
span.purple { color: purple; }
span.red { color: red; }
span.silver { color: silver; }
span.teal { color: teal; }
span.white { color: white; }
span.yellow { color: yellow; }
span.aqua-background { background: aqua; }
span.black-background { background: black; }
span.blue-background { background: blue; }
span.fuchsia-background { background: fuchsia; }
span.gray-background { background: gray; }
span.green-background { background: green; }
span.lime-background { background: lime; }
span.maroon-background { background: maroon; }
span.navy-background { background: navy; }
span.olive-background { background: olive; }
span.purple-background { background: purple; }
span.red-background { background: red; }
span.silver-background { background: silver; }
span.teal-background { background: teal; }
span.white-background { background: white; }
span.yellow-background { background: yellow; }
span.big { font-size: 2em; }
span.small { font-size: 0.6em; }
</style>
<script type="text/javascript">
/*<+'])');
// Function that scans the DOM tree for header elements (the DOM2
// nodeIterator API would be a better technique but not supported by all
// browsers).
var iterate = function (el) {
for (var i = el.firstChild; i != null; i = i.nextSibling) {
if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
var mo = re.exec(i.tagName);
if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
}
iterate(i);
}
}
}
iterate(el);
return result;
}
var toc = document.getElementById("toc");
var entries = tocEntries(document.getElementById("content"), toclevels);
for (var i = 0; i < entries.length; ++i) {
var entry = entries[i];
if (entry.element.id == "")
entry.element.id = "_toc_" + i;
var a = document.createElement("a");
a.href = "#" + entry.element.id;
a.appendChild(document.createTextNode(entry.text));
var div = document.createElement("div");
div.appendChild(a);
div.className = "toclevel" + entry.toclevel;
toc.appendChild(div);
}
if (entries.length == 0)
toc.parentNode.removeChild(toc);
},
/////////////////////////////////////////////////////////////////////
// Footnotes generator
/////////////////////////////////////////////////////////////////////
/* Based on footnote generation code from:
* http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
*/
footnotes: function () {
var cont = document.getElementById("content");
var noteholder = document.getElementById("footnotes");
var spans = cont.getElementsByTagName("span");
var refs = {};
var n = 0;
for (i=0; i<spans.length; i++) {
if (spans[i].className == "footnote") {
n++;
// Use [\s\S] in place of . so multi-line matches work.
// Because JavaScript has no s (dotall) regex flag.
note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
noteholder.innerHTML +=
"<div class='footnote' id='_footnote_" + n + "'>" +
"<a href='#_footnoteref_" + n + "' title='Return to text'>" +
n + "</a>. " + note + "</div>";
spans[i].innerHTML =
"[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
"' title='View footnote' class='footnote'>" + n + "</a>]";
var id =spans[i].getAttribute("id");
if (id != null) refs["#"+id] = n;
}
}
if (n == 0)
noteholder.parentNode.removeChild(noteholder);
else {
// Process footnoterefs.
for (i=0; i<spans.length; i++) {
if (spans[i].className == "footnoteref") {
var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
href = href.match(/#.*/)[0]; // Because IE return full URL.
n = refs[href];
spans[i].innerHTML =
"[<a href='#_footnote_" + n +
"' title='View footnote' class='footnote'>" + n + "</a>]";
}
}
}
}
}
/*]]>*/
</script>
</head>
<body class="article">
<div id="header">
<h1>ALPS Mapping Guidelines for HTML</h1>
<span id="author">Mike Amundsen</span><br />
<span id="email"><tt><<a href="mailto:mca@mamund.com">mca@mamund.com</a>></tt></span><br />
<span id="revdate">February 1, 2014</span>
<div id="toc">
<div id="toctitle">Table of Contents</div>
<noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
</div>
</div>
<div id="content">
<div class="sect1">
<h2 id="_summary">Summary</h2>
<div class="sectionbody">
<div class="paragraph"><p>This document provides guidance on mapping ALPS descriptions to HTML representations. It is provided as a guide for those writing servers that will use ALPS profiles to generate HTML and for those writing client applications that will use ALPS profiles to "recognize" ALPS descriptors within the HTML document.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_a_review_of_alps_principles">A Review of ALPS Principles</h2>
<div class="sectionbody">
<div class="paragraph"><p>The Application-Level Profile Semantic(ALPS)<a href="#0">[0]</a> specification is designed to describe the data elements and state transitions that make up a <em>problem domain</em> (e.g. microblogging, accounting, etc.). ALPS documents are designed to be useful to both client and server implementors and can be used at both run-time and design-time to handle the generation and interpretation of response representations. ALPS description documents are referred to as <em>profiles</em> or <em>profile documents</em>.</p></div>
<div class="paragraph"><p>Since the aim is to support a wide set of use cases (clients, servers, run-time, design-time, etc.), ALPS profiles do not describe the runtime <em>behavior</em> of any single system. Instead ALPS profiles describe the problem domain boundaries (e.g. the possible data elements and possible state transitions). It is up to implementors to decide how they wish to use ALPS profliesin order to create an actual instance of a service or client application.</p></div>
<div class="sect2">
<h3 id="_servers_and_clients">Servers and Clients</h3>
<div class="paragraph"><p>For server implementors, ALPS profiles establish the list of possible identifiers for data values (<tt>givenName</tt>, <tt>familyName</tt>, etc.) and transitions (<tt>publish</tt>, <tt>createUser</tt>, etc). ALPS profiles also provide additional description information for state transitions including whether the transition is <em>safe</em> or <em>idempotent</em> and, in some cases, whether there are any possible arguments that can be passed with each transition.</p></div>
<div class="paragraph"><p>For client implementors can use the same ALPS document to as a guide for what to expect from a service which advertises support for an ALPS profile. For example, if a service announces that it uses the ALPS profile for microblogging, then any client application that was built to support the microblogging profile SHOULD be able to recongize all the important data elements and state transitions emitted by that service.</p></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_advertising_alps_profiles_for_html_representations">Advertising ALPS Profiles for HTML Representations</h2>
<div class="sectionbody">
<div class="paragraph"><p>Servers returning HTML responses can advertise the ALPS profiles they support using the following methods:</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
Link Header
</dt>
<dd>
<p>
Responses can include the <tt>Link</tt> header<a href="#2">[2]</a> with the <tt>href</tt> value set to the URL of the ALPS profile document and the <tt>rel</tt> value set to "profile."<br>
<tt>Link: <a href="http://alps.io/profiles/microblogging">http://alps.io/profiles/microblogging</a>; rel="profile"</tt>
</p>
</dd>
<dt class="hdlist1">
HTML4 <tt>profile</tt> attribute
</dt>
<dd>
<p>
HTML4 documents can use the <tt>profile</tt> <a href="#3">[3]</a> attribute on the <tt>HTML.HEAD</tt> element. the <tt>profile</tt> attribute value SHOULD be set to the URL of the ALPS profile document.<br>
<tt><head profile="http://alps.io/profiles/microblogging">…</head></tt>
</p>
</dd>
<dt class="hdlist1">
HTML5 <tt>link</tt> element
</dt>
<dd>
<p>
HTML5 documents can use the <tt>Link</tt> element<a href="#4">[4]</a> with the <tt>href</tt> value set to the URL of the ALPS profile document and the <tt>rel</tt> value set to "profile."<br>
<tt><link href="http://alps.io/profiles/microblogging" rel="profile" /></tt>
</p>
</dd>
</dl></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">
<div class="paragraph"><p>It is valid for a service to advertise support for more than one ALPS profile for the same response. For example, a single response from a server might include the following <tt>LINK</tt> header:</p></div>
<div class="listingblock">
<div class="content">
<pre><tt>LINK: <http://alps.io/profiles/finance>;rel="profile", <http://alps.io/profiles/accounting>;rel="profile"</tt></pre>
</div></div>
<div class="paragraph"><p>In the above case, The client application has been informed that the response MAY contain data elements and state transitions from both the <em>finance</em> and the <em>accounting</em> ALPS profiles.</p></div>
</td>
</tr></table>
</div>
<div class="paragraph"><p>Clients accepting HTML responses SHOULD look for the ALPS profile in each of these places as appropriate to the response. If an ALPS profile reference appears in more than one location (e.g. <tt>LINK</tt> header, <tt>HTML.HEAD@profile</tt> attribute, and/or <tt>HTML.LINK</tt> element) <strong>all</strong> profiles SHOULD be considered valid.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_basic_mapping_rules_for_alps_to_html">Basic Mapping Rules for ALPS to HTML</h2>
<div class="sectionbody">
<div class="paragraph"><p>The following are the basic rules for rendering ALPS profile information into valid HTML representations.</p></div>
<div class="sect2">
<h3 id="_the_alps_tt_descriptor_id_tt_property">The ALPS <tt>descriptor.id</tt> property</h3>
<div class="paragraph"><p>The <tt>ALPS.descriptor.id</tt> SHOULD be transformed into an HTML <tt>class</tt> property. Below are several valid examples:</p></div>
<div class="listingblock">
<div class="title">Applying <tt>descriptor.id</tt> to HTML elements</div>
<div class="content">
<pre><tt><!-- ALPS document -->
<descriptor id="abc" ... />
<!-- HTML read-only elements -->
<div class="abc">...</div>
<span class="abc">...</div>
<li class="abc">...</li>
<p class="abc">...</p>
<!-- HTML state transition elements -->
<input type="text" class="abc" />
<a href="..." class="abc" />
<img src="..." class="abc" /></tt></pre>
</div></div>
<div class="paragraph"><p>The exception to this rule is when the ALPS <tt>descriptor.name</tt> property is present. In that case the <tt>class</tt> property of the HTML element should be set to the value of the <tt>descriptor.name</tt> property in the ALPS document. The ALPS <tt>descriptor.id</tt> SHOULD also be included in the HTML representation using an HTML5 Custom Data Attribute<a href="#1">[1]</a> <tt>data-alpsid</tt>. Below are several valid examples:</p></div>
<div class="listingblock">
<div class="title">Applying <tt>descriptor.name</tt> to HTML elements</div>
<div class="content">
<pre><tt><!-- ALPS document -->
<descriptor id="abc" name="xyz" ... />
<descriptor id="abc2" name="xyz" ... />
<!-- HTML read-only elements -->
<div class="xyz" data-alpsid="abc">...</div>
<span class="xyz" data-alpsid="abc2">...</div>
</div>
<!-- HTML state transition elements -->
<input type="text" class="xyz" data-alpsid="abc2"/>
<a href="..." class="xyz" data-alpsid="abc"/></tt></pre>
</div></div>
</div>
<div class="sect2">
<h3 id="_the_alps_tt_descriptor_type_tt_property">The ALPS <tt>descriptor.type</tt> property</h3>
<div class="paragraph"><p>The <tt>descriptor.type</tt> value is used to determine whether the HTML element should be rendered as a ‘value` element (e.g. <tt>span</tt>, <tt>input</tt>, etc.) or a `transition’ element (e.g. <tt>form</tt>, <tt>a</tt>. <tt>img</tt>, etc.). Below is a table showing the various possibilities:</p></div>
<div class="tableblock">
<table rules="rows"
width="100%"
frame="border"
cellspacing="0" cellpadding="4">
<col width="50%" />
<col width="50%" />
<thead>
<tr>
<th align="left" valign="top"><tt>descriptor.type</tt> Value</th>
<th align="left" valign="top">HTML Element</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left" valign="top"><p class="table">safe</p></td>
<td align="left" valign="top"><p class="table">HTML.A|IMG|IFRAME|FORM@mmethod="get"</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">unsafe</p></td>
<td align="left" valign="top"><p class="table">HTML.FORM@method="post"</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">idempotent</p></td>
<td align="left" valign="top"><p class="table">HTML.FORM@method="post"<sup>1</sup></p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">semantic</p></td>
<td align="left" valign="top"><p class="table">HTML.SPAN|DIV|P|INPUT|LI|DT|DD|SECTION|…|FORM@method="get"<sup>2</sup></p></td>
</tr>
</tbody>
</table>
</div>
<div class="olist arabic"><ol class="arabic">
<li>
<p>
Since HTML does not support idempontent transitions, the HTML.FORM element with the <tt>method="post"</tt> property SHOULD be used. Server implementors are encouraged to use an additional information in the transition in order to ensure idempotency of the request. Some examples are 1) adding a unique value to the URL in the <tt>action</tt> property, 2) using an additional <tt>INPUT</tt> element that holds a unique value used to enforce idempotency, etc.
</p>
</li>
<li>
<p>
In some cases, servers MAY use a "safe" transition to express a <tt>descriptor.type="semantic"</tt> element. For example, a server might represent a <tt>computedResult</tt> as an <tt>HTML.SPAN</tt> element,. However, if the result is not yet computed, the server may represent <tt>computedResult</tt> as an <tt>HTML.FORM@method="get"</tt> with one or more <tt>HTML.INPUT</tt> elements allowing the client application to fill in values in order to generate the value <tt>computedResult</tt>.
</p>
</li>
</ol></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_mapping_examples">Mapping Examples</h2>
<div class="sectionbody">
<div class="paragraph"><p>Below are some examples to use as guides when mapping between ALPS and HTML.</p></div>
<div class="sect2">
<h3 id="_search_example">Search Example</h3>
<div class="paragraph"><p>This is a very simple ALPS profile that defines a single semantic descriptor ("text") and a single safe descriptor ("search"). This profile describes the essence of the front end of any simple web-based search engine. Mapping this ALPS profile to an HTML4 document is rather straight-forward.</p></div>
<div class="listingblock">
<div class="content">
<pre><tt><!-- ALPS Profile -->
<alps>
<link rel="self" href="http://alps.io/profiles/search" /> <b><1></b>
<descriptor id="text" type="semantic"> <b><2></b>
<descriptor id="search" type="safe"> <b><3></b>
</alps>
<!-- HTML4 Representation -->
<html>
<head profile="http://alps.io/profiles/search"> <b><1></b>
</head>
<body>
<form action="..." method="get">
<input type="text" name="q" class="text" value="" /> <b><2></b>
<input type="submit" class="search" /> <b><3></b>
</form>
</body>
</html></tt></pre>
</div></div>
</div>
<div class="sect2">
<h3 id="_user_account_example">User Account Example</h3>
<div class="paragraph"><p>This example shows an ALPS profile that describes both reading and writing operations on a user account. It is also structured as a ‘flat’ ALPS document. The data elements (<2>) are listed separately from the transition elements (<3>). The profile does not constrain any server implementations to specific parameters for transitions; each server can select the data elements that best fit that server’s use cases.</p></div>
<div class="listingblock">
<div class="title">ALPS User Account Profile</div>
<div class="content">
<pre><tt><alps>
<link rel="self" href="http://alps.io/profiles/useraccount" /> <b><1></b>
<!-- data elements --> <b><2></b>
<descriptor id="user" type="semantic" />
<descriptor id="accessCode" type="semantic" />
<descriptor id="givenName" type="semantic" />
<descriptor id="familyName" type="semantic" />
<descriptor id="email" type="semantic" />
<descriptor id="telephone" type="semantic" />
<!-- transitions --> <b><3></b>
<descriptor id="list" type="safe" /> <b><4></b>
<descriptor id="detail" type="safe" /> <b><5></b>
<descriptor id="login-link" type="safe" name="login" /> <b><6></b>
<descriptor id="login-form" type="unsafe" name="login" /> <b><7></b>
<descriptor id="create-link" type="safe" name="create"/> <b><7></b>
<descriptor id="create-form" type="unsafe" "name="create/> <b><8></b>
<descriptor id="update-link" type="safe" name="update"/> <b><9></b>
<descriptor id="update-form" type="idempotent" name="update" /> <b><10></b>
<descriptor id="remove-link" type="safe" name="remove" /> <b><11></b>
<descriptor id="remove-form" type="idempotent" name="remove" /> <b><12></b>
</alps></tt></pre>
</div></div>
<div class="listingblock">
<div class="title">HTML5 Representation of a list of users (with link to login and creating new accounts)</div>
<div class="content">
<pre><tt><html>
<head>
<title>User List</title>
<link rel="profile" href="http://alps.io/profiles/useraccount" /> <b><1></b>
</head>
<body>
<h1>User List</h1>
<h2>Menu</h2>
<ul>
<li><a href="..." rel="collection" class="list">Refresh List</a></li> <b><4></b>
<li><a href="..." rel="http://example.org/rels/login" class="login" data-alspid="login-link">Login</a></li> <b><6></b>
<li><a href="..." rel="create-form" class="create" data-alpsid="create-link">Create Account</a></li> <b><7></b>
</ul>
<h2>Currrent Users</h2>
<ul>
<li><a href="..." rel="item" class="detail">Mary</a></li> <b><5></b>
<li><a href="..." rel="item" class="detail">Mark</a></li> <b><5></b>
<li><a href="..." rel="item" class="detail">Mandy</a></li> <b><5></b>
<li><a href="..." rel="item" class="detail">Manfred</a></li> <b><5></b>
<li><a href="..." rel="item" class="detail">Michelle</a></li> <b><5></b>
<li><a href="..." rel="item" class="detail">Michael</a></li> <b><5></b>
</ul>
</body>
</html></tt></pre>
</div></div>
<div class="paragraph"><p>In the above HTML5 example, the Menu section shows the use of the <tt>login-link</tt> and <tt>create-link</tt> ALPS decriptors applied to <tt>HTML.A</tt> elements that use the associated <tt>descriptor.name</tt> value for the HTML <tt>class</tt> value. Both these HTML anchors have the RECOMMENDED HTML5 Custom Data Attribute of <tt>data-alpsid</tt>.</p></div>
<div class="paragraph"><p>The following HTML5 representation is an example of what might be returned when a client application activates the <tt>login-link</tt>:</p></div>
<div class="listingblock">
<div class="title">HTML5 Representation for creating a new user account.</div>
<div class="content">
<pre><tt><html>
<head>
<title>Create Account</title>
<link rel="profile" href="http://alps.io/profiles/useraccount" /> <b><1></b>
</head>
<body>
<h1>Create Account</h1>
<form action="..." method="post">
<label>User Name:<input name="user" class="user" /></label>
<label>First Name:<input name="firstname" class="givenName" /></label>
<label>Last Name:<input name="lastname" class="familyName" /></label>
<label>Email:<input name="email" class="email" /></label>
<label>SMS:<input name="sms" class="telephone" /></label>
<input type="submit" value="Save" class="create" data-alpsid="create-form" /> <b><8></b>
</form>
</body>
</html></tt></pre>
</div></div>
<div class="paragraph"><p>What follows is an HTML response that might be returned when activating a <tt>detail</tt> link:</p></div>
<div class="listingblock">
<div class="title">HTML5 Representation for updating an existing user account.</div>
<div class="content">
<pre><tt><html>
<head>
<title>Update Account</title>
<link rel="profile" href="http://alps.io/profiles/useraccount" /> <b><1></b>
</head>
<body>
<h1>Update Account</h1>
<form action="..." method="post">
<input type="hidden" name="etag" value="q1w2e3r4t5y6" /> <b><13></b>
<label>User Name:<span class="user">mamund</span></label>
<label>First Name:<input name="firstname" class="givenName" /></label>
<label>Last Name:<input name="lastname" class="familyName" /></label>
<label>Email:<input name="email" class="email" /></label>
<label>SMS:<input name="sms" class="telephone" /></label>
<input type="submit" value="Save" class="update" data-alspid="update-form"/> <b><10></b>
</form>
</body>
</html></tt></pre>
</div></div>
<div class="paragraph"><p>Note that the <tt><input type="hidden" name="etag" … /></tt> (<13>) was added in the response (by the server) in order to ensure the <tt>HTML.FORM@method="post"</tt> transition can support idempotency as described in the ALPS profile (<10>). This is just one way for servers to ensure idempotency for HTML transitions. The implementation details are left to each service.</p></div>
<div class="paragraph"><p>The same approach is used to support an idempotent "remove" operation in this next HTML representation:</p></div>
<div class="listingblock">
<div class="title">HTML5 Representation for removing an existing user account.</div>
<div class="content">
<pre><tt><html>
<head profile="http://alps.io/profiles/useraccount"> <b><1></b>
<title>Remove Account</title>
</head>
<body>
<h1>Remove Account</h1>
<form action="..." method="post">
<input type="hidden" name="etag" value="q1w2e3r4t5y6" /> <b><13></b>
<input type="submit" value="Remove" class="remove" data-alpsid="remove-form" /> <b><12></b>
</form>
</body>
</html></tt></pre>
</div></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_references">References</h2>
<div class="sectionbody">
<div class="paragraph"><p><a id="0"></a> 0. <a href="http://alps.io/spec">http://alps.io/spec</a></p></div>
<div class="paragraph"><p><a id="1"></a> 1. <a href="http://www.w3.org/TR/2011/WD-html5-20110525/elements.html#attr-data">http://www.w3.org/TR/2011/WD-html5-20110525/elements.html#attr-data</a></p></div>
<div class="paragraph"><p><a id="2"></a> 2. <a href="http://tools.ietf.org/search/rfc5988#section-5">http://tools.ietf.org/search/rfc5988#section-5</a></p></div>
<div class="paragraph"><p><a id="3"></a> 3. <a href="http://www.w3.org/TR/html4/struct/global.html#adef-profile">http://www.w3.org/TR/html4/struct/global.html#adef-profile</a></p></div>
<div class="paragraph"><p><a id="4"></a> 4. <a href="http://www.w3.org/html/wg/drafts/html/CR/document-metadata.html#the-link-element">http://www.w3.org/html/wg/drafts/html/CR/document-metadata.html#the-link-element</a></p></div>
</div>
</div>
</div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated 2014-01-28 18:36:18 EST
</div>
</div>
</body>
</html>