Aristotle Help models

class aristotle_mdr.contrib.help.models.ConceptHelp(*args, **kwargs)[source]

A Concept help page documents a given model that inherits from an 11179 concept.

Parameters:
  • id (AutoField) – Id
  • created (AutoCreatedField) – Created
  • modified (AutoLastModifiedField) – Modified
  • slug (AutoSlugField) – Slug
  • app_label (CharField) – Add an app for app specific help, required for concept help
  • title (TextField) – A short title for the help page
  • body (RichTextUploadingField) – A long help definition for an object or topic
  • language (CharField) – Language
  • is_public (BooleanField) – Indicates if a help topic is available to non-registered users.
  • helpbase_ptr_id (OneToOneField) – Helpbase ptr
  • concept_type (CharField) – Concept type
  • brief (TextField) – A short description of the concept
  • official_definition (TextField) – An official description of the concept, e.g. the ISO/IEC definition for an Object Class
  • official_reference (TextField) – The reference document that describes this concept type
  • official_link (TextField) – An link to an official source for a description of the concept
  • creation_tip (RichTextUploadingField) – Instructions for creating good content of this type
class aristotle_mdr.contrib.help.models.HelpBase(*args, **kwargs)[source]

The base help class for Aristotle help pages.

Parameters:
  • id (AutoField) – Id
  • created (AutoCreatedField) – Created
  • modified (AutoLastModifiedField) – Modified
  • slug (AutoSlugField) – Slug
  • app_label (CharField) – Add an app for app specific help, required for concept help
  • title (TextField) – A short title for the help page
  • body (RichTextUploadingField) – A long help definition for an object or topic
  • language (CharField) – Language
  • is_public (BooleanField) – Indicates if a help topic is available to non-registered users.
class aristotle_mdr.contrib.help.models.HelpPage(*args, **kwargs)[source]

A help page is a generic way of providing help to a user on a topic.

Parameters:
  • id (AutoField) – Id
  • created (AutoCreatedField) – Created
  • modified (AutoLastModifiedField) – Modified
  • slug (AutoSlugField) – Slug
  • app_label (CharField) – Add an app for app specific help, required for concept help
  • title (TextField) – A short title for the help page
  • body (RichTextUploadingField) – A long help definition for an object or topic
  • language (CharField) – Language
  • is_public (BooleanField) – Indicates if a help topic is available to non-registered users.
  • helpbase_ptr_id (OneToOneField) – Helpbase ptr