Documentation (desperately?) needing improvement, examples etc.

Updated the post with input types. Could still use a lil’ more info here and there, but it seems to cover all (but the radio button) so far with info on how to get started.

Never mentioned formit though


No idea on the internationalization. I personally would have the English one properly set up before even thinking about translating it.. People can always use a google translate if they don’t speak english, right?

Quote from: Mark at Mar 02, 2011, 03:20 PM

Never mentioned formit though

Quote from: Mark at Mar 02, 2011, 03:20 PM

Making a real basic contact form

Actually that means formIt I think? Here it is: http://rtfm.modx.com/display/ADDON/FormIt.Examples.Simple+Contact+Page

Ah, gotcha Thanks

Ones that catch me out constantly are the following two (and there’s another that I can’t remember off the top of my head):

Output filters have been expanded a great deal in core but not in docs:
http://rtfm.modx.com/display/revolution20/Input+and+Output+Filters
It would also be useful to have more concrete examples, especially for an if:then:else construct which lots of people will use.
The snippet as outputfilter example could do with explaining some more (a worked through example, including the output).

System settings are badly out of date:
http://rtfm.modx.com/display/revolution20/System+Settings

The users and permissions sections are out of date (no mention of policy templates etc, or the new roles such as ContentEditor.

There’s lots more....

Please do report anything you find.. that way we could cross of things and work a little bit more structured

Thanks for the reports so far.

I’ve updated the output filter document based on the source I had locally (2.1-rc3), so that should be up to par for the time being.

Also made minor changes to the Tag Syntax page.

Keep those reports coming people - the more reports are listed here, the easier it is for knowledgeable people to see what could do with more examples or clarifications when they have time!

Correct me if I’m wrong or either the Examples here;http://rtfm.modx.com/display/revolution20/Input+and+Output+Filters+(Output+Modifiers) don’t work or the information is outdated/wrong ...

Also ... the conditinal modifiers might need more examples ...



Especially on the formatting of the code so that if someone was to extend functionality to something else like



Output modifiers are very useful and a lot of people are having problems with it but are settling with writing their own prehooks and posthooks to try live with the problem.

Syntax is a big problem. Personally I keep getting errors when editing a specific example to cater to a specific problem. Example above.

Hope I’m making sense.

I think you’re missing your "else" between the then=`` and the next isequalto=``.

Anyway, if you’re going to work on such extensive conditionals you may be better of using the If or Switch snippets which make it a lot easier to maintain and will most likely pick up more performance in the process. When using output modifiers the entire class is loaded for each one, and while it’s no problem when just using one or two, you will start noticing some performance when using chains like that.

I’ve updated those docs myself some time ago based on the 2.1 source, but didn’t try out every example. If you can be a bit more specific on which one(s) you tried did not work, please let me know so I can fix that without having to spend ages on figuring that out...

I tried this ... after setting the DOB in the backend, and logged in as that user ...



I got a blank field on the page.

I know there is a way to do it ... its just the syntax and you know a small error makes the whole thing not work.

[[+numbooks:isequalto=`5`:then=`There are 5 books!`:else:isequalto=`4`:then=`There are 4 books!`:else=`Not sure how many books`]]

I tried something like the above and it didn’t work. How exactly are you suggesting I include the else?

Tried this also ...

Ah, that’s a good one.

[[+userId]] isn’t set by default, the docs sort of assume people get that. Try replacing user with modx.user.id (so [[+modx.user.id:userinfo=`dob`]]





Edit: Updated the docs.