1. Getting Started
      1. Basic Installation
      2. What is MODx
    2. Content Editing
      1. Editing Documents
      2. MODx Tags
        1. Document Variables
      3. Terminology
      4. The Manager
      5. Who Should Read This
    3. Designing
      1. Adding Chunks
      2. Adding MODx Tags
        1. Resource Fields
      3. Adding Snippets
      4. Document Caching
      5. Template Basics
    4. Administration
      1. Friendly URL Solutions
      2. Manager Users
        1. Manager Roles And Groups
        2. Reset your Password - Unblock your User
        3. Why Manager Users, Roles and Groups
      3. Moving Site
      4. Taking sites down for maintenance
      5. Upgrading
      6. Web Users
        1. Creating a Web User
        2. Web User Groups and Document Groups
        3. Why Web Users and Groups
    5. Developer's Guide
      1. API Reference
        1. DBAPI
          1. delete
          2. escape
          3. getInsertId
          4. query
          5. select
          6. update
        2. Document Object
        3. DocumentParser Object
          1. addEventListener
          2. changeWebUserPassword
          3. documentContent
          4. documentGenerated
          5. documentIdentifier
          6. documentListing
          7. documentMethod
          8. documentObject
          9. getAllChildren
          10. getCachePath
          11. getChildIds
          12. getDocumentChildren
          13. getDocumentChildrenTVarOutput
          14. getDocumentChildrenTVars
          15. getLoginUserID
          16. getLoginUserName
          17. getLoginUserType
          18. getManagerPath
          19. getParent
          20. getParentIds
          21. getUserData
          22. hasPermission
          23. isBackend
          24. isFrontend
          25. logEvent
          26. maxParserPasses
          27. minParserPasses
          28. regClientCSS
          29. runSnippet
          30. table_prefix
          31. tstart
          32. webAlert
      2. Chunks
      3. Modules
        1. How to create and run a module from within the Content Manager
        2. Managing module dependencies
        3. Setting up configuration parameters
        4. Writing the module code
      4. Plugins
      5. Snippets
      6. Template Variables
        1. (at) Binding
          1. (at)CHUNK
          2. (at)DIRECTORY
          3. (at)DOCUMENT
          4. (at)EVAL
          5. (at)FILE
          6. (at)INHERIT
          7. (at)SELECT
          8. What are (at) Bindings
        2. Creating a Template Variable
        3. What are Template Variables
        4. Widgets
          1. Misc. Widget
          2. DataGrid Widget
          3. Floater Widget
          4. Hyperlink Widget
          5. Marquee Widget
          6. RichTextBox Widget
          7. Ticker Widget
          8. Viewport Widget
          9. What are Widgets

Setting up configuration parameters

In the Module configuration textbox you can enter a configuration string to have the system automatically generate input boxes for you to enter data.

Consider the following string:

&color=Font Color;string;#000000

Unable to render embedded object: File (modules_6.gif) not found.

The above can be considered as a single input variable. The & sign is used to separate multiple variables while the = sign is used to assign the variable it's description, data type and default value. With this knowledge we could read the above as:

&name = Description;datatype;value

where:

name – name of the variable to be used inside theplugin code
description – A brief description of the input variable
datatype - the type of input to accept from the user
value - the values or list to be displayed.

Where data types can be one of the following:

int – An integer. Use a textbox to accept numeric inputs
string - This is the default data type. Uses a textbox to accept input values
list – A list. Use a dropdown menu to display a list of values.

Example of a list input variable:

&color=Colors;list;Red,Blue,Green

Note: future versions will support more data types such as date, color, etc

To have the page to render the configuration string, click on the button to the right of the textbox. The page will then be rendered as shown below:

Unable to render embedded object: File (modules_7.gif) not found.

You can now modify the value of the color variable to be passed into the module when it's executed. Once the configuration string is set you can modify the values using the available input boxes.

That's it for the configuration tab. Let's now get back to adding our module code.

Suggest an edit to this page on GitHub (Requires GitHub account. Opens a new window/tab).