[BUGFIX] Wrong marker mentioned in documentation of ext:felogin
[Packages/TYPO3.CMS.git] / typo3 / sysext / felogin / Documentation / Configuration / Index.rst
1 .. ==================================================
2 .. FOR YOUR INFORMATION
3 .. --------------------------------------------------
4 .. -*- coding: utf-8 -*- with BOM.
5
6 .. include:: ../Includes.txt
7
8
9
10 .. _configuration:
11
12 Configuration
13 -------------
14
15 All configuration options are available in the FlexForm or TypoScript,
16 with the FlexForm settings taking precedence.
17
18
19 .. _plugin-tx-felogin-pi1:
20
21 plugin.tx\_felogin\_pi1
22 ^^^^^^^^^^^^^^^^^^^^^^^
23
24 .. _storagepid:
25
26 storagePid
27 """"""""""
28
29 .. container:: table-row
30
31    Property
32          storagePid
33
34    Data type
35          string
36
37    Description
38          Define the Storage Folder with the Website User Records, using a comma
39          separated list or single value
40
41    Default
42          {$styles.content.loginform.pid}
43
44
45
46 .. _recursive:
47
48 recursive
49 """""""""
50
51 .. container:: table-row
52
53    Property
54          recursive
55
56    Data type
57          bool
58
59    Description
60          If set, also any subfolders of the storagePid will be used
61
62
63
64 .. _templatefile:
65
66 templateFile
67 """"""""""""
68
69 .. container:: table-row
70
71    Property
72          templateFile
73
74    Data type
75          string
76
77    Description
78          The Template File
79
80    Default
81          EXT:felogin/template.html
82
83
84
85 .. _feloginbaseurl:
86
87 feloginBaseURL
88 """"""""""""""
89
90 .. container:: table-row
91
92    Property
93          feloginBaseURL
94
95    Data type
96          string
97
98    Description
99          Base url if something other than the system base URL is needed
100
101
102
103 .. _wrapcontentinbaseclass:
104
105 wrapContentInBaseClass
106 """"""""""""""""""""""
107
108 .. container:: table-row
109
110    Property
111          wrapContentInBaseClass
112
113    Data type
114          bool
115
116    Description
117          If set, plugin is wrapped by Standard Base Class-Wrap
118
119    Default
120          true
121
122
123
124 .. _linkconfig:
125
126 linkConfig
127 """"""""""
128
129 .. container:: table-row
130
131    Property
132          linkConfig
133
134    Data type
135          array
136
137    Description
138          Typolink Configuration for the generated Links
139
140
141
142 .. _preservegetvars:
143
144 preserveGETvars
145 """""""""""""""
146
147 .. container:: table-row
148
149    Property
150          preserveGETvars
151
152    Data type
153          String
154
155    Description
156          When using login plugin on a page with other plugins you might want to
157          have your GET-params preserved. You can define them here. Possible
158          settings:
159
160          all - takes all GET-vars found
161
162          comma-separated list - takes defined vars
163
164          Example::
165
166             preserveGETvars = tx_ttnews[tt_news],tx_myext[id],...
167
168
169
170 .. _showforgotpasswordlink:
171
172 showForgotPasswordLink
173 """"""""""""""""""""""
174
175 .. container:: table-row
176
177    Property
178          showForgotPasswordLink
179
180    Data type
181          bool
182
183    Description
184          If set, the section in the template to display the link to the forget
185          password dialogue is visible.
186
187          .. important::
188
189              Be aware that having this option disabled also prevents the plugin to
190              display the forgot password form. For instance if you access the link
191              directly.
192
193
194
195 .. _showpermalogin:
196
197 showPermaLogin
198 """"""""""""""
199
200 .. container:: table-row
201
202    Property
203          showPermaLogin
204
205    Data type
206          bool
207
208    Description
209          If set, the section in the template to display the option to remember
210          the login (with a cookie) is visible.
211
212
213
214 .. _forgetlinkhashvalidtime:
215
216 forgetLinkHashValidTime
217 """""""""""""""""""""""
218
219 .. container:: table-row
220
221    Property
222          forgetLinkHashValidTime
223
224    Data type
225          integer
226
227    Description
228          How many hours the link for forget password is valid
229
230    Default
231          12
232
233
234
235 .. _newpasswordminlength:
236
237 newPasswordMinLength
238 """"""""""""""""""""
239
240 .. container:: table-row
241
242    Property
243          newPasswordMinLength
244
245    Data type
246          integer
247
248    Description
249          Minimum length of the new password a user sets
250
251    Default
252          6
253
254
255
256 .. _showlogoutformafterlogin:
257
258 showLogoutFormAfterLogin
259 """"""""""""""""""""""""
260
261 .. container:: table-row
262
263    Property
264          showLogoutFormAfterLogin
265
266    Data type
267          bool
268
269    Description
270          If set, the logout form will be displayed immediately after successful
271          login.
272
273          .. note::
274
275             Setting this option will disable the redirect options!
276             Instead of redirecting the plugin will show the logout form.
277
278
279
280 .. _welcomeheader-stdwrap:
281
282 welcomeHeader\_stdWrap
283 """"""""""""""""""""""
284
285 .. container:: table-row
286
287    Property
288          welcomeHeader\_stdWrap
289
290    Data type
291          array
292
293    Description
294          stdWrap for Welcome Header
295
296    Default
297          wrap = <h3>\|</h3>
298
299
300
301 .. _welcomemessage-stdwrap:
302
303 welcomeMessage\_stdWrap
304 """""""""""""""""""""""
305
306 .. container:: table-row
307
308    Property
309          welcomeMessage\_stdWrap
310
311    Data type
312          array
313
314    Description
315          stdWrap for Welcome Message
316
317    Default
318          wrap = <div>\|</div>
319
320
321
322 .. _successheader-stdwrap:
323
324 successHeader\_stdWrap
325 """"""""""""""""""""""
326
327 .. container:: table-row
328
329    Property
330          successHeader\_stdWrap
331
332    Data type
333          array
334
335    Description
336          stdWrap for Login SuccessHeader
337
338    Default
339          wrap = <h3>\|</h3>
340
341
342
343 .. _successmessage-stdwrap:
344
345 successMessage\_stdWrap
346 """""""""""""""""""""""
347
348 .. container:: table-row
349
350    Property
351          successMessage\_stdWrap
352
353    Data type
354          array
355
356    Description
357          stdWrap for Login Success Message
358
359    Default
360          wrap = <div>\|</div>
361
362
363
364 .. _logoutheader-stdwrap:
365
366 logoutHeader\_stdWrap
367 """""""""""""""""""""
368
369 .. container:: table-row
370
371    Property
372          logoutHeader\_stdWrap
373
374    Data type
375          array
376
377    Description
378          stdWrap for Logout Header
379
380    Default
381          wrap = <h3>\|</h3>
382
383
384
385 .. _logoutmessage-stdwrap:
386
387 logoutMessage\_stdWrap
388 """"""""""""""""""""""
389
390 .. container:: table-row
391
392    Property
393          logoutMessage\_stdWrap
394
395    Data type
396          array
397
398    Description
399          stdWrap for Logout Message
400
401    Default
402          wrap = <div>\|</div>
403
404
405
406 .. _errorheader-stdwrap:
407
408 errorHeader\_stdWrap
409 """"""""""""""""""""
410
411 .. container:: table-row
412
413    Property
414          errorHeader\_stdWrap
415
416    Data type
417          array
418
419    Description
420          stdWrap for Error Header
421
422    Default
423          wrap = <h3>\|</h3>
424
425
426
427 .. _errormessage-stdwrap:
428
429 errorMessage\_stdWrap
430 """""""""""""""""""""
431
432 .. container:: table-row
433
434    Property
435          errorMessage\_stdWrap
436
437    Data type
438          array
439
440    Description
441          stdWrap for Error Message
442
443    Default
444          wrap = <div>\|</div>
445
446
447
448 .. _forgotheader-stdwrap:
449
450 forgotHeader\_stdWrap
451 """""""""""""""""""""
452
453 .. container:: table-row
454
455    Property
456          forgotHeader\_stdWrap
457
458    Data type
459          array
460
461    Description
462          stdWrap for Forgot Header
463
464    Default
465          wrap = <h3>\|</h3>
466
467
468
469 .. _forgotmessage-stdwrap:
470
471 forgotMessage\_stdWrap
472 """"""""""""""""""""""
473
474 .. container:: table-row
475
476    Property
477          forgotMessage\_stdWrap
478
479    Data type
480          array
481
482    Description
483          stdWrap for Forgot Message
484
485    Default
486          wrap = <div>\|</div>
487
488
489
490 .. _forgoterrormessage-stdwrap:
491
492 forgotErrorMessage\_stdWrap
493 """""""""""""""""""""""""""
494
495 .. container:: table-row
496
497    Property
498          forgotErrorMessage\_stdWrap
499
500    Data type
501          array
502
503    Description
504          stdWrap for error message in forgot password form
505
506    Default
507          wrap = <div>\|</div>
508
509
510
511 .. _forgotresetmessageemailsentmessage-stdwrap:
512
513 forgotResetMessageEmailSentMessage\_stdWrap
514 """""""""""""""""""""""""""""""""""""""""""
515
516 .. container:: table-row
517
518    Property
519          forgotResetMessageEmailSentMessage\_stdWrap
520
521    Data type
522          array
523
524    Description
525          stdWrap for message that password reset mail was sent
526
527    Default
528          wrap = <div>\|</div>
529
530
531
532 .. _changepasswordnotvalidmessage-stdwrap:
533
534 changePasswordNotValidMessage\_stdWrap
535 """"""""""""""""""""""""""""""""""""""
536
537 .. container:: table-row
538
539    Property
540          changePasswordNotValidMessage\_stdWrap
541
542    Data type
543          array
544
545    Description
546          stdWrap for message that changed password was not valid
547
548    Default
549          wrap = <div>\|</div>
550
551
552
553 .. _changepasswordtooshortmessage-stdwrap:
554
555 changePasswordTooShortMessage\_stdWrap
556 """"""""""""""""""""""""""""""""""""""
557
558 .. container:: table-row
559
560    Property
561          changePasswordTooShortMessage\_stdWrap
562
563    Data type
564          array
565
566    Description
567          stdWrap for message that new password was too short
568
569    Default
570          wrap = <div>\|</div>
571
572
573
574 .. _changepasswordnotequalmessage-stdwrap:
575
576 changePasswordNotEqualMessage\_stdWrap
577 """"""""""""""""""""""""""""""""""""""
578
579 .. container:: table-row
580
581    Property
582          changePasswordNotEqualMessage\_stdWrap
583
584    Data type
585
586
587    Description
588          stdWrap for message that new passwords were not equal
589
590    Default
591          wrap = <div>\|</div>
592
593
594
595 .. _changepasswordheader-stdwrap:
596
597 changePasswordHeader\_stdWrap
598 """""""""""""""""""""""""""""
599
600 .. container:: table-row
601
602    Property
603          changePasswordHeader\_stdWrap
604
605    Data type
606          array
607
608    Description
609          stdWrap for Change Password Header
610
611    Default
612          wrap = <h3>\|</h3>
613
614
615
616 .. _changepasswordmessage-stdwrap:
617
618 changePasswordMessage\_stdWrap
619 """"""""""""""""""""""""""""""
620
621 .. container:: table-row
622
623    Property
624          changePasswordMessage\_stdWrap
625
626    Data type
627          array
628
629    Description
630          stdWrap for Change Password Message
631
632    Default
633          wrap = <div>\|</div>
634
635
636
637 .. _changepassworddonemessage-stdwrap:
638
639 changePasswordDoneMessage\_stdWrap
640 """"""""""""""""""""""""""""""""""
641
642 .. container:: table-row
643
644    Property
645          changePasswordDoneMessage\_stdWrap
646
647    Data type
648          array
649
650    Description
651          stdWrap for message that password was changed
652
653    Default
654          wrap = <div>\|</div>
655
656
657
658 .. _userfields:
659
660 userfields
661 """"""""""
662
663 .. container:: table-row
664
665    Property
666          userfields
667
668    Data type
669          array
670
671    Description
672          Array of fields from the fe\_users table. Each field can have its own
673          stdWrap configuration. These fields can be used as markers in the
674          template (e.g. ###FEUSER\_USERNAME###)
675
676    Default
677          ::
678
679             username {
680                 htmlSpecialChars = 1
681                 wrap = <strong>\|</strong>
682             }
683
684
685
686 .. _redirectmode:
687
688 redirectMode
689 """"""""""""
690
691 .. container:: table-row
692
693    Property
694          redirectMode
695
696    Data type
697          string
698
699    Description
700          Comma separated list of redirect modes. Possible values:
701
702          groupLogin, userLogin, login, getpost, referer, refererDomains,
703          loginError, logout
704
705          See section on redirect modes for details.
706
707
708
709 .. _redirectfirstmethod:
710
711 redirectFirstMethod
712 """""""""""""""""""
713
714 .. container:: table-row
715
716    Property
717          redirectFirstMethod
718
719    Data type
720          bool
721
722    Description
723          If set the first method from redirectMode which is possible will be
724          used
725
726
727
728 .. _redirectpagelogin:
729
730 redirectPageLogin
731 """""""""""""""""
732
733 .. container:: table-row
734
735    Property
736          redirectPageLogin
737
738    Data type
739          integer
740
741    Description
742          Page id to redirect to after Login
743
744
745
746 .. _redirectpageloginerror:
747
748 redirectPageLoginError
749 """"""""""""""""""""""
750
751 .. container:: table-row
752
753    Property
754          redirectPageLoginError
755
756    Data type
757          integer
758
759    Description
760          Page id to redirect to after Login Error
761
762
763
764 .. _redirectpagelogout:
765
766 redirectPageLogout
767 """"""""""""""""""
768
769 .. container:: table-row
770
771    Property
772          redirectPageLogout
773
774    Data type
775          integer
776
777    Description
778          Page id to redirect to after Logout
779
780
781
782 .. _redirectdisable:
783
784 redirectDisable
785 """""""""""""""
786
787 .. container:: table-row
788
789    Property
790          redirectDisable
791
792    Data type
793          bool
794
795    Description
796          If set redirecting is disabled
797
798
799
800 .. _email-from:
801
802 email\_from
803 """""""""""
804
805 .. container:: table-row
806
807    Property
808          email\_from
809
810    Data type
811          string
812
813    Description
814          Email address used as sender of the change password emails
815
816
817
818 .. _email-fromname:
819
820 email\_fromName
821 """""""""""""""
822
823 .. container:: table-row
824
825    Property
826          email\_fromName
827
828    Data type
829          string
830
831    Description
832          Name used as sender of the change password emails
833
834
835
836 .. _replyto:
837
838 replyTo
839 """""""
840
841 .. container:: table-row
842
843    Property
844          replyTo
845
846    Data type
847          string
848
849    Description
850          Reply-to address used in the change password emails
851
852
853
854 .. _domains:
855
856 domains
857 """""""
858
859 .. container:: table-row
860
861    Property
862          domains
863
864    Data type
865          string
866
867    Description
868          Comma separated list of domains which are allowed for the referrer
869          redirect mode
870
871
872
873 .. _dateformat:
874
875 dateFormat
876 """"""""""
877
878 .. container:: table-row
879
880    Property
881          dateFormat
882
883    Data type
884          date-conf
885
886    Description
887          Format for the link is valid until message (forget password email)
888
889    Default
890          Y-m-d H:i
891
892
893
894 .. _linkprefix:
895
896 linkPrefix
897 """"""""""
898
899 .. container:: table-row
900
901    Property
902          linkPrefix
903
904    Data type
905          string
906
907    Description
908          Prefix for the link sent in the forgot password email
909
910
911
912 .. _exposenonexistentuserinforgotpassworddialog:
913
914 exposeNonexistentUserInForgotPasswordDialog
915 """""""""""""""""""""""""""""""""""""""""""
916
917 .. container:: table-row
918
919    Property
920          exposeNonexistentUserInForgotPasswordDialog
921
922    Data type
923          bool
924
925    Description
926          If set and the user account cannot be found in the forgot password
927          dialogue, an error message will be shown that the account could not be
928          found.
929
930          .. warning::
931
932             Enabling this will disclose information about whether an
933             email address is actually used for a frontend user account! Visitors
934             can find out if a user is known as frontend user.
935
936    Default
937          0
938
939
940
941 .. _css-default-style:
942
943 \_CSS\_DEFAULT\_STYLE
944 """""""""""""""""""""
945
946 .. container:: table-row
947
948    Property
949          \_CSS\_DEFAULT\_STYLE
950
951    Data type
952          string
953
954    Description
955          CSS included in the page containing the login form
956
957    Default
958          ::
959
960             .tx-felogin-pi1 label {
961                 display: block;
962             }
963
964
965 .. _default-pi-vars:
966
967 \_DEFAULT\_PI\_VARS
968 """""""""""""""""""
969
970 .. container:: table-row
971
972    Property
973          \_DEFAULT\_PI\_VARS
974
975    Data type
976          array
977
978    Description
979          Default values for variables sent from the forms.
980
981
982 .. _local-lang:
983
984 \_LOCAL\_LANG
985 """""""""""""
986
987 .. container:: table-row
988
989    Property
990          \_LOCAL\_LANG (+ "." + "default" or language code)
991
992    Data type
993          array
994
995    Description
996          Localized labels that can be overridden per TypoScript.
997
998          =========================================== =================================
999          Label                                       Usage
1000          =========================================== =================================
1001          ll\_welcome\_header                         Status header
1002          ll\_welcome\_message                        Status message
1003          ll\_logout\_header                          Status header
1004          ll\_logout\_message                         Status message
1005          ll\_error\_header                           Status header
1006          ll\_error\_message                          Status message
1007          ll\_success\_header                         Status header
1008          ll\_success\_message                        Status message
1009          ll\_status\_header                          Status header
1010          ll\_status\_message                         Status message
1011          cookie\_warning                             Warning when no cookie can be set
1012          username                                    Form field label
1013          password                                    Form field label
1014          login                                       Legend, form field label
1015          permalogin                                  Form field label
1016          logout                                      Legend, submit button
1017          send\_password                              Submit button
1018          reset\_password                             Legend, submit button
1019          ll\_change\_password\_header                Status header
1020          ll\_change\_password\_message               Status message
1021          ll\_change\_password\_nolinkprefix\_message Error message
1022          ll\_change\_password\_notvalid\_message     Status message
1023          ll\_change\_password\_notequal\_message     Status message
1024          ll\_change\_password\_tooshort\_message     Status message
1025          ll\_change\_password\_done\_message         Status message
1026          change\_password                            Legend
1027          newpassword\_label1                         Form field label
1028          newpassword\_label2                         Form field label
1029          your\_email                                 Form field label
1030          ll\_forgot\_header                          Status header, link text
1031          ll\_forgot\_validate\_reset\_password       Email body
1032          ll\_forgot\_message\_emailSent              Status message
1033          ll\_forgot\_reset\_message                  Status message
1034          ll\_forgot\_reset\_message\_emailSent       Status message
1035          ll\_forgot\_reset\_message\_error           Status message
1036          ll\_forgot\_header\_backToLogin             Text of back link to loginform
1037          ll\_enter\_your\_data                       Form field label
1038          oLabel\_header\_welcome                     Legend
1039          =========================================== =================================
1040