Best practice for including jscript (&php) in modx sites

Hi, i'm new to modx revo, using 2.2.0pl. I'm finding that as i develop my first site, i'm including references to scripts in the template code such as js & php (even just for aspects such as google verification). I'm sure i read somewhere that such code should be inserted into pages using chunks... I just want to double check if there is a best practice way of including scripts in a page. Is there any rules i should follow, and if i include these type of elements directly into pages will it affect how they work or conflict with modx?

chunks are for html
snippets for php
js - you can put it into the template - at the top, or the bottom as needed; you can put it (js) or a link to it in a chunk; and finally there is a call to add js to the head of a document that you can put in snippet - see http://rtfm.modx.com/display/revolution20/Adding+CSS+and+JS+to+Your+Pages+Through+Snippets

Cheers, i'll take a look thru this documentation

JS code is fine in chunks, and putting it there can be nice while working on it.

If the JS is in a chunk, you can just put a chunk tag on the page to include it:



Be sure it includes the script tags.

Once it's working, I usually move it to a file (so it doesn't clutter up "view source") and inject it with $modx->regClientStartupScript() or $modx->regClientScript(). In that case, make sure the file does *not* have the script tags.


------------------------------------------------------------------------------------------
PLEASE, PLEASE specify the version of MODX you are using.
MODX info for everyone: http://bobsguides.com/modx.html

Depends on what JS library you are using... this might help.

https://forums.modx.com/thread/75621/can-one-modx-rule-them-all?page=6#dis-post-419421

jaykaye, I just re-read your post and I wonder if you're thinking of the fact that all PHP code used by a MODX page has to be in a snippet or plugin. You can put JS code anywhere, but existing PHP code that you want to import goes in a snippet (though a snippet can "include" other PHP files).


------------------------------------------------------------------------------------------
PLEASE, PLEASE specify the version of MODX you are using.
MODX info for everyone: http://bobsguides.com/modx.html

We wrote a neat little snippet for MODx revo for including js and css files.
The basic idea is this:

You provide the snippet with a list of js and css files in the snippet call.
The snippet will output one single JS and one single CSS file (given a unique name based on a hash)
Your JS is effectivly merged, cached and outputted.
This means you only include the JS and CSS you need in a template, and reduce the number of http requests.

I can probably cobble it all together and put it into this post if anyone is interested!?!

jusmeig, it's always nice to share stuff like that.

That said, also have a look at:
http://modx.com/extras/package/minify
http://modx.com/extras/package/smartoptimizer
http://modx.com/extras/package/minifyx

Some of those might already do what you want.

jaykaye, in essence you're free to do it the way you want to. I personally tend to throw all my scripts into a "footer" chunk which I reference from all my templates, so I always have it included and in one central place. You could also put it in the template if it only counts for that single template, or put it in the header if that's what you prefer. MODX doesn't directly interfere with your markup unless you (or an Extra) tells it to.

Quote from: markh at Apr 12, 2012, 08:41 PM

jusmeig, it's always nice to share stuff like that.

This plugin essentially does excatly what I posted:
http://modx.com/extras/package/minify

It also minifies, which I was not doing....so use this one

http://modx.com/extras/package/minifyx
http://modx.com/extras/package/minify

These are the same extra?