-
Notifications
You must be signed in to change notification settings - Fork 16
/
chap-sitemap.lyx
3728 lines (2636 loc) · 64.4 KB
/
chap-sitemap.lyx
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
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#LyX 1.6.5 created this file. For more info see http://www.lyx.org/
\lyxformat 345
\begin_document
\begin_header
\textclass book
\use_default_options false
\language english
\inputencoding auto
\font_roman default
\font_sans default
\font_typewriter default
\font_default_family default
\font_sc false
\font_osf false
\font_sf_scale 100
\font_tt_scale 100
\graphics default
\paperfontsize default
\spacing single
\use_hyperref false
\papersize default
\use_geometry false
\use_amsmath 1
\use_esint 1
\cite_engine basic
\use_bibtopic false
\paperorientation portrait
\secnumdepth 3
\tocdepth 3
\paragraph_separation indent
\defskip medskip
\quotes_language english
\papercolumns 1
\papersides 1
\paperpagestyle default
\tracking_changes false
\output_changes false
\author ""
\author ""
\end_header
\begin_body
\begin_layout Chapter
SiteMap
\begin_inset CommandInset label
LatexCommand label
name "cha:SiteMap"
\end_inset
\end_layout
\begin_layout Standard
SiteMap is a very powerful part of Lift that does essentially what it says:
provides a map (menu) for your site.
Of course, if all it did was generate a set of links on your page, we wouldn't
have a whole chapter dedicated to it.
SiteMap not only handles the basic menu generation functionality, but also
provides:
\end_layout
\begin_layout Itemize
Access control mechanisms that deal not only with whether a menu item is
visible, but also whether the page it points to is accessible
\end_layout
\begin_layout Itemize
Grouping of menu items so that you can easily display portions of menus
where you want them
\end_layout
\begin_layout Itemize
Nested menus so you can have hierarchies
\end_layout
\begin_layout Itemize
Request rewriting (similar to Section
\begin_inset CommandInset ref
LatexCommand ref
reference "sec:URL-Rewriting"
\end_inset
)
\end_layout
\begin_layout Itemize
State-dependent computations for such things as page titles, page-specific
snippets, etc.
\end_layout
\begin_layout Standard
The beauty of SiteMap is that it's very easy to start out with the basic
functionality and then expand on it as you grow.
\end_layout
\begin_layout Section
Basic SiteMap Definition
\begin_inset CommandInset label
LatexCommand label
name "sec:Basic-SiteMap-Definition"
\end_inset
\end_layout
\begin_layout Standard
Let's start with our basic menu for PocketChange
\begin_inset Note Note
status open
\begin_layout Plain Layout
Revise this as needed to match reality, and verify all code in this chapter
\end_layout
\end_inset
.
To keep things simple, we'll just define four menu items to begin:
\end_layout
\begin_layout Enumerate
A home page that displays the user's entries when the user is logged in,
or a welcome page when the user is not
\end_layout
\begin_layout Enumerate
A logout link when the user is logged in, log in and registration links
and pages when the user is not
\end_layout
\begin_layout Enumerate
Pages to view or edit the user's profile, available only when the user is
logged in
\end_layout
\begin_layout Enumerate
A help page, available whether the user is logged in or not
\end_layout
\begin_layout Standard
We'll assume that we have the corresponding pages, "
\family typewriter
homepage
\family default
", "
\family typewriter
login
\family default
", "
\family typewriter
logout
\family default
", and "
\family typewriter
profile
\family default
," written and functional.
We'll also assume that the help page(s) reside under the "
\family typewriter
help
\family default
" subdirectory to keep things neat, and that the entry to help is
\family typewriter
/help/index
\family default
.
\end_layout
\begin_layout Subsection
The Link Class
\begin_inset CommandInset label
LatexCommand label
name "sub:The-Link-Class"
\end_inset
\end_layout
\begin_layout Standard
The Link class
\begin_inset Foot
status open
\begin_layout Plain Layout
\family typewriter
net.liftweb.sitemap.Loc.Link
\end_layout
\end_inset
is a fundamental part of Menu definitions.
The
\family typewriter
Link
\family default
class contains two parameters: a
\family typewriter
List[String]
\family default
of path components, and a boolean value that controls whether prefix matching
is enabled.
The path components represent the portion of the URI following your web
context, split on the "/" character.
Listing
\begin_inset CommandInset ref
LatexCommand ref
reference "lst:Link-Path-Components"
\end_inset
shows how you would use Link to represent the "/utils/index" page.
Of course, instead of
\family typewriter
\begin_inset Quotes eld
\end_inset
utils
\begin_inset Quotes erd
\end_inset
::
\begin_inset Quotes eld
\end_inset
index
\begin_inset Quotes erd
\end_inset
:: Nil
\family default
, you could as easily use
\family typewriter
List(
\begin_inset Quotes eld
\end_inset
utils
\begin_inset Quotes erd
\end_inset
,
\begin_inset Quotes eld
\end_inset
index
\begin_inset Quotes erd
\end_inset
)
\family default
if you prefer.
\end_layout
\begin_layout Standard
\begin_inset listings
inline false
status open
\begin_layout Plain Layout
\begin_inset Caption
\begin_layout Plain Layout
Link Path Components
\begin_inset CommandInset label
LatexCommand label
name "lst:Link-Path-Components"
\end_inset
\end_layout
\end_inset
\end_layout
\begin_layout Plain Layout
val myUtilsIndex = new Link("utils" :: "index" :: Nil, false)
\end_layout
\end_inset
\end_layout
\begin_layout Standard
Prefix matching allows the path components you specify to match any longer
paths as well.
Following our first example, if you wanted to match anything under the
utils directory (say, for access control), you would set the second parameter
to
\family typewriter
true
\family default
, as shown in Listing
\begin_inset CommandInset ref
LatexCommand ref
reference "lst:Link-Prefix-Matching"
\end_inset
.
\end_layout
\begin_layout Standard
\begin_inset listings
inline false
status open
\begin_layout Plain Layout
\begin_inset Caption
\begin_layout Plain Layout
Link Prefix Matching
\begin_inset CommandInset label
LatexCommand label
name "lst:Link-Prefix-Matching"
\end_inset
\end_layout
\end_inset
\end_layout
\begin_layout Plain Layout
val allUtilPages = new Link("utils" :: Nil, true)
\end_layout
\end_inset
\end_layout
\begin_layout Standard
\begin_inset Note Note
status open
\begin_layout Plain Layout
Clarify trailing slashes and index file behavior (update: David P.
is working on making this simpler)
\end_layout
\end_inset
\end_layout
\begin_layout Subsection
ExtLink
\end_layout
\begin_layout Standard
The ExtLink object can be used to create a Link instance using your own
full link URL.
As its name implies, it would usually be used for an external location.
Listing
\begin_inset CommandInset ref
LatexCommand ref
reference "lst:Using-ExtLink"
\end_inset
shows a menu item that points to a popular website.
\end_layout
\begin_layout Standard
\begin_inset listings
inline false
status open
\begin_layout Plain Layout
\begin_inset Caption
\begin_layout Plain Layout
Using ExtLink
\begin_inset CommandInset label
LatexCommand label
name "lst:Using-ExtLink"
\end_inset
\end_layout
\end_inset
\end_layout
\begin_layout Plain Layout
val goodReference = Menu(Loc("reference",
\end_layout
\begin_layout Plain Layout
ExtLink("http://www.liftweb.net/"),
\end_layout
\begin_layout Plain Layout
"LiftWeb"))
\end_layout
\end_inset
\end_layout
\begin_layout Subsection
Creating Menu Entries
\end_layout
\begin_layout Standard
Menu entries are created using the Menu
\begin_inset Foot
status open
\begin_layout Plain Layout
\family typewriter
net.liftweb.sitemap.Menu
\end_layout
\end_inset
class, and its corresponding Menu object.
A Menu, in turn, holds a Loc
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
\family typewriter
net.liftweb.sitemap.Loc
\end_layout
\end_inset
trait instance, which is where most of the interesting things happen.
A menu can also hold one or more child menus, which we'll cover in Section
\begin_inset CommandInset ref
LatexCommand ref
reference "sub:Nested-Menus"
\end_inset
.
Note that the Loc object has several implicit methods that make defining
Locs easier, so you generally want to import them into scope
\begin_inset Note Note
status open
\begin_layout Plain Layout
How to best emphasize this (and other notes)?
\end_layout
\end_inset
.
The simplest way is to import
\family typewriter
net.liftweb.sitemap.Loc._
\family default
, but you can import specific methods by name if you prefer.
A Loc can essentially be thought of as a link in the menu, and contains
four basic items:
\end_layout
\begin_layout Enumerate
The name of the Loc: this must be unique across your sitemap because it
can be used to look up specific Menu items if you customize your menu display
(Section
\begin_inset CommandInset ref
LatexCommand ref
reference "sub:Using-lift-Menu"
\end_inset
)
\end_layout
\begin_layout Enumerate
The link to which the Loc refers: usually this will referernce a specific
page, but Lift allows a single Loc to match based on prefix as well (Section
\begin_inset CommandInset ref
LatexCommand ref
reference "sub:The-Link-Class"
\end_inset
)
\end_layout
\begin_layout Enumerate
The text of the menu item, which will be displayed to the user: you can
use a static string or you can generate it with a function (Section
\begin_inset CommandInset ref
LatexCommand ref
reference "sub:menu-LinkText"
\end_inset
)
\end_layout
\begin_layout Enumerate
An optional set of LocParam parameters that control the behavior and appearance
of the menu item (see Sections
\begin_inset CommandInset ref
LatexCommand ref
reference "sec:Customizing-Display"
\end_inset
,
\begin_inset CommandInset ref
LatexCommand ref
reference "sec:SiteMap-Access-Control"
\end_inset
,
\begin_inset CommandInset ref
LatexCommand ref
reference "sec:Misc-Menu"
\end_inset
, and
\begin_inset CommandInset ref
LatexCommand ref
reference "sec:Page-Specific-Rendering"
\end_inset
)
\end_layout
\begin_layout Standard
For our example, we'll tackle the help page link first, because it's the
simplest (essentially, it's a static link).
The definition is shown in Listing
\begin_inset CommandInset ref
LatexCommand ref
reference "lst:Help-Menu-Definition"
\end_inset
.
We're assuming that you've imported the Loc implicit methods to keep things
simple.
We'll cover instantiating the classes directly in later sections of this
chapter.
\end_layout
\begin_layout Standard
\begin_inset listings
inline false
status open
\begin_layout Plain Layout
\begin_inset Caption
\begin_layout Plain Layout
Help Menu Definition
\begin_inset CommandInset label
LatexCommand label
name "lst:Help-Menu-Definition"
\end_inset
\end_layout
\end_inset
\end_layout
\begin_layout Plain Layout
val helpMenu = Menu(Loc("helpHome",
\end_layout
\begin_layout Plain Layout
("help" :: "" :: Nil) -> true,
\end_layout
\begin_layout Plain Layout
"Help"))
\end_layout
\end_inset
\end_layout
\begin_layout Standard
Here we've named the menu item "helpHome." We can use this name to refer
back to this menu item elsewhere in our code.
The second parameter is a
\family typewriter
Pair[List[String],Boolean]
\family default
which converts directly to a Link class with the given parameters (see
Section
\begin_inset CommandInset ref
LatexCommand ref
reference "sub:The-Link-Class"
\end_inset
above).
In this instance, by passing in true, we're saying that anything under
the help directory will also match.
If you just use a List[String], the implicit conversion is to a Link with
prefix matching disabled.
Note that SiteMap won't allow access to any pages that don't match any
Menu entries
\begin_inset Note Note
status open
\begin_layout Plain Layout
emphasize
\end_layout
\end_inset
, so by doing this we're allowing full access to all of the help files without
having to specify a menu entry for each.
The final parameter, "Help," is the text for the menu link, should we choose
to generate a menu link from this SiteMap entry.
\end_layout
\begin_layout Subsection
Nested Menus
\begin_inset CommandInset label
LatexCommand label
name "sub:Nested-Menus"
\end_inset
\end_layout
\begin_layout Standard
The Menu class supports child menus by passing them in as final constructor
parameters.
For instance, if we wanted to have an "about" menu under Help, we could
define the menu as shown in Listing
\begin_inset CommandInset ref
LatexCommand ref
reference "lst:Nested-Menu-Definition"
\end_inset
.
\end_layout
\begin_layout Standard
\begin_inset listings
inline false
status open
\begin_layout Plain Layout
\begin_inset Caption
\begin_layout Plain Layout
Nested Menu Definition
\begin_inset CommandInset label
LatexCommand label
name "lst:Nested-Menu-Definition"
\end_inset
\end_layout
\end_inset
\end_layout
\begin_layout Plain Layout
val aboutMenu = Menu(Loc("about", "help" :: "about" :: Nil, "About"))
\end_layout
\begin_layout Plain Layout
val helpMenu = Menu(Loc(...as defined above...), aboutMenu)
\end_layout
\end_inset
\end_layout
\begin_layout Standard
When the menu is rendered it will have a child menu for About.
Child menus are only rendered by default when the current page matches
their parent's Loc.
That means that, for instance the following links would show in an "About"
child menu item:
\end_layout
\begin_layout Itemize
\family typewriter
/help/index
\end_layout
\begin_layout Itemize
\family typewriter
/help/usage
\end_layout
\begin_layout Standard
But the following would not:
\end_layout
\begin_layout Itemize
\family typewriter
/index
\end_layout
\begin_layout Itemize
\family typewriter
/site/example
\end_layout
\begin_layout Standard
We'll cover how you can customize the rendering of the menus in Section
\begin_inset CommandInset ref
LatexCommand ref
reference "sub:Using-lift-Menu"
\end_inset
.
\end_layout
\begin_layout Subsection
Setting the Global SiteMap
\end_layout
\begin_layout Standard
Once you have all of your menu items defined, you need to set them as your
SiteMap.
As usual, we do this in the Boot class by calling the
\family typewriter
setSiteMap
\family default
method on LiftRules, as shown in Listing
\begin_inset CommandInset ref
LatexCommand ref
reference "lst:Setting-the-SiteMap"
\end_inset
.
The
\family typewriter
setSiteMap
\family default
method takes a SiteMap object that can be constructed using your menu items
as arguments.
\end_layout
\begin_layout Standard
\begin_inset listings
inline false
status open
\begin_layout Plain Layout
\begin_inset Caption
\begin_layout Plain Layout
Setting the SiteMap
\begin_inset CommandInset label
LatexCommand label
name "lst:Setting-the-SiteMap"
\end_inset
\end_layout
\end_inset
\end_layout
\begin_layout Plain Layout
LiftRules.setSiteMap(SiteMap(homeMenu, profileMenu, ...))
\end_layout
\end_inset
\end_layout
\begin_layout Standard
When you're dealing with large menus, and in particular when your model
objects create their own menus (see MegaProtoUser, Section
\begin_inset CommandInset ref
LatexCommand ref
reference "sub:ProtoUser-and-MegaProtoUser"
\end_inset
\begin_inset Note Note
status open
\begin_layout Plain Layout
Should this be added to Mapper, or somehow folded in elsewhere?
\end_layout
\end_inset
), then it can be more convenient to define List[Menu] and set that.
Listing
\begin_inset CommandInset ref
LatexCommand ref
reference "lst:Using-List-Menu-for"
\end_inset
shows this usage.
\end_layout
\begin_layout Standard
\begin_inset listings
inline false
status open
\begin_layout Plain Layout
\begin_inset Caption
\begin_layout Plain Layout
Using List[Menu] for SiteMap
\begin_inset CommandInset label
LatexCommand label
name "lst:Using-List-Menu-for"
\end_inset
\end_layout
\end_inset
\end_layout
\begin_layout Plain Layout
val menus = Menu(Loc("HomePage", "", "Home"),...) ::
\end_layout
\begin_layout Plain Layout
...
\end_layout
\begin_layout Plain Layout
Menu(...) :: Nil
\end_layout
\begin_layout Plain Layout
LiftRules.setSiteMap(SiteMap(menus : _*))
\end_layout
\end_inset
\end_layout
\begin_layout Standard
The key to using List for your menus is to explicitly define the type of
the parameter as "_*" so that it's treated as a set of varargs instead
of a single argument of type List[Menu].
\end_layout
\begin_layout Section
Customizing Display
\begin_inset CommandInset label
LatexCommand label
name "sec:Customizing-Display"
\end_inset
\end_layout
\begin_layout Standard
There are many cases where you may want to change the way that particular
menu items are displayed.
For instance, if you're using a Menu item for access control on a subdirectory,
you may not want the menu item displayed at all.
We'll discuss how you can control appearance, text, etc.
in this section.
\end_layout
\begin_layout Subsection
Hidden
\begin_inset CommandInset label
LatexCommand label
name "sub:menu-Hidden"
\end_inset
\end_layout
\begin_layout Standard
The Hidden LocParam does exactly what it says: hides the menu item from
the menu display.
All other menu features still work.
There is a variety of reasons why you might not want a link displayed.
A common use, shown in Listing
\begin_inset CommandInset ref
LatexCommand ref
reference "lst:Hidden-Menus"
\end_inset
, is where the point of the item is to restrict access to a particular subdirect
ory based on some condition.
(We'll cover the
\family typewriter
If
\family default
tag in Section
\begin_inset CommandInset ref
LatexCommand ref
reference "sub:menu-If"
\end_inset
.)
\end_layout
\begin_layout Standard
\begin_inset listings
inline false
status open
\begin_layout Plain Layout
\begin_inset Caption
\begin_layout Plain Layout
Hidden Menus
\begin_inset CommandInset label
LatexCommand label
name "lst:Hidden-Menus"
\end_inset
\end_layout
\end_inset