Changes between Version 1 and Version 2 of Documentation/NewbieGuide/ConfigurationOptions

Timestamp:

03/15/18 08:26:26 (6 months ago)

Author:

gogo

Comment:

--

Documentation/NewbieGuide/ConfigurationOptions

@@ -126 +126 @@
     Makes the Xinha edited content "how now yellow camel" be written into the textarea as "how now brown cow".
 
-
+  autoFocus::
+    Boolean. Automatically focus and activate the Xinha editor when the page is loaded.  Not recommended for multiple editors on a page.  Default false.
+
+  killWordOnPaste::
+    Boolean.  When pasting using the toolbar paste button, automatically kill word code in the paste.  Due to browser security restrictions which prevent the toolbar paste button from being displayed, this usually is not of much use.  Default true.
+
+  makeLinkShowsTarget::
+    Boolean.  Allow setting the `target=""` attribute in the default link creation dialog.  Default true.
+
+  charSet::
+    String.  Character set to use.  Default same as the character set of the page including Xinha (not necessarily the page Xinha is editing).  It is highly recommended in the modern age to use UTF-8 character set for EVERYTHING on your website and in your database, if everything is always in UTF-8 you don't have character conversion problems.
+
+  browserQuirksMode::
+    Boolean|null.  True, render the document being edited in in quirks mode.  False, render the document being edited in standards mode.  Null (default), render the document in the same mode as the page including Xinha.
+
+  htmlRemoveTags::
+    RegExp|null.  Set to a regular expression matching tags to remove these entirely from the edited content.   Default null.
+    {{{
+      xinha_config.htmlRemoveTags = /span|font/;
+    }}}
+    Removes all span and font tags.
+
+  flowToolbars::
+    Boolean.  Allow toolbars to flow to fit the width of the editor better.  Default true.
+
+  toolbarAlign::
+    String 'left'|'right'. Align the buttons left or right on the toolbar.  Default 'left'.
+
+  showFontStylesInToolbar::
+    Boolean.  ** Superceeded by the FancySelects plugin. **  Display the names of fonts in the font itself in the select drop down (browser support patchy, use FancySelects instead if you can).  Default false.
+
+  showLoading::
+    Boolean.  Show a panel over the textarea indicating the loading status during the booting process of Xinha.  Default false, however when using XinhaEasy.js or XinhaLoader.js this will typically be enabled anyway.
+
+  stripScripts::
+    Boolean.  Strip scripts from the HTML output - this only works with DOMwalk (see getHtmlMethod above) and is ignored if you use the PreserveScripts plugin.  Default true.
+
+  convertUrlsToLinks::
+    Boolean.  When a user types in a url in the WYSIWYG view, automatically convert it to an html link.  Default true.
+
+  hideObjectsBehindDialogs::
+    Boolean.  Set to true to hide media objects when a div-type dialog box is open, to prevent show-through.  Default false. This probably isn't all that relevant in the modern age since object elements are seldom used.
+
+  colorPickerCellSize::
+    CSS length element.  Size of each cell in the colour picker.  Default 6px
+
+  colorPickerGranularity::
+    Integer.  Set to a higher number to allow more precise colours to be picked.  Default 18.
+
+  colorPickerPosition::
+    String.  Set the position of the colour picker relative to it's button, a strig consisting of two words from  top, bottom, left and right separated by a comma.  Default 'bottom,right'.
+
+  colorPickerWebSafe::
+    Boolean.  Restrict colours to the 256 "web safe" colours.  In the modern age, this is pretty redundant. Default false.
+
+  colorPickerSaveColors::
+    Integer.  Number of recent colours to remember.  Default 20.
+
+  fullScreen::
+    Boolean.  Start the editor in full screen mode.  Default false.
+
+  fullScreenMargins::
+    Array [top, right, bottom, left ].  The margins in pixels to set when the editor is expanded to full screen.  Default [0,0,0,0]
+
+  fullScreenSizeDownMethod::
+    String 'initSize'|'restore'.  When you exit full screen mode, will Xinha go back to the initial size, or the last size it was.  Default 'initSize'
+
+  toolbar::
+    Multi Dimensional Array.  See ToolBarSpecification
+
+  fontname::
+    Object.  The font families to provide in the drop-down select.
+    {{{
+xinha_config.fontname = 
+  {
+    "— font —": "", // — is mdash
+    "Arial"           : 'arial,helvetica,sans-serif',
+    "Courier New"     : 'courier new,courier,monospace',
+    "Georgia"         : 'georgia,times new roman,times,serif',
+    "Tahoma"          : 'tahoma,arial,helvetica,sans-serif',
+    "Times New Roman" : 'times new roman,times,serif',
+    "Verdana"         : 'verdana,arial,helvetica,sans-serif',
+    "Impact"          : 'impact',
+    "WingDings"       : 'wingdings' 
+  }
+}}}
+
+  fontsize::
+    Object.  The font sizes to provide in the drop down select.
+{{{
+xinha_config.fontsize =
+  {
+    "— size —": "", // — is mdash
+    "1 (8 pt)" : "1",
+    "2 (10 pt)": "2",
+    "3 (12 pt)": "3",
+    "4 (14 pt)": "4",
+    "5 (18 pt)": "5",
+    "6 (24 pt)": "6",
+    "7 (36 pt)": "7"
+  };
+}}}
+
+  formatblock::
+    Object.  The different block format types to provide in the drop down select.
+{{{
+xinha_config.formatblock = {
+    "— format —": "", // — is mdash
+    "Heading 1": "h1",
+    "Heading 2": "h2",
+    "Heading 3": "h3",
+    "Heading 4": "h4",
+    "Heading 5": "h5",
+    "Heading 6": "h6",
+    "Normal"   : "p",
+    "Address"  : "address",
+    "Formatted": "pre"
+  };
+}}}
+
+
+  formatblockDetector::
+    Object.  See https://www.coactivate.org/projects/xinha/custom-formatblock-options
+
+  dialogOptions::
+    Object.  Controls some options for dialogs.
+{{{
+  xinha_config.dialogOptions =
+  {
+    'centered' : true, //true: dialog is shown in the center the screen, false dialog is shown near the clicked toolbar button
+    'greyout':true, //true: when showing modal dialogs, the page behind the dialoge is greyed-out
+    'closeOnEscape':true
+  };
+}}}
+
+  Events::
+    Object.  Hook into some events, for example...
+{{{
+    xinha_config.Events.onKeyPress = function (event) 
+    {
+       //do something 
+       return false;
+    }
+}}}
+    See EventHooks for discussion about available hooks.
+
+  debug::
+    Boolean.  Switches on some debug output.  Default false.
+
+  URIs.iframe_src::
+    String.   The intial (blank) src to use on Xinha's iframe.  Default: 'javascript:\'\''
+
+  
+  bodyClass::
+    String.  A CSS class to apply to the `<body>` element.  Default, none.
+
+  bodyID::
+    String.  An id attribute to apply to the `<body>` element.  Default, none.
+
+  
+
+  
+
+