[BUGFIX] Correct old naming "Text w/image" into "Text & Images"
[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-addintextclearer:
613
614 addIntextClearer
615 ~~~~~~~~~~~~~~~~
616
617 .. container:: table-row
618
619 Property
620 addIntextClearer
621
622 Data type
623 bool
624
625 Description
626 Whether a clearer should be added after textpic elements of type
627 intext-left or intext-right
628
629 Default
630 1
631
632
633
634 .. _constants-styles-content-imgtext-linkwrap:
635
636 styles.content.imgtext.linkWrap
637 """""""""""""""""""""""""""""""
638
639
640 .. _constants-styles-content-imgtext-linkwrap-width:
641
642 width
643 ~~~~~
644
645 .. container:: table-row
646
647 Property
648 width
649
650 Data type
651 int+
652
653 Description
654 This specifies the width of the enlarged image when click-enlarge is
655 enabled.
656
657 Default
658 800m
659
660
661
662 .. _constants-styles-content-imgtext-linkwrap-height:
663
664 height
665 ~~~~~~
666
667 .. container:: table-row
668
669 Property
670 height
671
672 Data type
673 int+
674
675 Description
676 This specifies the height of the enlarged image when click-enlarge is
677 enabled.
678
679 Default
680 600m
681
682
683
684 .. _constants-styles-content-imgtext-linkwrap-effects:
685
686 effects
687 ~~~~~~~
688
689 .. container:: table-row
690
691 Property
692 effects
693
694 Data type
695 string
696
697 Description
698 Effects applied to the enlarged image.
699
700
701
702 .. _constants-styles-content-imgtext-linkwrap-newwindow:
703
704 newWindow
705 ~~~~~~~~~
706
707 .. container:: table-row
708
709 Property
710 newWindow
711
712 Data type
713 bool
714
715 Description
716 If set, every click-enlarged image will open in it's own popup window
717 and not the current popup window (which may have a wrong size for the
718 image to fit in)
719
720 Default
721 0
722
723
724
725 .. _constants-styles-content-imgtext-linkwrap-lightboxenabled:
726
727 lightboxEnabled
728 ~~~~~~~~~~~~~~~
729
730 .. container:: table-row
731
732 Property
733 lightboxEnabled
734
735 Data type
736 string
737
738 Description
739 If set, images will be rendered with a link to their big version and a
740 specified css class and rel attribute to easily allow the use of
741 lightboxes
742
743 Default
744 0
745
746
747
748 .. _constants-styles-content-imgtext-linkwrap-lightboxcssclass:
749
750 lightboxCssClass
751 ~~~~~~~~~~~~~~~~
752
753 .. container:: table-row
754
755 Property
756 lightboxCssClass
757
758 Data type
759 string
760
761 Description
762 Which CSS class to use for lightbox links (only applicable if lightbox
763 rendering is enabled)
764
765 Default
766 lightbox
767
768
769
770 .. _constants-styles-content-imgtext-linkwrap-lightboxrelattribute:
771
772 LightboxRelAttribute
773 ~~~~~~~~~~~~~~~~~~~~
774
775 .. container:: table-row
776
777 Property
778 LightboxRelAttribute
779
780 Data type
781 string
782
783 Description
784 Which rel="" attribute to use for lightbox links (only applicable if
785 lightbox rendering is enabled)
786
787 Default
788 lightbox[{field:uid}]
789
790
791 .. _constants-styles-content-uploads:
792
793 styles.content.uploads
794 """"""""""""""""""""""
795
796
797 .. _constants-styles-content-uploads-jumpurl-secure:
798
799 jumpurl\_secure
800 ~~~~~~~~~~~~~~~
801
802 .. container:: table-row
803
804 Property
805 jumpurl\_secure
806
807 Data type
808 bool
809
810 Description
811 Set to 1 to secure "jump URLs".
812
813
814
815 .. _constants-styles-content-uploads-jumpurl-secure-mimetypes:
816
817 jumpurl\_secure\_mimeTypes
818 ~~~~~~~~~~~~~~~~~~~~~~~~~~
819
820 .. container:: table-row
821
822 Property
823 jumpurl\_secure\_mimeTypes
824
825 Data type
826 string
827
828 Description
829 Comma-separated list of mime types for which "jump URLs" should be secured.
830
831 Default
832 pdf=application/pdf, doc=application/msword
833
834
835
836 .. _constants-styles-content-uploads-jumpurl:
837
838 jumpurl
839 ~~~~~~~
840
841 .. container:: table-row
842
843 Property
844 jumpurl
845
846 Data type
847 bool
848
849 Description
850 Set to 1 to active "jump URLs".
851
852
853
854 .. _constants-styles-content-uploads-filesizebytelabels:
855
856 filesizeByteLabels
857 ~~~~~~~~~~~~~~~~~~
858
859 .. container:: table-row
860
861 Property
862 filesizeByteLabels
863
864 Data type
865 string
866
867 Description
868 The labels for bytes, kilobytes, megabytes and gigabytes
869
870 Default
871 " \| K\| M\| G"
872
873
874 .. _constants-styles-content-mailform:
875
876 styles.content.mailform
877 """""""""""""""""""""""
878
879
880 .. _constants-styles-content-mailform-target:
881
882 target
883 ~~~~~~
884
885 .. container:: table-row
886
887 Property
888 target
889
890 Data type
891 string
892
893 Description
894 The mailform target
895
896 Default
897 {$PAGE\_TARGET}
898
899
900
901 .. _constants-styles-content-mailform-goodmess:
902
903 goodMess
904 ~~~~~~~~
905
906 .. container:: table-row
907
908 Property
909 goodMess
910
911 Data type
912 string
913
914 Description
915 This is the message (if any) that is popped-up (JavaScript) when a
916 user clicks "send" in an email-form
917
918
919
920 .. _constants-styles-content-mailform-badmess:
921
922 badMess
923 ~~~~~~~
924
925 .. container:: table-row
926
927 Property
928 badMess
929
930 Data type
931 string
932
933 Description
934 This is the message that is popped-up (JavaScript) when a user has NOT
935 filled required fields in an email-form
936
937
938 .. _constants-styles-content-loginform:
939
940 styles.content.loginform
941 """"""""""""""""""""""""
942
943
944 .. _constants-styles-content-loginform-target:
945
946 target
947 ~~~~~~
948
949 .. container:: table-row
950
951 Property
952 target
953
954 Data type
955 string
956
957 Description
958 The login form target
959
960 Default
961 \_top
962
963
964
965 .. _constants-styles-content-loginform-goodmess:
966
967 goodMess
968 ~~~~~~~~
969
970 .. container:: table-row
971
972 Property
973 goodMess
974
975 Data type
976 string
977
978 Description
979 This is the message (if any) that is popped-up (JavaScript) when a
980 user logs in as a front-end user
981
982
983 .. _constants-styles-content-loginform-pid:
984
985 pid
986 ~~~
987
988 .. container:: table-row
989
990 Property
991 pid
992
993 Data type
994 int
995
996 Description
997 Enter the page-uid number (PID) of the sysFolder where you keep your
998 fe\_users that are supposed to login on this site. This setting is
999 necessary, if login is going to work (and you aren't using "felogin")!
1000
1001
1002 .. _constants-styles-content-searchform:
1003
1004 styles.content.searchform
1005 """""""""""""""""""""""""
1006
1007
1008 .. _constants-styles-content-searchform-goodmess:
1009
1010 goodMess
1011 ~~~~~~~~
1012
1013 .. container:: table-row
1014
1015 Property
1016 goodMess
1017
1018 Data type
1019 string
1020
1021 Description
1022 This is the message (if any) that is popped-up (JavaScript) when a
1023 user performs a search
1024
1025
1026 .. _constants-styles-content-searchresult:
1027
1028 styles.content.searchresult
1029 """""""""""""""""""""""""""
1030
1031
1032 .. _constants-styles-content-searchresult-resulttarget:
1033
1034 resultTarget
1035 ~~~~~~~~~~~~
1036
1037 .. container:: table-row
1038
1039 Property
1040 resultTarget
1041
1042 Data type
1043 string
1044
1045 Description
1046 Search result links target.
1047
1048
1049 Default
1050 {$PAGE\_TARGET}
1051
1052
1053
1054 .. _constants-styles-content-searchresult-target:
1055
1056 target
1057 ~~~~~~
1058
1059 .. container:: table-row
1060
1061 Property
1062 target
1063
1064 Data type
1065 string
1066
1067 Description
1068 Target for the search results pagination links.
1069
1070
1071 Default
1072 {$PAGE\_TARGET}
1073
1074
1075 .. _constants-styles-content-media:
1076
1077 styles.content.media
1078 """"""""""""""""""""
1079
1080
1081 .. _constants-styles-content-media-videoplayer:
1082
1083 videoPlayer
1084 ~~~~~~~~~~~
1085
1086 .. container:: table-row
1087
1088 Property
1089 videoPlayer
1090
1091 Data type
1092 string
1093
1094 Description
1095 configure the path to the video player
1096
1097 Default
1098 typo3/contrib/flashmedia/flvplayer.swf
1099
1100
1101
1102 .. _constants-styles-content-media-defaultvideowidth:
1103
1104 defaultVideoWidth
1105 ~~~~~~~~~~~~~~~~~
1106
1107 .. container:: table-row
1108
1109 Property
1110 defaultVideoWidth
1111
1112 Data type
1113 int
1114
1115 Description
1116 define the default width for the media video (in pixels)
1117
1118 Default
1119 600
1120
1121
1122
1123 .. _constants-styles-content-media-defaultvideoheight:
1124
1125 defaultVideoHeight
1126 ~~~~~~~~~~~~~~~~~~
1127
1128 .. container:: table-row
1129
1130 Property
1131 defaultVideoHeight
1132
1133 Data type
1134 int
1135
1136 Description
1137 define the default height for the media video (in pixels)
1138
1139 Default
1140 400
1141
1142
1143
1144 .. _constants-styles-content-media-audioplayer:
1145
1146 audioPlayer
1147 ~~~~~~~~~~~
1148
1149 .. container:: table-row
1150
1151 Property
1152 audioPlayer
1153
1154 Data type
1155 string
1156
1157 Description
1158 configure the path to the audio player
1159
1160 Default
1161 typo3/contrib/flashmedia/player.swf
1162
1163
1164
1165 .. _constants-styles-content-media-defaultaudiowidth:
1166
1167 defaultAudioWidth
1168 ~~~~~~~~~~~~~~~~~
1169
1170 .. container:: table-row
1171
1172 Property
1173 defaultAudioWidth
1174
1175 Data type
1176 int
1177
1178 Description
1179 define the default width for the media audio (in pixels)
1180
1181 Default
1182 300
1183
1184
1185
1186 .. _constants-styles-content-media-defaultaudioheight:
1187
1188 defaultAudioHeight
1189 ~~~~~~~~~~~~~~~~~~
1190
1191 .. container:: table-row
1192
1193 Property
1194 defaultAudioHeight
1195
1196 Data type
1197 int
1198
1199 Description
1200 define the default height for the media audio (in pixels)
1201
1202 Default
1203 30
1204