39d298b3467749d2b2a143836c43cde35ab2c945
[Packages/TYPO3.CMS.git] / typo3 / sysext / css_styled_content / Documentation / Configuration / Constants / Index.rst
1 .. ==================================================
2 .. FOR YOUR INFORMATION
3 .. --------------------------------------------------
4 .. -*- coding: utf-8 -*- with BOM.
5
6 .. include:: ../../Includes.txt
7
8
9 .. _constants:
10
11 Constants
12 ^^^^^^^^^
13
14 .. note::
15
16 Not all constants described here can be edited with the Constant Editors.
17 Just define those in the "Constants" field of your TypoScript templates.
18
19
20 .. _constants-page-target:
21
22 PAGE\_TARGET
23 """"""""""""
24
25 .. container:: table-row
26
27 Property
28 PAGE\_TARGET
29
30 Data type
31 string
32
33 Description
34 Target for internal links: Should match the name of the content PAGE-
35 object in TypoScript when used with frames. Most cases: set to ""
36 (empty). If you have frames in the template set to "page".
37
38
39
40 .. _constants-content:
41
42 content
43 """""""
44
45
46 .. _constants-defaultheadertype:
47
48 defaultHeaderType
49 ~~~~~~~~~~~~~~~~~
50
51 .. container:: table-row
52
53 Property
54 defaultHeaderType
55
56 Data type
57 int
58
59 Description
60 The number of the header layout to be used by default
61
62 Default
63 1
64
65
66
67 .. _constants-pageframeobj:
68
69 pageFrameObj
70 ~~~~~~~~~~~~
71
72 .. container:: table-row
73
74 Property
75 pageFrameObj
76
77 Data type
78 string
79
80 Description
81 The name of the "contentframe". Normally set to "page" if the site has
82 a frameset. Otherwise it should be an empty value. This is important,
83 as it determines the target of internal links!
84
85
86
87 .. _constants-shortcut-tables:
88
89 shortcut.tables
90 ~~~~~~~~~~~~~~~
91
92 .. container:: table-row
93
94 Property
95 shortcut.tables
96
97 Data type
98 string
99
100 Description
101 List of tables with an old-style name
102
103 Default
104 tt_content,tt_address,tt_links,tt_guest,tt_board,tt_calender,tt_products,tt_news,tt_rating,tt_poll
105
106
107
108 .. _constants-spacebefore:
109
110 spaceBefore
111 ~~~~~~~~~~~
112
113 .. container:: table-row
114
115 Property
116 spaceBefore
117
118 Data type
119 int
120
121 Description
122 Space before each content element (pixels)
123
124 Default
125 0
126
127
128
129 .. _constants-spaceafter:
130
131 spaceAfter
132 ~~~~~~~~~~
133
134 .. container:: table-row
135
136 Property
137 spaceAfter
138
139 Data type
140 int
141
142 Description
143 Space after each content element (pixels)
144
145 Default
146 0
147
148
149 .. _constants-styles-content:
150
151 styles.content
152 """"""""""""""
153
154
155 .. _constants-styles-content-getnews-newspid:
156
157 getNews.newsPid
158 ~~~~~~~~~~~~~~~
159
160 .. container:: table-row
161
162 Property
163 getNews.newsPid
164
165 Data type
166 int
167
168 Description
169 If your template has a column with "news"-content fetched from another
170 page-id, this is where you enter the id-number of that page!
171
172 Default
173 0
174
175
176 .. _constants-styles-content-links:
177
178 styles.content.links
179 """"""""""""""""""""
180
181
182 .. _constants-styles-content-links-exttarget:
183
184 extTarget
185 ~~~~~~~~~
186
187 .. container:: table-row
188
189 Property
190 extTarget
191
192 Data type
193 string
194
195 Description
196 Target for external links
197
198 Default
199 \_blank
200
201
202
203 .. _constants-styles-content-links-target:
204
205 target
206 ~~~~~~
207
208 .. container:: table-row
209
210 Property
211 target
212
213 Data type
214 string
215
216 Description
217 Default target for links
218
219 Default
220 {$PAGE\_TARGET}
221
222
223
224 .. _constants-styles-content-links-allowtags:
225
226 allowTags
227 ~~~~~~~~~
228
229 .. container:: table-row
230
231 Property
232 allowTags
233
234 Data type
235 string
236
237 Description
238 Tags allowed in RTE content.
239
240
241 Default
242 b,i,u,a,img,br,div,center,pre,font,hr,sub,sup,p,strong,em,li,ul,ol,blo
243 ckquote,strike,del,ins,span,h1,h2,h3,h4,h5,h6,address
244
245
246 .. _constants-styles-content-imgtext:
247
248 styles.content.imgtext
249 """"""""""""""""""""""
250
251
252 .. _constants-styles-content-imgtext-maxw:
253
254 maxW
255 ~~~~
256
257 .. container:: table-row
258
259 Property
260 maxW
261
262 Data type
263 int
264
265 Description
266 This indicates that maximum number of pixels (width) a block of images
267 inserted as content is allowed to consume.
268
269 Default
270 600
271
272
273
274 .. _constants-styles-content-imgtext-maxwintext:
275
276 maxWInText
277 ~~~~~~~~~~
278
279 .. container:: table-row
280
281 Property
282 maxWInText
283
284 Data type
285 int
286
287 Description
288 Same as above, but this is the maximum width when text is wrapped
289 around an imageblock. Default is 50% of the normal Max Image Width.
290
291
292
293 .. _constants-styles-content-imgtext-captionsplit:
294
295 captionSplit
296 ~~~~~~~~~~~~
297
298 .. container:: table-row
299
300 Property
301 captionSplit
302
303 Data type
304 bool
305
306 Description
307 **Deprecated** Use :code:`imageTextSplit` below instead
308
309
310 Default
311 0
312
313
314
315 .. _constants-styles-content-imgtext-imagetextsplit:
316
317 imageTextSplit
318 ~~~~~~~~~~~~~~
319
320 .. container:: table-row
321
322 Property
323 imageTextSplit
324
325 Data type
326 bool
327
328 Description
329 If this is set, then the image text (caption, alt, title, longdesc)
330 will be split by each line and they will appear on the corresponding
331 images in the image list.
332
333 Default
334 1
335
336
337
338 .. _constants-styles-content-imgtext-emptytitlehandling:
339
340 emptyTitleHandling
341 ~~~~~~~~~~~~~~~~~~
342
343 .. container:: table-row
344
345 Property
346 emptyTitleHandling
347
348 Data type
349 string
350
351 Description
352 How the 'title' attribute will be handled if no title is given for an
353 image. Possible choices: "keepEmpty", "useAlt" or "removeAttr".
354 Recommended for accessibility is "removeAttr". For correct tooltips on
355 IE, use "keepEmpty". For use of alt="" text as title use "useAlt".
356
357 Default
358 removeAttr
359
360
361
362 .. _constants-styles-content-imgtext-titleinlink:
363
364 titleInLink
365 ~~~~~~~~~~~
366
367 .. container:: table-row
368
369 Property
370 titleInLink
371
372 Data type
373 bool
374
375 Description
376 Do you want the 'title' attribute to be added to the surrounding <a>
377 tag, if present? Recommended for accessibility is "true".
378
379 Default
380 1
381
382
383
384 .. _constants-styles-content-imgtext-titleinlinkandimg:
385
386 titleInLinkAndImg
387 ~~~~~~~~~~~~~~~~~
388
389 .. container:: table-row
390
391 Property
392 titleInLinkAndImg
393
394 Data type
395 bool
396
397 Description
398 If you have the title in the <a>-tag (titleInLink=1), you don't get
399 the 'title' in the <img>-tag. IE6 will not show the tooltip anymore.
400 So to get the 'title' in <img> too (to keep IE happy), set this too.
401 Recommended for accessibility is "false". For correct tooltips on IE6,
402 set this to "true".
403
404 Default
405 0
406
407
408
409 .. _constants-styles-content-imgtext-colspace:
410
411 colSpace
412 ~~~~~~~~
413
414 .. container:: table-row
415
416 Property
417 colSpace
418
419 Data type
420 int
421
422 Description
423 Horizontal distance between images in content elements of type "Images"
424 or "Text & Images". If you change this manually in your CSS, you need
425 to adjust this setting accordingly.
426
427 Default
428 10
429
430
431
432 .. _constants-styles-content-imgtext-rowspace:
433
434 rowSpace
435 ~~~~~~~~
436
437 .. container:: table-row
438
439 Property
440 rowSpace
441
442 Data type
443 int
444
445 Description
446 Vertical distance after image rows in content elements of type "Images"
447 or "Text & Images". If you change this manually in your CSS, you need
448 to adjust this setting accordingly.
449
450 Default
451 5
452
453
454
455 .. _constants-styles-content-imgtext-textmargin:
456
457 textMargin
458 ~~~~~~~~~~
459
460 .. container:: table-row
461
462 Property
463 textMargin
464
465 Data type
466 int
467
468 Description
469 Horizontal distance between images and text in content elements of
470 type "Text & Images".
471
472 Default
473 10
474
475
476
477 .. _constants-styles-content-imgtext-bordercolor:
478
479 borderColor
480 ~~~~~~~~~~~
481
482 .. container:: table-row
483
484 Property
485 borderColor
486
487 Data type
488 string
489
490 Description
491 Border color of images in content elements when "Border"-option for
492 element is set. Has to be either a defined color (like black, lime,
493 maroon) or a hexadecimal color code (like :code:`#FF00FF`)
494
495 Default
496 black
497
498
499
500 .. _constants-styles-content-imgtext-borderthick:
501
502 borderThick
503 ~~~~~~~~~~~
504
505 .. container:: table-row
506
507 Property
508 borderThick
509
510 Data type
511 int
512
513 Description
514 Thickness (in pixels) of border around images in content elements when
515 "Border"-option for element is set.
516
517 Default
518 2
519
520
521
522 .. _constants-styles-content-imgtext-borderspace:
523
524 borderSpace
525 ~~~~~~~~~~~
526
527 .. container:: table-row
528
529 Property
530 borderSpace
531
532 Data type
533 int
534
535 Description
536 Padding (in pixels) left and right to the image, around the border.
537
538 Default
539 0
540
541
542
543 .. _constants-styles-content-imgtext-borderselector:
544
545 borderSelector
546 ~~~~~~~~~~~~~~
547
548 .. container:: table-row
549
550 Property
551 borderSelector
552
553 Data type
554 string
555
556 Description
557 The selector where the image border is applied to. If you want your
558 border to apply elsewhere, change this setting. E.g. to apply to the
559 whole image+caption, use 'DIV.csc-textpic-border DIV.csc-textpic-
560 imagewrap .csc-textpic-image'.
561
562 Default
563 DIV.{$styles.content.imgtext.borderClass} DIV.csc-textpic-imagewrap
564 .csc-textpic-image IMG, DIV.{$styles.content.imgtext.borderClass} DIV
565 .csc-textpic-single-image IMG
566
567
568
569 .. _constants-styles-content-imgtext-borderclass:
570
571 borderClass
572 ~~~~~~~~~~~
573
574 .. container:: table-row
575
576 Property
577 borderClass
578
579 Data type
580 string
581
582 Description
583 The name of the CSS class inserted and used for creating image borders
584
585 Default
586 csc-textpic-border
587
588
589
590 .. _constants-styles-content-imgtext-separaterows:
591
592 separateRows
593 ~~~~~~~~~~~~
594
595 .. container:: table-row
596
597 Property
598 separateRows
599
600 Data type
601 bool
602
603 Description
604 Whether images should be rendered/wrapped in separated rows, e.g.
605 inside a DIV.csc-textpic-imagerow element
606
607 Default
608 1
609
610
611
612 .. _constants-styles-content-imgtext-linkwrap:
613
614 styles.content.imgtext.linkWrap
615 """""""""""""""""""""""""""""""
616
617
618 .. _constants-styles-content-imgtext-linkwrap-width:
619
620 width
621 ~~~~~
622
623 .. container:: table-row
624
625 Property
626 width
627
628 Data type
629 int+
630
631 Description
632 This specifies the width of the enlarged image when click-enlarge is
633 enabled.
634
635 Default
636 800m
637
638
639
640 .. _constants-styles-content-imgtext-linkwrap-height:
641
642 height
643 ~~~~~~
644
645 .. container:: table-row
646
647 Property
648 height
649
650 Data type
651 int+
652
653 Description
654 This specifies the height of the enlarged image when click-enlarge is
655 enabled.
656
657 Default
658 600m
659
660
661
662 .. _constants-styles-content-imgtext-linkwrap-effects:
663
664 effects
665 ~~~~~~~
666
667 .. container:: table-row
668
669 Property
670 effects
671
672 Data type
673 string
674
675 Description
676 Effects applied to the enlarged image.
677
678
679
680 .. _constants-styles-content-imgtext-linkwrap-newwindow:
681
682 newWindow
683 ~~~~~~~~~
684
685 .. container:: table-row
686
687 Property
688 newWindow
689
690 Data type
691 bool
692
693 Description
694 If set, every click-enlarged image will open in it's own popup window
695 and not the current popup window (which may have a wrong size for the
696 image to fit in)
697
698 Default
699 0
700
701
702
703 .. _constants-styles-content-imgtext-linkwrap-lightboxenabled:
704
705 lightboxEnabled
706 ~~~~~~~~~~~~~~~
707
708 .. container:: table-row
709
710 Property
711 lightboxEnabled
712
713 Data type
714 string
715
716 Description
717 If set, images will be rendered with a link to their big version and a
718 specified css class and rel attribute to easily allow the use of
719 lightboxes
720
721 Default
722 0
723
724
725
726 .. _constants-styles-content-imgtext-linkwrap-lightboxcssclass:
727
728 lightboxCssClass
729 ~~~~~~~~~~~~~~~~
730
731 .. container:: table-row
732
733 Property
734 lightboxCssClass
735
736 Data type
737 string
738
739 Description
740 Which CSS class to use for lightbox links (only applicable if lightbox
741 rendering is enabled)
742
743 Default
744 lightbox
745
746
747
748 .. _constants-styles-content-imgtext-linkwrap-lightboxrelattribute:
749
750 LightboxRelAttribute
751 ~~~~~~~~~~~~~~~~~~~~
752
753 .. container:: table-row
754
755 Property
756 LightboxRelAttribute
757
758 Data type
759 string
760
761 Description
762 Which rel="" attribute to use for lightbox links (only applicable if
763 lightbox rendering is enabled)
764
765 Default
766 lightbox[{field:uid}]
767
768
769 .. _constants-styles-content-uploads:
770
771 styles.content.uploads
772 """"""""""""""""""""""
773
774
775 .. _constants-styles-content-uploads-jumpurl-secure:
776
777 jumpurl\_secure
778 ~~~~~~~~~~~~~~~
779
780 .. container:: table-row
781
782 Property
783 jumpurl\_secure
784
785 Data type
786 bool
787
788 Description
789 Set to 1 to secure "jump URLs".
790
791
792
793 .. _constants-styles-content-uploads-jumpurl-secure-mimetypes:
794
795 jumpurl\_secure\_mimeTypes
796 ~~~~~~~~~~~~~~~~~~~~~~~~~~
797
798 .. container:: table-row
799
800 Property
801 jumpurl\_secure\_mimeTypes
802
803 Data type
804 string
805
806 Description
807 Comma-separated list of mime types for which "jump URLs" should be secured.
808
809 Default
810 pdf=application/pdf, doc=application/msword
811
812
813
814 .. _constants-styles-content-uploads-jumpurl:
815
816 jumpurl
817 ~~~~~~~
818
819 .. container:: table-row
820
821 Property
822 jumpurl
823
824 Data type
825 bool
826
827 Description
828 Set to 1 to active "jump URLs".
829
830
831
832 .. _constants-styles-content-uploads-filesizebytelabels:
833
834 filesizeByteLabels
835 ~~~~~~~~~~~~~~~~~~
836
837 .. container:: table-row
838
839 Property
840 filesizeByteLabels
841
842 Data type
843 string
844
845 Description
846 The labels for bytes, kilobytes, megabytes and gigabytes
847
848 Default
849 " \| K\| M\| G"
850
851
852 .. _constants-styles-content-mailform:
853
854 styles.content.mailform
855 """""""""""""""""""""""
856
857
858 .. _constants-styles-content-mailform-target:
859
860 target
861 ~~~~~~
862
863 .. container:: table-row
864
865 Property
866 target
867
868 Data type
869 string
870
871 Description
872 The mailform target
873
874 Default
875 {$PAGE\_TARGET}
876
877
878
879 .. _constants-styles-content-mailform-goodmess:
880
881 goodMess
882 ~~~~~~~~
883
884 .. container:: table-row
885
886 Property
887 goodMess
888
889 Data type
890 string
891
892 Description
893 This is the message (if any) that is popped-up (JavaScript) when a
894 user clicks "send" in an email-form
895
896
897
898 .. _constants-styles-content-mailform-badmess:
899
900 badMess
901 ~~~~~~~
902
903 .. container:: table-row
904
905 Property
906 badMess
907
908 Data type
909 string
910
911 Description
912 This is the message that is popped-up (JavaScript) when a user has NOT
913 filled required fields in an email-form
914
915
916 .. _constants-styles-content-loginform:
917
918 styles.content.loginform
919 """"""""""""""""""""""""
920
921
922 .. _constants-styles-content-loginform-target:
923
924 target
925 ~~~~~~
926
927 .. container:: table-row
928
929 Property
930 target
931
932 Data type
933 string
934
935 Description
936 The login form target
937
938 Default
939 \_top
940
941
942
943 .. _constants-styles-content-loginform-goodmess:
944
945 goodMess
946 ~~~~~~~~
947
948 .. container:: table-row
949
950 Property
951 goodMess
952
953 Data type
954 string
955
956 Description
957 This is the message (if any) that is popped-up (JavaScript) when a
958 user logs in as a front-end user
959
960
961 .. _constants-styles-content-loginform-pid:
962
963 pid
964 ~~~
965
966 .. container:: table-row
967
968 Property
969 pid
970
971 Data type
972 int
973
974 Description
975 Enter the page-uid number (PID) of the sysFolder where you keep your
976 fe\_users that are supposed to login on this site. This setting is
977 necessary, if login is going to work (and you aren't using "felogin")!
978
979
980 .. _constants-styles-content-searchform:
981
982 styles.content.searchform
983 """""""""""""""""""""""""
984
985
986 .. _constants-styles-content-searchform-goodmess:
987
988 goodMess
989 ~~~~~~~~
990
991 .. container:: table-row
992
993 Property
994 goodMess
995
996 Data type
997 string
998
999 Description
1000 This is the message (if any) that is popped-up (JavaScript) when a
1001 user performs a search
1002
1003
1004 .. _constants-styles-content-searchresult:
1005
1006 styles.content.searchresult
1007 """""""""""""""""""""""""""
1008
1009
1010 .. _constants-styles-content-searchresult-resulttarget:
1011
1012 resultTarget
1013 ~~~~~~~~~~~~
1014
1015 .. container:: table-row
1016
1017 Property
1018 resultTarget
1019
1020 Data type
1021 string
1022
1023 Description
1024 Search result links target.
1025
1026
1027 Default
1028 {$PAGE\_TARGET}
1029
1030
1031
1032 .. _constants-styles-content-searchresult-target:
1033
1034 target
1035 ~~~~~~
1036
1037 .. container:: table-row
1038
1039 Property
1040 target
1041
1042 Data type
1043 string
1044
1045 Description
1046 Target for the search results pagination links.
1047
1048
1049 Default
1050 {$PAGE\_TARGET}
1051
1052
1053 .. _constants-styles-content-media:
1054
1055 styles.content.media
1056 """"""""""""""""""""
1057
1058
1059 .. _constants-styles-content-media-videoplayer:
1060
1061 videoPlayer
1062 ~~~~~~~~~~~
1063
1064 .. container:: table-row
1065
1066 Property
1067 videoPlayer
1068
1069 Data type
1070 string
1071
1072 Description
1073 configure the path to the video player
1074
1075 Default
1076 EXT:mediace/Resources/Contrib/flashmedia/flvplayer.swf
1077
1078
1079
1080 .. _constants-styles-content-media-defaultvideowidth:
1081
1082 defaultVideoWidth
1083 ~~~~~~~~~~~~~~~~~
1084
1085 .. container:: table-row
1086
1087 Property
1088 defaultVideoWidth
1089
1090 Data type
1091 int
1092
1093 Description
1094 define the default width for the media video (in pixels)
1095
1096 Default
1097 600
1098
1099
1100
1101 .. _constants-styles-content-media-defaultvideoheight:
1102
1103 defaultVideoHeight
1104 ~~~~~~~~~~~~~~~~~~
1105
1106 .. container:: table-row
1107
1108 Property
1109 defaultVideoHeight
1110
1111 Data type
1112 int
1113
1114 Description
1115 define the default height for the media video (in pixels)
1116
1117 Default
1118 400
1119
1120
1121
1122 .. _constants-styles-content-media-audioplayer:
1123
1124 audioPlayer
1125 ~~~~~~~~~~~
1126
1127 .. container:: table-row
1128
1129 Property
1130 audioPlayer
1131
1132 Data type
1133 string
1134
1135 Description
1136 configure the path to the audio player
1137
1138 Default
1139 EXT:mediace/Resources/Contrib/flashmedia/player.swf
1140
1141
1142
1143 .. _constants-styles-content-media-defaultaudiowidth:
1144
1145 defaultAudioWidth
1146 ~~~~~~~~~~~~~~~~~
1147
1148 .. container:: table-row
1149
1150 Property
1151 defaultAudioWidth
1152
1153 Data type
1154 int
1155
1156 Description
1157 define the default width for the media audio (in pixels)
1158
1159 Default
1160 300
1161
1162
1163
1164 .. _constants-styles-content-media-defaultaudioheight:
1165
1166 defaultAudioHeight
1167 ~~~~~~~~~~~~~~~~~~
1168
1169 .. container:: table-row
1170
1171 Property
1172 defaultAudioHeight
1173
1174 Data type
1175 int
1176
1177 Description
1178 define the default height for the media audio (in pixels)
1179
1180 Default
1181 30
1182