comparison MoinMoin/config/multiconfig.py @ 3766:6a618481be28

add help texts to configuration items The display macro needs to format them as wiki still, right now the help text is shown 'raw'.
author Johannes Berg <johannes AT sipsolutions DOT net>
date Sun, 22 Jun 2008 12:23:59 +0200
parents 0284379adbc8
children 0b7f7b9226df
comparison
equal deleted inserted replaced
3765:a9c67b33a5e6 3766:6a618481be28
634 def __init__(self, exprstr): 634 def __init__(self, exprstr):
635 self.text = exprstr 635 self.text = exprstr
636 self.value = eval(exprstr) 636 self.value = eval(exprstr)
637 637
638 options_no_group_name = { 638 options_no_group_name = {
639 'session': ('Session settings', None, ( 639 'session': ('Session settings', "Session-related settings, see HelpOnSessions.", (
640 ('session_handler', DefaultExpression('session.DefaultSessionHandler()'), 640 ('session_handler', DefaultExpression('session.DefaultSessionHandler()'),
641 "See HelpOnSessions."), 641 "See HelpOnSessions."),
642 ('session_id_handler', DefaultExpression('session.MoinCookieSessionIDHandler()'), 642 ('session_id_handler', DefaultExpression('session.MoinCookieSessionIDHandler()'),
643 "Only used by the DefaultSessionHandler, see HelpOnSessions."), 643 "Only used by the DefaultSessionHandler, see HelpOnSessions."),
644 ('cookie_domain', None, None), 644 ('cookie_domain', None, None),
649 )), 649 )),
650 650
651 'various': ('Various', None, ( 651 'various': ('Various', None, (
652 ('DesktopEdition', 652 ('DesktopEdition',
653 False, 653 False,
654 'True gives all local users special powers - ONLY use for MMDE style usage!'), 654 "if True, give all local users special powers - ''only use this for a local desktop wiki!''"),
655 ('SecurityPolicy', 655 ('SecurityPolicy',
656 None, 656 None,
657 None), 657 "Class object hook for implementing security restrictions"),
658 658
659 ('actions_excluded', 659 ('actions_excluded',
660 ['xmlrpc', # we do not want wiki admins unknowingly offering xmlrpc service 660 ['xmlrpc', # we do not want wiki admins unknowingly offering xmlrpc service
661 'MyPages', # only works when used with a non-default SecurityPolicy (e.g. autoadmin) 661 'MyPages', # only works when used with a non-default SecurityPolicy (e.g. autoadmin)
662 'CopyPage', # has questionable behaviour regarding subpages a user can't read, but can copy 662 'CopyPage', # has questionable behaviour regarding subpages a user can't read, but can copy
663 ], 663 ],
664 None), 664 "Exclude unwanted actions (list of strings)"),
665 665
666 ('allow_xslt', False, None), 666 ('allow_xslt', False,
667 ('antispam_master_url', "http://master.moinmo.in/?action=xmlrpc2", None), 667 "if True, enables XSLT processing via 4Suite (note that this enables anyone with enough know-how to insert '''arbitrary HTML''' into your wiki, which is why it defaults to `False`)"),
668 ('auth', DefaultExpression('[MoinAuth()]'), None), 668 ('antispam_master_url', "http://master.moinmo.in/?action=xmlrpc2",
669 ('auth_methods_trusted', ['http', 'xmlrpc_applytoken'], None), 669 "where antispam security policy fetches spam pattern updates (if it is enabled)"),
670 670 ('auth', DefaultExpression('[MoinAuth()]'),
671 ('bang_meta', True, None), 671 "list of auth objects, to be called in this order (see HelpOnAuthentication)"),
672 ('caching_formats', ['text_html'], None), 672 ('auth_methods_trusted', ['http', 'xmlrpc_applytoken'],
673 ('changed_time_fmt', '%H:%M', None), 673 'authentication methods for which users should be included in the special "Trusted" ACL group.'),
674 674
675 ('chart_options', None, None), 675 ('bang_meta', True, 'if True, enable {{{!NoWikiName}}} markup'),
676 ('caching_formats', ['text_html'], "output formats that are cached; set to [] to turn off caching (useful for development)"),
677 ('changed_time_fmt', '%H:%M', "Time format used on Recent``Changes for page edits within the last 24 hours"),
678
679 ('chart_options', None, "If you have gdchart, use something like chart_options = {'width': 720, 'height': 540}"),
676 680
677 ('config_check_enabled', False, None), 681 ('config_check_enabled', False, None),
678 682
679 ('data_dir', './data/', None), 683 ('data_dir', './data/', "Path to the data directory containing your (locally made) wiki pages."),
680 ('data_underlay_dir', './underlay/', None), 684 ('data_underlay_dir', './underlay/', "Path to the underlay directory containing distribution system and help pages."),
681 685
682 ('date_fmt', '%Y-%m-%d', None), 686 ('date_fmt', '%Y-%m-%d', "System date format, used mostly in Recent``Changes"),
683 ('datetime_fmt', '%Y-%m-%d %H:%M:%S', None), 687 ('datetime_fmt', '%Y-%m-%d %H:%M:%S', 'Default format for dates and times (when the user has no preferences or chose the "default" date format)'),
684 688
685 ('default_markup', 'wiki', None), 689 ('default_markup', 'wiki', 'Default page parser / format (name of module in `MoinMoin.parser`)'),
686 ('docbook_html_dir', r"/usr/share/xml/docbook/stylesheet/nwalsh/html/", None), 690 ('docbook_html_dir', r"/usr/share/xml/docbook/stylesheet/nwalsh/html/",
687 691 'Path to the directory with the Docbook to HTML XSLT files (optional, used by the docbook parser). The default value is correct for Debian Etch.'),
688 ('edit_bar', ['Edit', 'Comments', 'Discussion', 'Info', 'Subscribe', 'Quicklink', 'Attachments', 'ActionsMenu'], None), 692
689 ('editor_default', 'text', None), 693 ('edit_bar', ['Edit', 'Comments', 'Discussion', 'Info', 'Subscribe', 'Quicklink', 'Attachments', 'ActionsMenu'],
690 ('editor_force', False, None), 694 'list of edit bar entries'),
691 ('editor_ui', 'freechoice', None), 695 ('editor_default', 'text', "Editor to use by default, 'text' or 'gui'"),
696 ('editor_force', False, "if True, force using the default editor"),
697 ('editor_ui', 'freechoice', "Editor choice shown on the user interface, 'freechoice' or 'theonepreferred'"),
692 ('editor_quickhelp', { 698 ('editor_quickhelp', {
693 # editor markup hints quickhelp 699 # editor markup hints quickhelp
694 # MUST be in wiki markup, even if the help is not for the wiki parser! 700 # MUST be in wiki markup, even if the help is not for the wiki parser!
695 'wiki': _(u"""\ 701 'wiki': _(u"""\
696 Emphasis:: <<Verbatim('')>>''italics''<<Verbatim('')>>; <<Verbatim(''')>>'''bold'''<<Verbatim(''')>>; <<Verbatim(''''')>>'''''bold italics'''''<<Verbatim(''''')>>; <<Verbatim('')>>''mixed ''<<Verbatim(''')>>'''''bold'''<<Verbatim(''')>> and italics''<<Verbatim('')>>; <<Verbatim(----)>> horizontal rule. 702 Emphasis:: <<Verbatim('')>>''italics''<<Verbatim('')>>; <<Verbatim(''')>>'''bold'''<<Verbatim(''')>>; <<Verbatim(''''')>>'''''bold italics'''''<<Verbatim(''''')>>; <<Verbatim('')>>''mixed ''<<Verbatim(''')>>'''''bold'''<<Verbatim(''')>> and italics''<<Verbatim('')>>; <<Verbatim(----)>> horizontal rule.
728 Links:: <<Verbatim([[target]])>>; <<Verbatim([[target|linktext]])>>. 734 Links:: <<Verbatim([[target]])>>; <<Verbatim([[target|linktext]])>>.
729 Tables:: |= header text | cell text | more cell text |; 735 Tables:: |= header text | cell text | more cell text |;
730 736
731 (!) For more help, see HelpOnEditing or HelpOnCreoleSyntax. 737 (!) For more help, see HelpOnEditing or HelpOnCreoleSyntax.
732 """), 738 """),
733 }, None), 739 },
734 ('edit_locking', 'warn 10', None), 740 "Quickhelp provided at the bottom of edit pages. To customize, specify a dictionary with key matching default_markup (e.g. 'wiki') and give a string value containing wiki markup."),
741 ('edit_locking', 'warn 10', "Editor locking policy: `None`, `'warn <timeout in minutes>'`, or `'lock <timeout in minutes>'`"),
735 ('edit_ticketing', True, None), 742 ('edit_ticketing', True, None),
736 ('edit_rows', 20, None), 743 ('edit_rows', 20, "Default height of the edit box"),
737 744
738 ('history_count', (100, 200), None), 745 ('history_count', (100, 200), "number of revisions shown for info/history action (default_count_shown, max_count_shown)"),
739 746
740 ('hosts_deny', [], None), 747 ('hosts_deny', [], "List of denied IPs; if an IP ends with a dot, it denies a whole subnet (class A, B or C)"),
741 748
742 ('html_head', '', None), 749 ('html_head', '', "Additional <HEAD> tags, see HelpOnThemes."),
743 ('html_head_queries', '''<meta name="robots" content="noindex,nofollow">\n''', None), 750 ('html_head_queries', '''<meta name="robots" content="noindex,nofollow">\n''', None),
744 ('html_head_posts', '''<meta name="robots" content="noindex,nofollow">\n''', None), 751 ('html_head_posts', '''<meta name="robots" content="noindex,nofollow">\n''', None),
745 ('html_head_index', '''<meta name="robots" content="index,follow">\n''', None), 752 ('html_head_index', '''<meta name="robots" content="index,follow">\n''', None),
746 ('html_head_normal', '''<meta name="robots" content="index,nofollow">\n''', None), 753 ('html_head_normal', '''<meta name="robots" content="index,nofollow">\n''', None),
747 ('html_pagetitle', None, None), 754 ('html_pagetitle', None, "Allows you to set a specific HTML page title (if None, it defaults to the value of `sitename`)"),
748 755
749 ('interwikiname', None, None), 756 ('interwikiname', None, "InterWiki name (prefix, moniker) of the site, or None"),
750 ('interwiki_preferred', [], None), 757 ('interwiki_preferred', [], "In dialogues, show those wikis at the top of the list."),
751 758
752 ('language_default', 'en', None), 759 ('language_default', 'en', "Default language for user interface and page content, see HelpOnLanguages."),
753 ('language_ignore_browser', False, None), 760 ('language_ignore_browser', False, "if True, ignore user's browser language settings, see HelpOnLanguages."),
754 761
755 ('logo_string', None, None), 762 ('logo_string', None, "The wiki logo top of page, HTML is allowed (`<img>` is possible as well) [Unicode]"),
756 763
757 ('log_reverse_dns_lookups', True, None), 764 ('log_reverse_dns_lookups', True,
758 ('log_timing', False, None), 765 "if True, do a reverse DNS lookup on page SAVE. If your DNS is broken, set this to False to speed up SAVE."),
766 ('log_timing', False,
767 "if True, add timing infos to the log output to analyse load conditions"),
759 768
760 # some dangerous mimetypes (we don't use "content-disposition: inline" for them when a user 769 # some dangerous mimetypes (we don't use "content-disposition: inline" for them when a user
761 # downloads such attachments, because the browser might execute e.g. Javascript contained 770 # downloads such attachments, because the browser might execute e.g. Javascript contained
762 # in the HTML and steal your moin session cookie or do other nasty stuff) 771 # in the HTML and steal your moin session cookie or do other nasty stuff)
763 ('mimetypes_xss_protect', 772 ('mimetypes_xss_protect',
764 [ 773 [
765 'text/html', 774 'text/html',
766 'application/x-shockwave-flash', 775 'application/x-shockwave-flash',
767 'application/xhtml+xml', 776 'application/xhtml+xml',
768 ], None), 777 ],
778 '"content-disposition: inline" isn\'t used for them when a user downloads such attachments'),
769 779
770 ('mimetypes_embed', 780 ('mimetypes_embed',
771 [ 781 [
772 'application/x-dvi', 782 'application/x-dvi',
773 'application/postscript', 783 'application/postscript',
785 'video/mpeg', 795 'video/mpeg',
786 'video/quicktime', 796 'video/quicktime',
787 'video/x-msvideo', 797 'video/x-msvideo',
788 'chemical/x-pdb', 798 'chemical/x-pdb',
789 'x-world/x-vrml', 799 'x-world/x-vrml',
790 ], None), 800 ],
791 801 'mimetypes that can be embedded by the [[HelpOnMacros/EmbedObject|EmbedObject macro]]'),
792 802
793 ('navi_bar', [u'RecentChanges', u'FindPage', u'HelpContents', ], None), 803
804 ('navi_bar', [u'RecentChanges', u'FindPage', u'HelpContents', ],
805 'Most important page names. Users can add more names in their quick links in user preferences. To link to URL, use `u"[url link title]"`, to use a shortened name for long page name, use `u"[LongLongPageName title]"`. To use page names with spaces, use `u"[page_name_with_spaces any title]"` [list of Unicode strings]'),
794 806
795 ('notification_bot_uri', None, None), 807 ('notification_bot_uri', None, None),
796 808
797 ('page_credits', 809 ('page_credits',
798 [ 810 [
799 '<a href="http://moinmo.in/" title="This site uses the MoinMoin Wiki software.">MoinMoin Powered</a>', 811 '<a href="http://moinmo.in/" title="This site uses the MoinMoin Wiki software.">MoinMoin Powered</a>',
800 '<a href="http://moinmo.in/Python" title="MoinMoin is written in Python.">Python Powered</a>', 812 '<a href="http://moinmo.in/Python" title="MoinMoin is written in Python.">Python Powered</a>',
801 '<a href="http://moinmo.in/GPL" title="MoinMoin is GPL licensed.">GPL licensed</a>', 813 '<a href="http://moinmo.in/GPL" title="MoinMoin is GPL licensed.">GPL licensed</a>',
802 '<a href="http://validator.w3.org/check?uri=referer" title="Click here to validate this page.">Valid HTML 4.01</a>', 814 '<a href="http://validator.w3.org/check?uri=referer" title="Click here to validate this page.">Valid HTML 4.01</a>',
803 ], None), 815 ],
816 'list with html fragments with logos or strings for crediting.'),
804 817
805 ('page_footer1', '', None), 818 ('page_footer1', '', None),
806 ('page_footer2', '', None), 819 ('page_footer2', '', None),
807 ('page_header1', '', None), 820 ('page_header1', '', None),
808 ('page_header2', '', None), 821 ('page_header2', '', None),
809 822
810 ('page_front_page', u'HelpOnLanguages', None), 823 ('page_front_page', u'HelpOnLanguages',
811 ('page_local_spelling_words', u'LocalSpellingWords', None), 824 "Name of the front page. We don't expect you to keep the default. Just read HelpOnLanguages in case you're wondering... [Unicode]"),
825 ('page_local_spelling_words', u'LocalSpellingWords',
826 'Name of the page containing user-provided spellchecker words [Unicode]'),
812 827
813 # the following regexes should match the complete name when used in free text 828 # the following regexes should match the complete name when used in free text
814 # the group 'all' shall match all, while the group 'key' shall match the key only 829 # the group 'all' shall match all, while the group 'key' shall match the key only
815 # e.g. CategoryFoo -> group 'all' == CategoryFoo, group 'key' == Foo 830 # e.g. CategoryFoo -> group 'all' == CategoryFoo, group 'key' == Foo
816 # moin's code will add ^ / $ at beginning / end when needed 831 # moin's code will add ^ / $ at beginning / end when needed
817 ('page_category_regex', ur'(?P<all>Category(?P<key>\S+))', None), 832 ('page_category_regex', ur'(?P<all>Category(?P<key>\S+))',
818 ('page_dict_regex', ur'(?P<all>(?P<key>\S+)Dict)', None), 833 'Pagenames exactly matching this regex are regarded as Wiki categories [Unicode]'),
819 ('page_group_regex', ur'(?P<all>(?P<key>\S+)Group)', None), 834 ('page_dict_regex', ur'(?P<all>(?P<key>\S+)Dict)',
820 ('page_template_regex', ur'(?P<all>(?P<key>\S+)Template)', None), 835 'Pagenames exactly matching this regex are regarded as pages containing variable dictionary definitions [Unicode]'),
821 836 ('page_group_regex', ur'(?P<all>(?P<key>\S+)Group)',
822 ('page_license_enabled', False, None), 837 'Pagenames exactly matching this regex are regarded as pages containing group definitions [Unicode]'),
823 ('page_license_page', u'WikiLicense', None), 838 ('page_template_regex', ur'(?P<all>(?P<key>\S+)Template)',
839 'Pagenames exactly matching this regex are regarded as pages containing templates for new pages [Unicode]'),
840
841 ('page_license_enabled', False, 'if True, show a license hint in page editor.'),
842 ('page_license_page', u'WikiLicense', 'Page linked from the license hint. [Unicode]'),
824 843
825 # These icons will show in this order in the iconbar, unless they 844 # These icons will show in this order in the iconbar, unless they
826 # are not relevant, e.g email icon when the wiki is not configured 845 # are not relevant, e.g email icon when the wiki is not configured
827 # for email. 846 # for email.
828 ('page_iconbar', ["up", "edit", "view", "diff", "info", "subscribe", "raw", "print", ], None), 847 ('page_iconbar', ["up", "edit", "view", "diff", "info", "subscribe", "raw", "print", ],
848 'list of icons to show in iconbar, valid values are only those in page_icons_table. Available only in classic theme.'),
829 849
830 # Standard buttons in the iconbar 850 # Standard buttons in the iconbar
831 ('page_icons_table', 851 ('page_icons_table',
832 { 852 {
833 # key pagekey, querystr dict, title, icon-key 853 # key pagekey, querystr dict, title, icon-key
839 'raw': ('page', {'action': 'raw'}, _("Raw"), "raw"), 859 'raw': ('page', {'action': 'raw'}, _("Raw"), "raw"),
840 'xml': ('page', {'action': 'show', 'mimetype': 'text/xml'}, _("XML"), "xml"), 860 'xml': ('page', {'action': 'show', 'mimetype': 'text/xml'}, _("XML"), "xml"),
841 'print': ('page', {'action': 'print'}, _("Print"), "print"), 861 'print': ('page', {'action': 'print'}, _("Print"), "print"),
842 'view': ('page', {}, _("View"), "view"), 862 'view': ('page', {}, _("View"), "view"),
843 'up': ('page_parent_page', {}, _("Up"), "up"), 863 'up': ('page_parent_page', {}, _("Up"), "up"),
844 }, None), 864 },
845 865 "dict of {'iconname': (url, title, icon-img-key), ...}. Available only in classic theme."),
846 866
847 867
848 ('password_checker', DefaultExpression('_default_password_checker'), None), 868
849 869 ('password_checker', DefaultExpression('_default_password_checker'),
850 ('quicklinks_default', [], None), 870 'checks whether a password is acceptable (default check is length >= 6, at least 4 different chars, no keyboard sequence, not username used somehow (you can switch this off by using `None`)'),
851 871
852 ('refresh', None, None), 872 ('quicklinks_default', [],
853 ('rss_cache', 60, None), 873 'List of preset quicklinks for a newly created user accounts. Existing accounts are not affected by this option whereas changes in navi_bar do always affect existing accounts. Preset quicklinks can be removed by the user in the user preferences menu, navi_bar settings not.'),
854 874
855 ('search_results_per_page', 25, None), 875 ('refresh', None,
856 876 "refresh = (minimum_delay_s, targets_allowed) enables use of `#refresh 5 PageName` processing instruction, targets_allowed must be either `'internal'` or `'external'`"),
857 ('shared_intermap', None, None), 877 ('rss_cache', 60, "suggested caching time for Recent''''''Changes RSS, in second"),
858 878
859 ('show_hosts', True, None), 879 ('search_results_per_page', 25, "Number of hits shown per page in the search results"),
860 ('show_interwiki', False, None), 880
861 ('show_names', True, None), 881 ('shared_intermap', None,
862 ('show_section_numbers', 0, None), 882 "Path to a file containing global InterWiki definitions (or a list of such filenames)"),
863 ('show_timings', False, None), 883
864 ('show_version', False, None), 884 ('show_hosts', True,
865 885 "if True, show host names and IPs. Set to False to hide them."),
866 ('sistersites', [], None), 886 ('show_interwiki', False,
887 "if True, let the theme display your interwiki name"),
888 ('show_names', True,
889 "if True, show user names in the revision history and on Recent``Changes. Set to False to hide them."),
890 ('show_section_numbers', False,
891 'show section numbers in headings by default'),
892 ('show_timings', False, "show some timing values at bottom of a page"),
893 ('show_version', False, "show moin's version at the bottom of a page"),
894
895 ('sistersites', [], "list of tuples `('WikiName', 'sisterpagelist_fetch_url')`"),
867 896
868 ('siteid', 'default', None), 897 ('siteid', 'default', None),
869 ('sitename', u'Untitled Wiki', None), 898 ('sitename', u'Untitled Wiki',
870 899 "Short description of your wiki site, displayed below the logo on each page, and used in RSS documents as the channel title [Unicode]"),
871 ('stylesheets', [], None), 900
872 901 ('stylesheets', [],
873 ('subscribed_pages_default', [], None), 902 "List of tuples (media, csshref) to insert after theme css, before user css, see HelpOnThemes."),
903
904 ('subscribed_pages_default', [],
905 "List of pagenames used for presetting page subscriptions for newly created user accounts."),
874 ('email_subscribed_events_default', 906 ('email_subscribed_events_default',
875 [ 907 [
876 PageChangedEvent.__name__, 908 PageChangedEvent.__name__,
877 PageRenamedEvent.__name__, 909 PageRenamedEvent.__name__,
878 PageDeletedEvent.__name__, 910 PageDeletedEvent.__name__,
880 PageRevertedEvent.__name__, 912 PageRevertedEvent.__name__,
881 FileAttachedEvent.__name__, 913 FileAttachedEvent.__name__,
882 ], None), 914 ], None),
883 ('jabber_subscribed_events_default', [], None), 915 ('jabber_subscribed_events_default', [], None),
884 916
885 ('superuser', [], None), 917 ('superuser', [],
886 918 "List of trusted user names with wiki system administration super powers (not to be confused with ACL admin rights!). Used for e.g. making full backups, software installation, language installation via SystemPagesSetup and more. See also HelpOnSuperUser."),
887 ('supplementation_page', False, None), 919
888 ('supplementation_page_name', u'Discussion', None), 920 ('supplementation_page', False,
889 ('supplementation_page_template', u'DiscussionTemplate', None), 921 "if True, show a link to the supplementation page in the theme"),
922 ('supplementation_page_name', u'Discussion',
923 "default name of the supplementation (sub)page [unicode]"),
924 ('supplementation_page_template', u'DiscussionTemplate',
925 "default template used for creation of the supplementation page [unicode]"),
890 926
891 ('surge_action_limits', 927 ('surge_action_limits',
892 {# allow max. <count> <action> requests per <dt> secs 928 {# allow max. <count> <action> requests per <dt> secs
893 # action: (count, dt) 929 # action: (count, dt)
894 'all': (30, 30), 930 'all': (30, 30),
899 'diff': (30, 60), 935 'diff': (30, 60),
900 'fullsearch': (10, 120), 936 'fullsearch': (10, 120),
901 'edit': (30, 300), # can be lowered after making preview different from edit 937 'edit': (30, 300), # can be lowered after making preview different from edit
902 'rss_rc': (1, 60), 938 'rss_rc': (1, 60),
903 'default': (30, 60), 939 'default': (30, 60),
904 }, None), 940 },
941 "Surge protection tries to deny clients causing too much load/traffic, see /SurgeProtection."),
905 ('surge_lockout_time', 3600, None), 942 ('surge_lockout_time', 3600, None),
906 943
907 ('textchas', None, None), 944 ('textchas', None,
945 "Spam protection setup using site-specific questions/answers, see HelpOnTextChas."),
908 ('textchas_disabled_group', None, None), 946 ('textchas_disabled_group', None, None),
909 947
910 ('theme_default', 'modern', None), 948 ('theme_default', 'modern',
911 ('theme_force', False, None), 949 "the name of the theme that is used by default (see HelpOnThemes)"),
912 950 ('theme_force', False,
913 ('traceback_show', True, None), 951 "if True, do not allow to change the theme"),
914 ('traceback_log_dir', None, None), 952
915 953 ('traceback_show', True,
916 ('trail_size', 5, None), 954 "if True, show debug tracebacks to users when moin crashes"),
917 ('tz_offset', 0.0, None), 955 ('traceback_log_dir', None,
956 "Directory to store tracebacks or None."),
957
958 ('trail_size', 5,
959 "Number of pages in the trail of visited pages"),
960 ('tz_offset', 0.0,
961 "default time zone offset in hours from UTC"),
918 962
919 # a regex of HTTP_USER_AGENTS that should be excluded from logging 963 # a regex of HTTP_USER_AGENTS that should be excluded from logging
920 # and receive a FORBIDDEN for anything except viewing a page 964 # and receive a FORBIDDEN for anything except viewing a page
921 # list must not contain 'java' because of twikidraw wanting to save drawing uses this useragent 965 # list must not contain 'java' because of twikidraw wanting to save drawing uses this useragent
922 ('ua_spiders', 966 ('ua_spiders',
923 ('archiver|cfetch|charlotte|crawler|curl|gigabot|googlebot|heritrix|holmes|htdig|httrack|httpunit|' 967 ('archiver|cfetch|charlotte|crawler|curl|gigabot|googlebot|heritrix|holmes|htdig|httrack|httpunit|'
924 'intelix|jeeves|larbin|leech|libwww-perl|linkbot|linkmap|linkwalk|litefinder|mercator|' 968 'intelix|jeeves|larbin|leech|libwww-perl|linkbot|linkmap|linkwalk|litefinder|mercator|'
925 'microsoft.url.control|mirror| mj12bot|msnbot|msrbot|neomo|nutbot|omniexplorer|puf|robot|scooter|seekbot|' 969 'microsoft.url.control|mirror| mj12bot|msnbot|msrbot|neomo|nutbot|omniexplorer|puf|robot|scooter|seekbot|'
926 'sherlock|slurp|sitecheck|snoopy|spider|teleport|twiceler|voilabot|voyager|webreaper|wget|yeti'), 970 'sherlock|slurp|sitecheck|snoopy|spider|teleport|twiceler|voilabot|voyager|webreaper|wget|yeti'),
927 None), 971 "A regex of HTTP_USER_AGENTs that should be excluded from logging and are not allowed to use actions."),
928 972
929 ('unzip_single_file_size', 2.0 * 1000 ** 2, None), 973 ('unzip_single_file_size', 2.0 * 1000 ** 2,
930 ('unzip_attachments_space', 200.0 * 1000 ** 2, None), 974 "max. number of files which are extracted from the zip file"),
931 ('unzip_attachments_count', 101, None), 975 ('unzip_attachments_space', 200.0 * 1000 ** 2,
932 976 "max. total amount of bytes can be used to unzip files [bytes]"),
933 ('url_mappings', {}, None), 977 ('unzip_attachments_count', 101,
978 "max. size of a single file in the archive which will be extracted [bytes]"),
979
980 ('url_mappings', {},
981 "lookup table to remap URL prefixes (dict of {{{'prefix': 'replacement'}}}); especially useful in intranets, when whole trees of externally hosted documents move around"),
934 982
935 # includes the moin version number, so we can have a unlimited cache lifetime 983 # includes the moin version number, so we can have a unlimited cache lifetime
936 # for the static stuff. if stuff changes on version upgrade, url will change 984 # for the static stuff. if stuff changes on version upgrade, url will change
937 # immediately and we have no problem with stale caches. 985 # immediately and we have no problem with stale caches.
938 ('url_prefix_static', config.url_prefix_static, None), 986 ('url_prefix_static', config.url_prefix_static,
987 "used as the base URL for icons, css, etc. - includes the moin version number and changes on every release. This replaces the deprecated and sometimes confusing `url_prefix = '/wiki'` setting."),
939 ('url_prefix_local', None, None), 988 ('url_prefix_local', None, None),
940 989
941 # we could prefix actions to be able to exclude them by robots.txt: 990 # we could prefix actions to be able to exclude them by robots.txt:
942 #url_prefix_action', 'action' # no leading or trailing '/' 991 #url_prefix_action', 'action' # no leading or trailing '/'
943 ('url_prefix_action', None, None), 992 ('url_prefix_action', None,
993 "Use 'action' to enable action URL generation to be compatible with robots.txt. It will generate .../action/info/PageName?action=info then. Recommended for internet wikis."),
944 994
945 # allow disabling certain userpreferences plugins 995 # allow disabling certain userpreferences plugins
946 ('userprefs_disabled', [], None), 996 ('userprefs_disabled', [],
997 "Disable the listed user preferences plugins."),
947 )), 998 )),
948 } 999 }
949 1000
950 options = { 1001 options = {
951 'acl': ('Access control lists', None, ( 1002 'acl': ('Access control lists', None, (
954 ('rights_before', u"", None), 1005 ('rights_before', u"", None),
955 ('rights_after', u"", None), 1006 ('rights_after', u"", None),
956 ('rights_valid', ['read', 'write', 'delete', 'revert', 'admin'], None), 1007 ('rights_valid', ['read', 'write', 'delete', 'revert', 'admin'], None),
957 )), 1008 )),
958 1009
959 'xapian': ('Xapian search', None, ( 1010 'xapian': ('Xapian search', "Configuration of the Xapian based indexed search, see HelpOnXapian.", (
960 ('search', False, None), 1011 ('search', False, None),
961 ('index_dir', None, None), 1012 ('index_dir', None, None),
962 ('stemming', False, None), 1013 ('stemming', False, None),
963 ('index_history', False, None), 1014 ('index_history', False, None),
964 )), 1015 )),
965 1016
966 'user': ('Users / User settings', None, ( 1017 'user': ('Users / User settings', None, (
967 ('autocreate', False, None), 1018 ('autocreate', False,
968 ('email_unique', True, None), 1019 "if True, user accounts are created automatically (see HelpOnAuthentication)."),
969 ('jid_unique', True, None), 1020 ('email_unique', True,
970 1021 "if True, check email addresses for uniqueness and don't accept duplicates."),
971 ('homewiki', 'Self', None), 1022 ('jid_unique', True,
1023 "if True, check Jabber IDs for uniqueness and don't accept duplicates."),
1024
1025 ('homewiki', 'Self',
1026 "interwiki name of the wiki where the user home pages are located (useful if you have ''many'' users). You could even link to nonwiki \"user pages\" if the wiki username is in the target URL."),
972 1027
973 ('checkbox_fields', 1028 ('checkbox_fields',
974 [ 1029 [
975 ('mailto_author', lambda _: _('Publish my email (not my wiki homepage) in author info')), 1030 ('mailto_author', lambda _: _('Publish my email (not my wiki homepage) in author info')),
976 ('edit_on_doubleclick', lambda _: _('Open editor on double click')), 1031 ('edit_on_doubleclick', lambda _: _('Open editor on double click')),
987 ('disabled', lambda _: _('Disable this account forever')), 1042 ('disabled', lambda _: _('Disable this account forever')),
988 # if an account is disabled, it may be used for looking up 1043 # if an account is disabled, it may be used for looking up
989 # id -> username for page info and recent changes, but it 1044 # id -> username for page info and recent changes, but it
990 # is not usable for the user any more: 1045 # is not usable for the user any more:
991 ], 1046 ],
992 None), 1047 "Describes user preferences, see /UserPreferences."),
993 1048
994 ('checkbox_defaults', 1049 ('checkbox_defaults',
995 { 1050 {
996 'mailto_author': 0, 1051 'mailto_author': 0,
997 'edit_on_doubleclick': 0, 1052 'edit_on_doubleclick': 0,
1003 'show_topbottom': 0, 1058 'show_topbottom': 0,
1004 'show_fancy_diff': 1, 1059 'show_fancy_diff': 1,
1005 'wikiname_add_spaces': 0, 1060 'wikiname_add_spaces': 0,
1006 'remember_me': 1, 1061 'remember_me': 1,
1007 }, 1062 },
1008 None), 1063 "Defaults for user preferences, see /UserPreferences."),
1009 1064
1010 ('checkbox_disable', [], None), 1065 ('checkbox_disable', [],
1011 1066 "Disable user preferences, see /UserPreferences."),
1012 ('checkbox_remove', [], None), 1067
1068 ('checkbox_remove', [],
1069 "Remove user preferences, see /UserPreferences."),
1013 1070
1014 ('form_fields', 1071 ('form_fields',
1015 [ 1072 [
1016 ('name', _('Name'), "text", "36", _("(Use FirstnameLastname)")), 1073 ('name', _('Name'), "text", "36", _("(Use FirstnameLastname)")),
1017 ('aliasname', _('Alias-Name'), "text", "36", ''), 1074 ('aliasname', _('Alias-Name'), "text", "36", ''),