-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathch5tut21.lyx
4265 lines (3003 loc) · 62.1 KB
/
ch5tut21.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 2.0 created this file. For more info see http://www.lyx.org/
\lyxformat 413
\begin_document
\begin_header
\textclass hobo
\use_default_options true
\begin_modules
logicalmkup
\end_modules
\maintain_unincluded_children false
\language english
\language_package default
\inputencoding auto
\fontencoding global
\font_roman default
\font_sans default
\font_typewriter default
\font_default_family default
\use_non_tex_fonts false
\font_sc false
\font_osf false
\font_sf_scale 100
\font_tt_scale 100
\graphics default
\default_output_format default
\output_sync 0
\bibtex_command default
\index_command default
\float_placement H
\paperfontsize default
\spacing single
\use_hyperref true
\pdf_bookmarks true
\pdf_bookmarksnumbered false
\pdf_bookmarksopen false
\pdf_bookmarksopenlevel 1
\pdf_breaklinks false
\pdf_pdfborder false
\pdf_colorlinks true
\pdf_backref false
\pdf_pdfusetitle true
\papersize default
\use_geometry false
\use_amsmath 0
\use_esint 0
\use_mhchem 1
\use_mathdots 1
\cite_engine basic
\use_bibtopic false
\use_indices false
\paperorientation portrait
\suppress_date true
\use_refstyle 0
\boxbgcolor #e0e0e8
\index Index
\shortcut idx
\color #008000
\end_index
\secnumdepth -1
\tocdepth 2
\paragraph_separation skip
\defskip medskip
\quotes_language english
\papercolumns 1
\papersides 2
\paperpagestyle default
\tracking_changes false
\output_changes false
\html_math_output 0
\html_css_as_file 0
\html_be_strict false
\end_header
\begin_body
\begin_layout Section
Tutorial 21
\begin_inset Newline newline
\end_inset
Replicating the Look and Feel of a Site
\end_layout
\begin_layout Standard
\begin_inset Flex Emph
status collapsed
\begin_layout Plain Layout
By Tom Locke
\end_layout
\end_inset
\end_layout
\begin_layout Subsubsection*
Introduction
\end_layout
\begin_layout Standard
Let's say we want a new Hobo app to have the same look-and-feel of an existing
site.
The really big win is if we can have the same look and feel happen app
almost ‘automatically’.
We want to be able to develop at “Hobo
\begin_inset Quotes erd
\end_inset
speed, and have the look-and-feel “just happen”.
This is not easy to set-up, but once set-up, the payback in terms of developmen
t agility is more than worth it.
\end_layout
\begin_layout Standard
We’ll invoke the standard web design used throughout all agencies within
the U.S.
Department of Agriculture.
The authors have done substantial work with NIFA, The Cooperative State
Research, Education, and Extension Service, so we will use their website
(
\begin_inset CommandInset href
LatexCommand href
target "www.nifa.usda.gov"
\end_inset
) as an example:
\end_layout
\begin_layout Standard
\begin_inset Float figure
wide false
sideways false
status open
\begin_layout Plain Layout
\begin_inset Graphics
filename figures/ch5/nifa.usda.gov_page.png
width 100col%
\end_inset
\end_layout
\begin_layout Plain Layout
\begin_inset Caption
\begin_layout Plain Layout
Screen shot of the nifa.usda.gov home page
\end_layout
\end_inset
\end_layout
\begin_layout Plain Layout
\end_layout
\end_inset
\end_layout
\begin_layout Standard
Note that, for now, this recipe will document how to create a
\begin_inset Flex Emph
status collapsed
\begin_layout Plain Layout
close approximation
\end_layout
\end_inset
to the above theme.
We’re going to skip some of the details that cannot be implemented without
resorting to images to keep the recipe from getting too complex and lengthy.
\end_layout
\begin_layout Standard
This will be as much a guide to general web-development best practices as
it will be a lesson in Hobo and DRYML
\begin_inset Index idx
status collapsed
\begin_layout Plain Layout
DRYML
\end_layout
\end_inset
.
The mantra when working with themes
\begin_inset Index idx
status collapsed
\begin_layout Plain Layout
Hobo themes
\end_layout
\end_inset
in Hobo is already familiar to skilled web developers:
\end_layout
\begin_layout Subsubsection*
Separate content from presentation
\end_layout
\begin_layout Standard
The vast majority of common mistakes that are made in styling a web-app
come under this heading.
If seperating content from presentation can be understood and applied,
you're well on your way to:
\end_layout
\begin_layout Itemize
Having the look-and-feel “just happen” as your site changes and evolves
\end_layout
\begin_layout Itemize
Being able to change the theme in the future, without having to modify the
app
\end_layout
\begin_layout Standard
Since CSS has been widely adopted, most web developers are familiar with
seperating content from presentation here is a reminder about how this
works:
\end_layout
\begin_layout Description
“Content” describes what is on the page, but not what it will look like.
In a Hobo app content comes from tag definitions, page templates and the
application’s data of course.
\end_layout
\begin_layout Description
“Presentation” describes how the page should look.
That is, it describes fonts, colors, margins, borders, images and ect..
In a Hobo app the presentation is handled essentially the same way as with
any app, using CSS stylesheets and image assets.
\end_layout
\begin_layout Standard
Having said that, we need to inject a note of pragmatism:
\end_layout
\begin_layout Itemize
Humans beings are visual animals.
Information can never truly be separated from the way it is displayed.
The line is sometimes blurred and there are often judgment calls to be
made.
\end_layout
\begin_layout Itemize
The technologies we’ve got to work with, in particular cross-browser support
for CSS, are far from perfect.
Sometimes we have to compromise.
\end_layout
\begin_layout Standard
There’s probably an entire PhD thesis lurking in that first point, but let’s
move on!
\end_layout
\begin_layout Subsubsection*
The current site
\end_layout
\begin_layout Standard
To begin look at the elements of the existing site we need to replicate.
The main ones are:
\end_layout
\begin_layout Standard
A banner image:
\end_layout
\begin_layout Standard
\begin_inset Float figure
wide false
sideways false
status open
\begin_layout Plain Layout
\begin_inset Graphics
filename figures/ch5/nifa_banner.png
width 100col%
\end_inset
\end_layout
\begin_layout Plain Layout
\begin_inset Caption
\begin_layout Plain Layout
The NIFA banner image
\end_layout
\end_inset
\end_layout
\begin_layout Plain Layout
\end_layout
\end_inset
\end_layout
\begin_layout Standard
A photo image that fits below the banner image:
\end_layout
\begin_layout Standard
\begin_inset Float figure
wide false
sideways false
status open
\begin_layout Plain Layout
\begin_inset Graphics
filename figures/ch5/nifa_photo_image.png
width 100col%
\end_inset
\end_layout
\begin_layout Plain Layout
\begin_inset Caption
\begin_layout Plain Layout
The NIFA photo image
\end_layout
\end_inset
\end_layout
\begin_layout Plain Layout
\end_layout
\end_inset
\end_layout
\begin_layout Standard
The main navigation bar:
\end_layout
\begin_layout Standard
\begin_inset Float figure
wide false
sideways false
status open
\begin_layout Plain Layout
\begin_inset Graphics
filename figures/ch5/nifa_nav_bar.png
width 100col%
\end_inset
\end_layout
\begin_layout Plain Layout
\begin_inset Caption
\begin_layout Plain Layout
The NIFA main navigation bar
\end_layout
\end_inset
\end_layout
\begin_layout Plain Layout
\end_layout
\end_inset
\end_layout
\begin_layout Standard
A couple of styles of navigation panels:
\end_layout
\begin_layout Standard
\begin_inset Float figure
wide false
sideways false
status open
\begin_layout Plain Layout
\begin_inset Graphics
filename figures/ch5/nifa_nav_panels.png
\end_inset
\begin_inset Graphics
filename figures/ch5/nifa_nav_panels2.png
\end_inset
\begin_inset Graphics
filename figures/ch5/nifa_nav_panels3.png
\end_inset
\end_layout
\begin_layout Plain Layout
\begin_inset Caption
\begin_layout Plain Layout
NIFA navigation panels
\end_layout
\end_inset
\end_layout
\begin_layout Plain Layout
\end_layout
\end_inset
\end_layout
\begin_layout Standard
And more navigation in the page footer:
\end_layout
\begin_layout Standard
\begin_inset Float figure
wide false
sideways false
status open
\begin_layout Plain Layout
\begin_inset Graphics
filename figures/ch5/nifa_footer_nav.png
width 100col%
\end_inset
\end_layout
\begin_layout Plain Layout
\begin_inset Caption
\begin_layout Plain Layout
NIFA footer navigation
\end_layout
\end_inset
\end_layout
\begin_layout Plain Layout
\end_layout
\end_inset
\end_layout
\begin_layout Standard
An important thing to notice is that this site is
\begin_inset Flex Emph
status collapsed
\begin_layout Plain Layout
not
\end_layout
\end_inset
just a “theme” in the Hobo sense of the word.
Hobo themes are purely about presentation, whereas the “look and feel”
of this site is a mixture of contents, elements, and presentation.
\end_layout
\begin_layout Standard
That means we’re going to be creating three things to capture the site's
look-and-feel:
\end_layout
\begin_layout Itemize
Tag Definitions
\end_layout
\begin_layout Itemize
A CSS stylesheet
\end_layout
\begin_layout Itemize
Some image assets.
\end_layout
\begin_layout Subsubsection*
The current markup
\end_layout
\begin_layout Standard
The existing site makes extensive use of HTML tables for layout.
The various images in the page are present in the markup as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
<img>
\end_layout
\end_inset
tags.
In other words, the existing markup is very
\begin_inset Flex Emph
status collapsed
\begin_layout Plain Layout
presentational
\end_layout
\end_inset
.
\end_layout
\begin_layout Standard
Rather than create tag definitions out of the existing markup, we’ll be
recreating the site using clean, semantic markup and CSS.
\end_layout
\begin_layout Standard
The other advantage of re-creating the markup is that it will be easier
to follow Hobo conventions.
There’s no particular need to do this, but it will be easier to jump from
one Hobo app to the next.
\end_layout
\begin_layout Subsubsection*
Building the new app
\end_layout
\begin_layout Standard
Let’s do this properly and follow along in a blank Hobo app.
At the end of the recipe we’ll see how we could package this look-and-feel
up and re-use it another app.
To follow along, use Firefox and the Firebug extension you can find at
\begin_inset CommandInset href
LatexCommand href
target "http://getfirebug.com"
\end_inset
.
\end_layout
\begin_layout Standard
\begin_inset Box Shadowbox
position "t"
hor_pos "c"
has_inner_box 1
inner_pos "t"
use_parbox 0
use_makebox 0
width "100col%"
special "none"
height "1in"
height_special "totalheight"
status open
\begin_layout Code
> hobo nifa-demo
\end_layout
\begin_layout Code
> cd nifa-demo
\end_layout
\begin_layout Code
> hobo g migration
\end_layout
\end_inset
\end_layout
\begin_layout Standard
If you fire up the server, you’ll see the default Hobo app of course:
\end_layout
\begin_layout Standard
\begin_inset Float figure
wide false
sideways false
status open
\begin_layout Plain Layout
\begin_inset Graphics
filename figures/ch5/nifa_default_home.png
width 100col%
\end_inset
\end_layout
\begin_layout Plain Layout
\begin_inset Caption
\begin_layout Plain Layout
The NIFA Demo default home page
\end_layout
\end_inset
\end_layout
\begin_layout Plain Layout
\end_layout
\end_inset
\end_layout
\begin_layout Standard
First thing to do is change the heading “Nifa” to “NIFA” in
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\backslash
views
\backslash
taglibs
\backslash
applicationl.dryml
\end_layout
\end_inset
since it is an acronym for the National Institute of Food and Agriculture:
\end_layout
\begin_layout Standard
\begin_inset Float figure
wide false
sideways false
status open
\begin_layout Plain Layout
\begin_inset Graphics
filename figures/ch5/nifa_app-name.png
\end_inset
\end_layout
\begin_layout Plain Layout
\begin_inset Caption
\begin_layout Plain Layout
Using the "app-name" tag to change the default application name
\end_layout
\end_inset
\end_layout
\begin_layout Plain Layout
\end_layout
\end_inset
\end_layout
\begin_layout Standard
Now, we can start to make it look like the page we’re after.
We’ll take it step by step.
\end_layout
\begin_layout Subsubsection*
Main background and width
\end_layout
\begin_layout Standard
With the Firebug add-on for Firefox I can tell that the NIFA background
color is
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
#A8ACB7
\end_layout
\end_inset
:
\end_layout
\begin_layout Standard
\begin_inset Float figure
wide false
sideways false
status open
\begin_layout Plain Layout
\begin_inset Graphics
filename figures/ch5/firebug_background_color.png
width 100col%
\end_inset
\end_layout
\begin_layout Plain Layout
\begin_inset Caption
\begin_layout Plain Layout
Using Firebug to locate the background color
\end_layout
\end_inset
\end_layout
\begin_layout Plain Layout
\end_layout
\end_inset
\end_layout
\begin_layout Standard
Switching to the Hobo NIFA Demo application, Firebug tells us (click the
inspect button, then click on the background) that the CSS rule that sets
the current background comes from
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
clean.css
\end_layout
\end_inset
and looks like:
\end_layout
\begin_layout Standard
\begin_inset Float figure
wide false
sideways false
status open
\begin_layout Plain Layout
\begin_inset Graphics
filename figures/ch5/firebug_hobo_images.png
width 100col%
\end_inset
\end_layout
\begin_layout Plain Layout
\begin_inset Caption
\begin_layout Plain Layout
Using Firebug to find the images used by Hobo for the default background
\end_layout
\end_inset
\end_layout
\begin_layout Plain Layout
\end_layout
\end_inset
\end_layout
\begin_layout Standard
Anything we add to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
application.css
\end_layout
\end_inset
(it is empty by default) will override
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
clean.css
\end_layout
\end_inset
.
So I’m going to add this rule to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
public/stylesheets/application.css
\end_layout
\end_inset
:
\end_layout
\begin_layout Standard
\begin_inset Box Shadowbox
position "t"
hor_pos "c"
has_inner_box 1
inner_pos "t"
use_parbox 0
use_makebox 0
width "100col%"
special "none"
height "1in"
height_special "totalheight"
status open
\begin_layout Code
html, body { background:#A8ACB7 }
\end_layout
\end_inset
\end_layout
\begin_layout Standard
\begin_inset Float figure
wide false
sideways false
status open
\begin_layout Plain Layout
\begin_inset Graphics
filename figures/ch5/adding_new_background_color.png
width 100col%
\end_inset
\end_layout
\begin_layout Plain Layout
\begin_inset Caption
\begin_layout Plain Layout
Adding the new background color to "application.css"
\end_layout
\end_inset
\end_layout
\begin_layout Plain Layout
\end_layout
\end_inset
\end_layout
\begin_layout Standard
Again, using Firebug on the NIFA Demo app (by clicking on the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
<body>
\end_layout
\end_inset
tag in the HTML window) I can see that the width is set on the body tag:
\end_layout
\begin_layout Standard
\begin_inset Box Shadowbox
position "t"
hor_pos "c"
has_inner_box 1
inner_pos "t"
use_parbox 0
use_makebox 0
width "100col%"
special "none"
height "1in"
height_special "totalheight"
status open
\begin_layout Code
body { ...
width: 960px; ...
}
\end_layout
\end_inset
\end_layout
\begin_layout Standard
Back in NIFA, I can right click the banner image and chose “View Image”,
and Firefox tells me its width is 766 pixels.
In
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
application.css
\end_layout
\end_inset
I add
\end_layout
\begin_layout Standard
\begin_inset Box Shadowbox
position "t"
hor_pos "c"
has_inner_box 1
inner_pos "t"
use_parbox 0
use_makebox 0
width "100col%"
special "none"
height "1in"
height_special "totalheight"
status open
\begin_layout Code
body { width: 766px; }
\end_layout