<< buildhelpweb

Help tools functions

headcomments >>

---

docroot

---

Retrieve or update the root directory for Nelson Help system.

---

Syntax

---

r = docroot()

r = docroot(new_docroot)

Input argument

---

new_docroot

a string: '', '.', or a URL.

Description

---

docroot retrieves or updates the root directory for Nelson Help.

When called without an argument, docroot returns the current root directory for Nelson Help. By default, it returns the URL of the help website used by Nelson.

When called with an argument, docroot updates the root directory for Nelson Help.

docroot('') resets the root directory for Nelson Help to the default value.

docroot('.') uses local help files and the local browser (restores behavior before v1.11.0).

Example

---

docroot()
doc rand
docroot('.')
doc rand
docroot('')

See also

---

doc.

History

---

Version	Description
1.0.0	initial version

Author

---

Allan CORNET