Example syntax documentation software optional parameters

Optional parameters by using square bracklets.

wikiation_check_isolation mwversion [--detail|-d] [excluded_dir]

Used in : Wikiation_check_isolation

Optional detail

[--detail|-d]

Can be used but is not required. Standard the isolation_check just checks if there is isolation or not and returns that with a summery result. That is sufficient for a person who installs the extension. He needs to know if the extension is isolated or not.

But an extension programmer may what to improve the extension by more isolate it. Then he needs to know the details, what has been changed. Then he is able to change the extension so it is more isolated.

Option dir

[excluded_dir]

If an extension is installed of course there is a difference between before the installation of the extension. The extension directory is added. But this does not influence the isolation. wikiation_check_isolation does its works good and shows all difference, so allso the new extension directory. But problebly you do not want that. So with this parameter you can ignore this directory and you will see the real difference except the extension directory. This is more valuable information for you.