You are here

Home » API reference » Freelinking 7.3

README.txt in Freelinking 7.3

Same filename in this branch
  1. 7.3 README.txt
  2. 7.3 modules/freelinking_prepopulate/README.txt
Same filename and directory in other branches
  1. 6.3 modules/freelinking_prepopulate/README.txt
CONTENTS OF THIS FILE

* Introduction
* Requirements
* Recommended modules
* Installation
* API and utilities
* Createnode
* Maintainers


INTRODUCTION

This module create a prepopulated link to a create node. It is used
primarily as a failover for the *Nodetitle* plugin.  When this module
is enabled, the failure option “”Add a link to create content” is
added to the failover pull down menu for *Nodetitle*.

The following items will be inherited from the the parent node and
used to prepopulate the new node:

* Title (inherited from the *target* of the freelink markup).
* Book outline (requires the **Book** module to be enabled).
* Taxonomy term  (requires the **Taxonomy** module to be enabled). [N.I.]
* OG context  (requires the **OG Context** module to be enabled). [N.I.]

**Note:** *Taxonomy term* and *OG context* does not work and is currently disabled.

For example, the following freelink: `[[nodetitle:Does not exist]]`,  produces:

    <a class="freelink freelink-createnode notfound freelink-internal" title="node/add/article" href="/node/add/article?edit%5Btitle%5D=Does%20not%20exist&parent=836">Does not exist</a>

Here, the `parent=836` identifies the book the new node shall be part of.


REQUIREMENTS

Requires [Prepopulate][1].


RECOMMENDED MODULES

* Book:<br>
  When the core Book module is enabled, create node links will be
  prepopulated as being part of the same book as the parent node.

* [Markdown filter][2]:<br>
  When this module is enabled, display of the project's `README.md` will be
  rendered with markdown when you visit `/admin/help/freelinking_prepopulate`.


INSTALLATION

1. Install as you would normally install a contributed drupal
   module. See: [Installing modules][3] for further information.
2. To configure the module, navigate to Configuration > Content
   authoring > Freelinking settings.  There should be a panel headed
   *Freelinking_prepopulate Plugin Settings*, abd a new option ("Add a
   link to create content") added to the failover menu for
   *Nodetitle*.


API AND UTILITIES

For API functions and examples of their use, see
`freelinking_prepopulate.api.php`.

The Freelinking Prepopulate Utilities
(`freelinking_prepopulate.utilities.inc`) are intended to help with
the centralized definition of form fields that may be of interest for
Prepopulate-based plugins, and automating the process of extracting
information for such fields.


MAINTAINERS

* grayside - https://www.drupal.org/u/grayside
* juampy - https://www.drupal.org/u/juampy
* gisle - https://www.drupal.org/u/gisle (current maintainer)

Any help with development (patches, reviews, comments) are welcome.

[1]: https://www.drupal.org/project/prepopulate
[2]: https://www.drupal.org/project/markdown
[3]: https://drupal.org/documentation/install/modules-themes/modules-7

File

modules/freelinking_prepopulate/README.txt
View source 
  1. CONTENTS OF THIS FILE

  2. 

  3. * Introduction

  4. * Requirements

  5. * Recommended modules

  6. * Installation

  7. * API and utilities

  8. * Createnode

  9. * Maintainers

  10. 

  11. 

  12. INTRODUCTION

  13. 

  14. This module create a prepopulated link to a create node. It is used

  15. primarily as a failover for the *Nodetitle* plugin.  When this module

  16. is enabled, the failure option “”Add a link to create content” is

  17. added to the failover pull down menu for *Nodetitle*.

  18. 

  19. The following items will be inherited from the the parent node and

  20. used to prepopulate the new node:

  21. 

  22. * Title (inherited from the *target* of the freelink markup).

  23. * Book outline (requires the **Book** module to be enabled).

  24. * Taxonomy term  (requires the **Taxonomy** module to be enabled). [N.I.]

  25. * OG context  (requires the **OG Context** module to be enabled). [N.I.]

  26. 

  27. **Note:** *Taxonomy term* and *OG context* does not work and is currently disabled.

  28. 

  29. For example, the following freelink: `[[nodetitle:Does not exist]]`,  produces:

  30. 

  31.     Does not exist

  32. 

  33. Here, the `parent=836` identifies the book the new node shall be part of.

  34. 

  35. 

  36. REQUIREMENTS

  37. 

  38. Requires [Prepopulate][1].

  39. 

  40. 

  41. RECOMMENDED MODULES

  42. 

  43. * Book:
    

  44.   When the core Book module is enabled, create node links will be

  45.   prepopulated as being part of the same book as the parent node.

  46. 

  47. * [Markdown filter][2]:
    

  48.   When this module is enabled, display of the project's `README.md` will be

  49.   rendered with markdown when you visit `/admin/help/freelinking_prepopulate`.

  50. 

  51. 

  52. INSTALLATION

  53. 

  54. 1. Install as you would normally install a contributed drupal

  55.    module. See: [Installing modules][3] for further information.

  56. 2. To configure the module, navigate to Configuration > Content

  57.    authoring > Freelinking settings.  There should be a panel headed

  58.    *Freelinking_prepopulate Plugin Settings*, abd a new option ("Add a

  59.    link to create content") added to the failover menu for

  60.    *Nodetitle*.

  61. 

  62. 

  63. API AND UTILITIES

  64. 

  65. For API functions and examples of their use, see

  66. `freelinking_prepopulate.api.php`.

  67. 

  68. The Freelinking Prepopulate Utilities

  69. (`freelinking_prepopulate.utilities.inc`) are intended to help with

  70. the centralized definition of form fields that may be of interest for

  71. Prepopulate-based plugins, and automating the process of extracting

  72. information for such fields.

  73. 

  74. 

  75. MAINTAINERS

  76. 

  77. * grayside - https://www.drupal.org/u/grayside

  78. * juampy - https://www.drupal.org/u/juampy

  79. * gisle - https://www.drupal.org/u/gisle (current maintainer)

  80. 

  81. Any help with development (patches, reviews, comments) are welcome.

  82. 

  83. [1]: https://www.drupal.org/project/prepopulate

  84. [2]: https://www.drupal.org/project/markdown

  85. [3]: https://drupal.org/documentation/install/modules-themes/modules-7