Small additions to the manuals


(Warwick Barnes) #1

G'day,


It'd be good if the External Tools Configuration page (http://manuals.matrix.squiz.net/system-configuration/chapters/external-tools-configuration) mentioned that you have to be logged-in as the root user (not just as a member of the System Administrators group) in order to change the 'Active' status of external tools. (Actually, is this by design, or is it a bug?) You can change the paths to the tools when you're logged in as any administrator.



I think the Show If Design Area page (http://manuals.matrix.squiz.net/designs/chapters/show-if-design-area) could do with some more explanation of some of the options. I also don't think it's clear that some (all?) of the matching is done via regular expressions.



On the Global Keywords page (http://manuals.matrix.squiz.net/keyword-replacements/chapters/global-keywords) under Date and Time you use the word "prefixed" when it should be "suffixed".



I couldn't find any documentation for the global keywords %globals_server_remote_addr% and %globals_server_http_x_forwarded_for%, etc. Are these listed somewhere?



Thanks,



Warwick


(Josh Sherwood) #2

Thanks for the feedback, Warwick.

[quote]

It'd be good if the External Tools Configuration page (http://manuals.matrix.squiz.net/system-configuration/chapters/external-tools-configuration) mentioned that you have to be logged-in as the root user (not just as a member of the System Administrators group) in order to change the 'Active' status of external tools.[/quote]



I've added this information to the External Tools Config chapter now, both in the page information section and in the relevant 'Activate External Tools' screen section. It should be quite clear now, hopefully.


[quote]I think the Show If Design Area page (http://manuals.matrix.squiz.net/designs/chapters/show-if-design-area) could do with some more explanation of some of the options.[/quote]



Agreed. I will work on expanding this chapter, shortly.


[quote]On the Global Keywords page (http://manuals.matrix.squiz.net/keyword-replacements/chapters/global-keywords) under Date and Time you use the word "prefixed" when it should be "suffixed".[/quote]



Oops. Fixed!


[quote]I couldn't find any documentation for the global keywords %globals_server_remote_addr% and %globals_server_http_x_forwarded_for%, etc. Are these listed somewhere?[/quote]



The Server Variable global was missing from the Global Keywords chapter in the Keyword Replacements Manual. I have now added it, with an example and a link to the PHP $_Server Manual containing the server variables that can be used.



Cheers for all your suggestions. Much appreciated.


(Warwick Barnes) #3

G'day Josh,


Thanks for fixing those things so quickly.



I found another small thing … I don't think the keyword replacement %link_url% is documented anywhere. I thought it might be in the Link Assets section on this page:

http://manuals.matrix.squiz.net/keyword-replacements/chapters/common-keywords



Cheers,



Warwick


(Squiz) #4

This sounds like a good topic to make sticky.


Just spent a good fifteen minutes stuffing around with the setMetadata() function in the JS API, so it would be helpful to note that the second field is the asset ID of the metadata field, rather than the "name" as one might mistakenly expect.




(Warwick Barnes) #5

[quote]
Thanks for the feedback, Warwick.



I've added this information to the External Tools Config chapter now, both in the page information section and in the relevant 'Activate External Tools' screen section. It should be quite clear now, hopefully.



Agreed. I will work on expanding this chapter, shortly.



Oops. Fixed!



The Server Variable global was missing from the Global Keywords chapter in the Keyword Replacements Manual. I have now added it, with an example and a link to the PHP $_Server Manual containing the server variables that can be used.



Cheers for all your suggestions. Much appreciated.

[/quote]



On the global keywords manual page, http://manuals.matrix.squizsuite.net/keyword-replacements/chapters/global-keywords, it's probably worth also listing %globals_server_http_x_forwarded_for% as one of the examples. This is an important header, and explicitly listing it on the page would make it come up when you're searching. Also the linked PHP manual page doesn't document this very clearly, with only a user-submitted comment from "steve at sc-fa dot com" mentioning the existence of the HTTP_X_FORWARDED_FOR header … it's not actually on the main list of headers.


(Benjamin Pearson) #6

[quote]
On the global keywords manual page, http://manuals.matrix.squizsuite.net/keyword-replacements/chapters/global-keywords, it’s probably worth also listing %globals_server_http_x_forwarded_for% as one of the examples. This is an important header, and explicitly listing it on the page would make it come up when you’re searching. Also the linked PHP manual page doesn’t document this very clearly, with only a user-submitted comment from “steve at sc-fa dot com” mentioning the existence of the HTTP_X_FORWARDED_FOR header … it’s not actually on the main list of headers.

[/quote]



You have to be careful of $_SERVER vars, some of these variables can be turned off in config or stripped out/modified by proxies. I think the HTTP_X_FORWARDED_FOR only exists if you go through a certain type of proxy.