Administration Hints + Help
- XWiki
- Requirements
- Completed
Ecaterina Moraru (Valica)- [Investigation] Administration Hints http://markmail.org/thread/xikstktyy2h7j4se (Jun 24, 2014)
Description
The purpose of this proposal is to standardise the way we provide documentation hints throughout the wiki (Administration, Profile, etc.)
There are several approaches:
- providing the translation keys inside ApplicationResources.properties
- providing a Translations page per application
- providing local-internal documentation page
Issues
Failed to execute the [groovy] macro. Cause: [startup failed: Script5720.groovy: 14: unable to resolve class XmlParser @ line 14, column 12. def xml = new XmlParser().parseText(cont) ^ 1 error ]. Click on this message for details.
Failed to execute the [groovy] macro. Cause: [startup failed: Script5721.groovy: 14: unable to resolve class XmlParser @ line 14, column 12. def xml = new XmlParser().parseText(cont) ^ 1 error ]. Click on this message for details.
Failed to execute the [groovy] macro. Cause: [startup failed: Script5722.groovy: 14: unable to resolve class XmlParser @ line 14, column 12. def xml = new XmlParser().parseText(cont) ^ 1 error ]. Click on this message for details.
Failed to execute the [groovy] macro. Cause: [startup failed: Script5723.groovy: 14: unable to resolve class XmlParser @ line 14, column 12. def xml = new XmlParser().parseText(cont) ^ 1 error ]. Click on this message for details.
Translations Keys Usage
| Category | Section | Sheet | Values from | Labels | Labels Translations | Hints | Hints Translations | Module | Status |
|---|---|---|---|---|---|---|---|---|---|
| Configuration | XWiki.AdminEditingSheet | XWiki.XWikiPreferences | XWiki.XWikiPreferences_editor | ApplicationResources.properties | x | x | xwiki-platform-administration | Not Done | |
| XWiki.AdminLocalizationSheet | XWiki.XWikiPreferences | XWiki.XWikiPreferences_multilingual | ApplicationResources.properties | x | x | xwiki-platform-administration | Not Done | ||
| XWiki.AdminEmailSheet | XWiki.XWikiPreferences | XWiki.XWikiPreferences_admin_email | ApplicationResources.properties | XWiki.XWikiPreferences_admin_email.hint | ApplicationResources.properties | xwiki-platform-administration | Partial | ||
| XWiki.OfficeImporterAdmin | xwiki.properties with $services.officemanager.config | xe.officeimporter.openoffice.servertype | ApplicationResources.properties | admin.ooserver.options.source | ApplicationResources.properties | xwiki-platform-office | Not Done | ||
| Look & Feel | XWiki.AdminPresentationSheet | XWiki.XWikiPreferences | XWiki.XWikiPreferences_skin | ApplicationResources.properties | x | x | xwiki-platform-administration | Not Done | |
| XWiki.AdminElementsSheet | XWiki.XWikiPreferences | XWiki.XWikiPreferences_title | ApplicationResources.properties | x | x | xwiki-platform-administration | Not Done | ||
| Panel Wizard: | Panels.PanelWizard | XWiki.XWikiPreferences | panelwizard.pagelayout | ApplicationResources.properties | panelwizard.tip | ApplicationResources.properties | xwiki-platform-panels | Partial | |
| Users & Groups | XWiki.AdminUsersSheet | XWiki.XWikiUsers | admin.users | ApplicationResources.properties | x | x | xwiki-platform-administration, xwiki-platform-user | Not Done | |
| XWiki.AdminGroupsSheet | XWiki.XWikiGroups | xe.admin.groups.groupname | ApplicationResources.properties | x | x | xwiki-platform-administration | Not Done | ||
| XWiki.AdminRightsSheet | XWiki.XWikiRights | rightsmanager.groups | ApplicationResources.properties | x | x | xwiki-platform-administration, xwiki-platform-web | Not Done | ||
| XWiki.AdminRegistrationSheet | XWiki.XWikiPreferences, XWiki.Registration | XWiki.XWikiPreferences_use_email_verification | ApplicationResources.properties | x | xwiki-platform-administration | Not Done | |||
| XWiki.AdminUserProfileSheet | XWiki.UserProfileSectionClass | platform.user.profileConfigureSectionsLabel | ApplicationResources.properties | platform.user.profileConfigureSectionsHint | ApplicationResources.properties | xwiki-platform-user | Done | ||
| Content | XWiki.AdminImportSheet | - | import | ApplicationResources.properties | x | x | xwiki-platform-administration, xwiki-platform-web | Not Done | |
| XWiki.AdminExportSheet | - | export_packagename | ApplicationResources.properties | x | x | xwiki-platform-administration, xwiki-platform-web | Not Done | ||
| XWiki.AdminTemplatesSheet | XWiki.TemplateProviderClass | admin.templates.createprovider | ApplicationResources.properties | x | x | xwiki-platform-administration | Not Done | ||
| Extension Manager | XWiki.AddExtensions | Extensions | admin.xwiki.addextensions | ApplicationResources.properties | x | x | xwiki-platform-extension | Not Done | |
| XWiki.InstalledExtensions | Extensions | include reference="AddExtensions" | ApplicationResources.properties | x | x | xwiki-platform-extension | Not Done | ||
| XWiki.CoreExtensions | Extensions | include reference="AddExtensions" | ApplicationResources.properties | x | x | xwiki-platform-extension | Not Done | ||
| XWiki.ExtensionUpdater | Extensions | platform.extension.updater.checkForUpdates | ApplicationResources.properties | x | x | xwiki-platform-extension | Not Done | ||
| Applications | WikiManager.AdminWikisSheet | - | admin.wikis.template | WikiManager.Translations | x | x | xwiki-platform-wiki | Not Done | |
| XWiki.WysiwygEditorConfigSheet | XWiki.WysiwygEditorConfigClass | wysiwyg.admin.widgets.sortableList.add | ApplicationResources.properties | wysiwyg.admin.plugins.add.hint | ApplicationResources.properties | xwiki-platform-wysiwyg | Done | ||
| XWiki.MessageStreamConfig | XWiki.MessageStreamConfig | XWiki.MessageStreamConfig_active | ApplicationResources.properties | x | x | xwiki-platform-messagestream | Not Done | ||
| XWiki.LoggingAdmin | - | logging.admin.livetable.actions.set | ApplicationResources.properties | logging.admin.intro | ApplicationResources.properties | xwiki-platform-logging | Partial | ||
| Invitation.InvitationConfig | Invitation.WebHome | xe.invitation.configuration.smtpHeading | ApplicationResources.properties | x | x | xwiki-platform-invitation | Not Done | ||
| AnnotationCode.AnnotationConfigSheet | AnnotationCode.AnnotationConfig | annotations.config.activate.title | AnnotationCode.Translations | annotations.config.activate.explanation | AnnotationCode.Translations | xwiki-platform-annotations | Partial | ||
| XWiki.SearchAdmin | XWiki.SearchConfigClass, - | XWiki.SearchConfigClass_engine | ApplicationResources.properties, Main.SolrTranslations | search.admin.configuration.seexwikicfg | ApplicationResources.properties, Main.SolrTranslations | xwiki-platform-search, xwiki-platform-search-solr, xwiki-platform-search-lucene | Partial | ||
| XWiki.SearchSuggestConfigSheet | XWiki.SearchSuggestConfig, XWiki.SearchSuggestSourceClass | platform.search.suggestSources | ApplicationResources.properties | XWiki.SearchSuggestSourceClass_name.hint | ApplicationResources.properties | xwiki-platform-search | Partial | ||
| XWiki.GoogleAnalyticsCode | XWiki.GoogleAnalyticsCode | admin.analytics | ApplicationResources.properties | admin.analytics.method.description | ApplicationResources.properties | xwiki-platform-administration | Done |
Profile
See User Roles proposal.
Key Proposal
| Section | Label Value | Hint Value | Label Key | Hint Key | Default Value | Deprecate Label |
|---|---|---|---|---|---|---|
| Default Editor | The selected editor will be the default one when editing a page | Wysiwyg | ||||
| Default document syntax | The selected syntax will be used for all the new created pages | XWiki 2.1 | ||||
| Make document title field mandatory | A- Each time a new page is created, the page will not saved until a title is given B - No page will be saved until a title is given | No | ||||
| Enable version summaries | A- Allow entering a message when creating a new page version B- Allow entering a message to be displayed in the history tab when saving a page | --- (Yes) | ||||
| Make version summaries mandatory | A- For each change made, the page will not be saved until a message is given B- If version summaries is enabled, the page will not be saved until a version summary message is given | --- (No) | ||||
| Enable minor edits | A- Allow pages to have major (x.1) and minor (1.x) versions. B- Allow pages to have major (x.1) and minor (1.x) versions. Minor versions can be seen using "show minor edits" button in the history tab. | --- (Yes) | ||||
| Multilingual | A- The interface and page versions can be written in multiple languages. If the selected value is "No", the default language of the wiki will be in English B- The interface and pages can be written in multiple languages. UI language and content language can't be dissociate. If the selected value is "No", the default language of the wiki will be in English. If you see a page using "Default" language it means that it has been created without any language. | No | ||||
| Supported Languages | A- Enter the supported languages separated by commas, example "en, fr, de, es" B- Enter the supported languages separated by commas, example "en, fr, de, es". The full list can be found on http://platform.xwiki.org/xwiki/bin/view/Features/I18N | en | ||||
| Default Language | Define the default language of the wiki. | en | ||||
| Date format | A- Define the format of the dates, example "yyyy-MM-dd'T'HH:mm:ss'Z'" B- Define the format of the dates, example "yyyy-MM-dd'T'HH:mm:ss'Z'". More information about Java SimpleDateFormat on http://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html | N/A | ||||
| Timezone | Globally set the timezone for the dates | System Default | ||||
| Internationalization Document Bundles | Comma separated values for local page names that contain translations keys, example "Space1.Translations1, Space2.Translations2" | N/A | ||||
| Server | Specify the server username, example "mail.yourdomain.com" | N/A | ||||
| Port | Specify the server port | N/A | ||||
| Server Username | Enter additional username credential needed in order to access the server | N/A | ||||
| Server Password | Enter additional password credential needed in order to access the server | N/A | ||||
| Additional JavaMail Properties | A- Enter additional JavaMail properties, examples "mail.smtp.starttls.enable", "mail.smtp.auth", "mail.smtp.localhost" B- Enter additional JavaMail properties, examples "mail.smtp.starttls.enable", "mail.smtp.auth", "mail.smtp.localhost". More info at https://javamail.java.net/nonav/docs/api/ | N/A | ||||
| Server Type | Type of the OpenOffice server instance used by OfficeImporter component | |||||
| Server Port | Port number used for connecting to the OpenOffice server instance | |||||
| Auto Start | Specify if the OpenOffice server should be started / connected at start | |||||
| Server Path | Path to OpenOffice installation | |||||
| Server Profile | ||||||
| Server State | ||||||
| Skin | Specify the default skin used. It can be a filesystem skin, example flamingo, or a custom page skin, example "XWiki.DefaultSkin" | XWiki.DefaultSkin | ||||
| Stylesheet | Specify the default stylesheet used by the skin, example "style.css" | style.css | ||||
| Stylesheets | A- Specify a list of mutually exclusive alternate stylesheets B-Specify a list of mutually exclusive alternate stylesheets, example "style2.css, style_projectX.css" | style.css | ||||
| Color Theme | A- Specify the default ColorTheme used B- Specify the default ColorTheme used. You shouldn't customize the default but create a new one which will be created first as copy of the default. | Default color theme | ||||
| Title | Define the page title format as seen by browsers | $tdoc.getRenderedTitle("plain/1.0") ($doc.fullName) - XWiki | ||||
| HTTP Meta Info | Define the metadata added to each page, specifying page description, author, keywords and other metadata | <meta name="revisit-after" content="7 days" /> <meta name="description" content="$escapetool.xml($!tdoc.plainTitle)" /> #set($keywords = "wiki,$!doc.getTags()") <meta name="keywords" content="$escapetool.xml($keywords.replaceAll('[|,]', ' ').trim())" /> <meta name="distribution" content="GLOBAL" /> <meta name="rating" content="General" /> <meta name="author" content="$escapetool.xml($!xwiki.getUserName($doc.getAuthor(), false))" /> <meta http-equiv="reply-to" content="" /> <meta name="language" content="$!xcontext.language" /> ## We verify that we don't display RSS feeds on the login page since it causes problems if these feeds are ## protected. In addition it makes the login redirect to the feeds page in some cases. #if($doc.fullName | "XWiki.XWikiLogin") <link rel="alternate" type="application/rss+xml" title="Wiki Feed RSS" href="$xwiki.getURL('Main.WebRss', 'view', 'xpage=rdf')" /> <link rel="alternate" type="application/rss+xml" title="Blog RSS Feed" href="$xwiki.getURL('Blog.GlobalBlogRss', 'view', 'xpage=plain')" /> #end | |||
| Display the left panel column | Enable the display of the left side panels column | |||||
| Width of the left panel column | Choose the size of the left panels column | |||||
| Panels displayed on the left | Comma separated values of panels that will be contained by the left column. Ex: Panels.Applications, Panels.DocumentInformation | N/A | ||||
| Display the right panel column | Enable the display of the right side panels column | |||||
| Width of the right panel column | Choose the size of the right panels column | |||||
| Panels displayed on the right | Comma separated values of panels that will be contained by the right column | N/A | ||||
| Show document annotations | Display the annotations section at the page level | --- (Yes) | ||||
| Show document comments | Display the comments section at the page level | --- (Yes) | ||||
| Show document attachments | Display the attachments section at the page level | --- (Yes) | ||||
| Show document history | Display the history section at the page level | --- (Yes) | ||||
| Show document information | Display the information section at the page level | --- (Yes) | ||||
| Space copyright | Define the informations displayed in the copyright section of the footer | This wiki is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/2.0/">Creative Commons 2.0</a> license | ||||
| Version | Define the informations displayed in the version section of the footer | XWiki Enterprise $xwiki.getVersion() - <a onclick="openURL('http://enterprise.xwiki.org/xwiki/bin/view/Main/Documentation', '_blank'); return false;" href="http://www.xwiki.org/xwiki/bin/view/Main/Documentation">Documentation</a> | ||||
| Page Layout | Select one of the layout options available | |||||
| A- Manage the existing users by editing their credentials and their personal information, or by creating new users. B- Manage the existing users by editing their credentials and their personal information in using the manage column options, or by creating new users. | ||||||
| A- Manage the existing user groups by defining the membership B- Manage the existing user groups by defining the membership in using the Manage column. | ||||||
| Users to add | Select a user then use the add button | |||||
| Subgroups to add | A group included in another group is called subgroup. All member of the subgroup will be also member of the group. Select a group then use the add button. | |||||
| Manage the existing rights at user and group level. Those rights are explicit. If a right is set on an entity, all other entity with no right set will be defined as the opposite. You should consider not mixing Allow and Disallow rights in a column. | ||||||
| Use email Verification | Send an email to the user with a backlink in order to confirm his account. | --- (No) | ||||
| Authentication Active Check | [TODO] | --- (No) | ||||
| Validation email Content | ||||||
| Confirmation email Content | ||||||
| Invitation email content | ||||||
| Registration page heading | ||||||
| Welcome message | ||||||
| Enable Javascript field validation | ||||||
| Default field okay message | ||||||
| Enable login button | ||||||
| Enable automatic login | ||||||
| Redirect here after registration | ||||||
| Require captcha to register | ||||||
| Registration Successful Message | ||||||
| How to | Begin by importing a package on the page if necessary. Then select a package to install in the list of available packages. The package open on the right and let you pick multiple installation options. | |||||
| Import as backup package | This option will use the original user name from the document to import | No | ||||
| Package Name | Filename of the exported zip file | backup | ||||
| Description | Write a few word which will be displayed while importing the package | N/A | ||||
| Licence | LGPL, GPLV2, ... | N/A | ||||
| Author | Name of the author of the package. It can be a user name of the wiki | XWiki.Admin | ||||
| Version | Version name of the package | N/A | ||||
| With History | Keep versionning in the package | No | ||||
| Backup package | Will store the Creator Name of the document on documents instead of using the Author name | No | ||||
| Create Provider | A template provider will allow users to create new document from a template in defined spaces in order to organize better your content | |||||
| Available Providers | ||||||
| Check for updates for the outdated installed extensions | ||||||
| Template | Manage the existing wiki templates | |||||
| Creation Right | Specify with users have the right to create new wikis | |||||
| Enable the message stream | Enable the message stream functionality | |||||
| Email "from" address | All mail sent will use this address | |||||
| Email subject line template | ||||||
| Email message body HTML template | ||||||
| Let users of other wikis send | ||||||
| Email message XClass | ||||||
| Let users send to multiple addresses | ||||||
| Regular expression for validating email addresses | ||||||
| Let users personalize messages | ||||||
| Document containing email XObjects | ||||||
| Annotations are activated | ||||||
| Except for the following spaces | You can use "CTRL+ Mouse Clic" to select multiple elements | |||||
| Display annotations by default | No | |||||
| Display annotations highlight by default | Yes | |||||
| Activated | Enable the search suggest functionality | |||||
| Sources | ||||||
