.. index:: single: library_diagram(Format)
.. _library_diagram/1:

.. rst-class:: right

**category**

``library_diagram(Format)``
===========================

* ``Format`` - Graph language file format.


Common predicates for generating library diagrams.

| **Availability:** 
|    ``logtalk_load(diagrams(loader))``

| **Author:** Paulo Moura
| **Version:** 2:17:0
| **Date:** 2024-12-04

| **Compilation flags:**
|    ``static``


| **Extends:**
|    ``public`` :ref:`diagram(Format) <diagram/1>`
| **Uses:**
|    :ref:`list <list/0>`
|    :ref:`user <user/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:: add_library_documentation_url/4
.. _library_diagram/1::add_library_documentation_url/4:

``add_library_documentation_url/4``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Adds a documentation URL when using the option url_prefixes/2.

| **Compilation flags:**
|    ``static``

| **Template:**
|    ``add_library_documentation_url(Kind,Options,Library,NodeOptions)``
| **Mode and number of proofs:**
|    ``add_library_documentation_url(+atom,+list(compound),+atom,-list(compound))`` - ``one``


------------

.. index:: remember_included_library/2
.. _library_diagram/1::remember_included_library/2:

``remember_included_library/2``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Remember included Logtalk library in the diagram.

| **Compilation flags:**
|    ``static``

| **Template:**
|    ``remember_included_library(Library,Path)``
| **Mode and number of proofs:**
|    ``remember_included_library(+atom,+atom)`` - ``one``


------------

.. index:: remember_referenced_logtalk_library/2
.. _library_diagram/1::remember_referenced_logtalk_library/2:

``remember_referenced_logtalk_library/2``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Remember referenced Logtalk library in the diagram.

| **Compilation flags:**
|    ``static``

| **Template:**
|    ``remember_referenced_logtalk_library(Library,Path)``
| **Mode and number of proofs:**
|    ``remember_referenced_logtalk_library(+atom,+atom)`` - ``one``


------------

.. index:: remember_referenced_prolog_library/2
.. _library_diagram/1::remember_referenced_prolog_library/2:

``remember_referenced_prolog_library/2``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Remember referenced Prolog library in the diagram.

| **Compilation flags:**
|    ``static``

| **Template:**
|    ``remember_referenced_prolog_library(Library,Path)``
| **Mode and number of proofs:**
|    ``remember_referenced_prolog_library(+atom,+atom)`` - ``one``


------------

Private predicates
------------------

.. index:: included_library_/2
.. _library_diagram/1::included_library_/2:

``included_library_/2``
^^^^^^^^^^^^^^^^^^^^^^^

Table of Logtalk libraries already included in the diagram.

| **Compilation flags:**
|    ``dynamic``

| **Template:**
|    ``included_library_(Library,Path)``
| **Mode and number of proofs:**
|    ``included_library_(?atom,?atom)`` - ``zero_or_more``


------------

.. index:: referenced_logtalk_library_/2
.. _library_diagram/1::referenced_logtalk_library_/2:

``referenced_logtalk_library_/2``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Table of referenced Logtalk libraries in the diagram.

| **Compilation flags:**
|    ``dynamic``

| **Template:**
|    ``referenced_logtalk_library_(Library,Path)``
| **Mode and number of proofs:**
|    ``referenced_logtalk_library_(?atom,?atom)`` - ``zero_or_more``


------------

.. index:: referenced_prolog_library_/2
.. _library_diagram/1::referenced_prolog_library_/2:

``referenced_prolog_library_/2``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Table of referenced Prolog libraries in the diagram.

| **Compilation flags:**
|    ``dynamic``

| **Template:**
|    ``referenced_prolog_library_(Library,Path)``
| **Mode and number of proofs:**
|    ``referenced_prolog_library_(?atom,?atom)`` - ``zero_or_more``


------------

Operators
---------

(none)

.. seealso::

   :ref:`inheritance_diagram(Format) <inheritance_diagram/1>`, :ref:`uses_diagram(Format) <uses_diagram/1>`, :ref:`xref_diagram(Format) <xref_diagram/1>`, :ref:`entity_diagram(Format) <entity_diagram/1>`