Browse Source

doc clarification and mentioning new clean up practice

pull/489/head
willtp87 11 years ago
parent
commit
e560c90520
  1. 9
      islandora.api.php

9
islandora.api.php

@ -627,11 +627,14 @@ function hook_CMODEL_PID_islandora_overview_object_alter(AbstractObject &$object
* - force: Bool denoting whether we are forcing the generation of * - force: Bool denoting whether we are forcing the generation of
* derivatives. * derivatives.
* - source_dsid: (Optional) String of the datastream id we are generating * - source_dsid: (Optional) String of the datastream id we are generating
* from or NULL if it's the object itself. * from or NULL if it's the object itself. Does not impact function
* ordering.
* - destination_dsid: (Optional) String of the datastream id that is being * - destination_dsid: (Optional) String of the datastream id that is being
* created. To be used in the UI. * created. To be used in the UI. Does not impact function ordering.
* - weight: A string denoting the weight of the function. This value is * - weight: A string denoting the weight of the function. This value is
* sorted upon to run functions in order. * sorted upon to run functions in order. Some derivation steps operate as
* clean up steps. For consistency with ingest steps they use weight:50 it
* is advisable to stay beneath this weight.
* - function: An array of function(s) to be ran when constructing * - function: An array of function(s) to be ran when constructing
* derivatives. Functions that are defined to be called for derivation * derivatives. Functions that are defined to be called for derivation
* creation must have the following structure: * creation must have the following structure:

Loading…
Cancel
Save