`directory_diagram(Format)`

Format - Graph language file format. Common predicates for generating directory diagrams.
| Availability: | logtalk_load(diagrams(loader))

| Author: Paulo Moura | Version: 1:13:0 | Date: 2024-12-04

| Compilation flags: | static

| Extends: | public :ref:`diagram(Format) <diagram/1>` | Uses: | :ref:`list <list/0>`

| Remarks: | (none)

| Inherited public predicates: | Â :ref:`diagram/1::all_files/0` Â :ref:`diagram/1::all_files/1` Â :ref:`diagram/1::all_libraries/0` Â :ref:`diagram/1::all_libraries/1` Â :ref:`options_protocol/0::check_option/1` Â :ref:`options_protocol/0::check_options/1` Â :ref:`options_protocol/0::default_option/1` Â :ref:`options_protocol/0::default_options/1` Â :ref:`diagram/1::diagram_description/1` Â :ref:`diagram/1::diagram_name_suffix/1` Â :ref:`diagram/1::directories/2` Â :ref:`diagram/1::directories/3` Â :ref:`diagram/1::directory/1` Â :ref:`diagram/1::directory/2` Â :ref:`diagram/1::directory/3` Â :ref:`diagram/1::files/1` Â :ref:`diagram/1::files/2` Â :ref:`diagram/1::files/3` Â :ref:`diagram/1::format_object/1` Â :ref:`diagram/1::libraries/1` Â :ref:`diagram/1::libraries/2` Â :ref:`diagram/1::libraries/3` Â :ref:`diagram/1::library/1` Â :ref:`diagram/1::library/2` Â :ref:`options_protocol/0::option/2` Â :ref:`options_protocol/0::option/3` Â :ref:`diagram/1::rdirectory/1` Â :ref:`diagram/1::rdirectory/2` Â :ref:`diagram/1::rdirectory/3` Â :ref:`diagram/1::rlibrary/1` Â :ref:`diagram/1::rlibrary/2` Â :ref:`options_protocol/0::valid_option/1` Â :ref:`options_protocol/0::valid_options/1` Â

.. contents:: :local: :backlinks: top

Public predicates

(no local declarations; see entity ancestors if any)

Protected predicates

.. index:: remember_included_directory/1 .. _directory_diagram/1::remember_included_directory/1:

remember_included_directory/1 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Remember included Logtalk directory in the diagram.

| Compilation flags: | static

| Template: | remember_included_directory(Path) | Mode and number of proofs: | remember_included_directory(+atom) - one

.. index:: remember_referenced_logtalk_directory/1 .. _directory_diagram/1::remember_referenced_logtalk_directory/1:

remember_referenced_logtalk_directory/1 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Remember referenced Logtalk directory in the diagram.

| Compilation flags: | static

| Template: | remember_referenced_logtalk_directory(Path) | Mode and number of proofs: | remember_referenced_logtalk_directory(+atom) - one

.. index:: remember_referenced_prolog_directory/1 .. _directory_diagram/1::remember_referenced_prolog_directory/1:

remember_referenced_prolog_directory/1 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Remember referenced Prolog directory in the diagram.

| Compilation flags: | static

| Template: | remember_referenced_prolog_directory(Path) | Mode and number of proofs: | remember_referenced_prolog_directory(+atom) - one

Private predicates

.. index:: included_directory_/1 .. _directory_diagram/1::included_directory_/1:

included_directory_/1 ^^^^^^^^^^^^^^^^^^^^^^^^^

Table of Logtalk directories already included in the diagram.

| Compilation flags: | dynamic

| Template: | included_directory_(Path) | Mode and number of proofs: | included_directory_(?atom) - zero_or_more

.. index:: referenced_logtalk_directory_/1 .. _directory_diagram/1::referenced_logtalk_directory_/1:

referenced_logtalk_directory_/1 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Table of referenced Logtalk directories in the diagram.

| Compilation flags: | dynamic

| Template: | referenced_logtalk_directory_(Path) | Mode and number of proofs: | referenced_logtalk_directory_(?atom) - zero_or_more

.. index:: referenced_prolog_directory_/1 .. _directory_diagram/1::referenced_prolog_directory_/1:

referenced_prolog_directory_/1 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Table of referenced Prolog directories in the diagram.

| Compilation flags: | dynamic

| Template: | referenced_prolog_directory_(Path) | Mode and number of proofs: | referenced_prolog_directory_(?atom) - zero_or_more

Operators

(none)