stalker.models.wiki.Page¶

class stalker.models.wiki.Page(title=”, content=”, project=None, **kwargs)[source]¶

Bases: stalker.models.entity.Entity, stalker.models.mixins.ProjectMixin

A simple Wiki page implementation.

Wiki in Stalker are managed per Project. That is, all Wiki pages are related to a Project.

Stalker wiki pages are very simple in terms of data it holds. It has only one title and one content an some usual audit info coming from SimpleEntity and a project coming from ProjectMixin.

Parameters:	title (str) – The title of this Page content (str) – The content of this page. Can contain any kind of string literals including HTML tags etc.

__init__(title=”, content=”, project=None, **kwargs)¶

Methods

__init__([title, content, project])

Attributes

`content`
`created_by`	The `User` who has created this object.
`created_by_id`	The id of the `User` who has created this entity.
`date_created`	A `datetime.datetime` instance showing the creation date and time of this object.
`date_updated`	A `datetime.datetime` instance showing the update date and time of this object.
`description`	Description of this object.
`entity_groups`
`entity_id`
`entity_type`
`generic_data`	This attribute can hold any kind of data which exists in SOM.
`generic_text`	This attribute can hold any text.
`html_class`
`html_style`
`id`
`metadata`
`name`	Name of this object
`nice_name`	Nice name of this object.
`notes`	All the `Notes`s attached to this entity.
`page_id`
`plural_class_name`	the plural name of this class
`project`	The `Project` instance that this object belongs to.
`project_id`
`query`
`tags`	A list of tags attached to this object.
`thumbnail`
`thumbnail_id`
`title`
`tjp_id`	returns TaskJuggler compatible id
`to_tjp`	renders a TaskJuggler compliant string used for TaskJuggler
`type`	The type of the object.
`type_id`	The id of the `Type` of this entity.
`updated_by`	The `User` who has updated this object.
`updated_by_id`	The id of the `User` who has updated this entity.

created_by¶: The User who has created this object.

created_by_id¶: The id of the User who has created this entity.

date_created¶: A datetime.datetime instance showing the creation date and time of this object.

date_updated¶: A datetime.datetime instance showing the update date and time of this object.

description¶: Description of this object.

generic_data¶: This attribute can hold any kind of data which exists in SOM.

generic_text¶: This attribute can hold any text.

name¶: Name of this object

nice_name¶

Nice name of this object.

It has the same value with the name (contextually) but with a different format like, all the white spaces replaced by underscores (“_”), all the CamelCase form will be expanded by underscore (_) characters and it is always lower case.

notes¶

All the Notess attached to this entity.

It is a list of Note instances or an empty list, setting it to None will raise a TypeError.

plural_class_name¶: the plural name of this class

project¶: The Project instance that this object belongs to.

tags¶

A list of tags attached to this object.

It is a list of Tag instances which shows the tags of this object

tjp_id¶: returns TaskJuggler compatible id

to_tjp¶: renders a TaskJuggler compliant string used for TaskJuggler integration. Needs to be overridden in inherited classes.

type¶

The type of the object.

It is a Type instance with a proper Type.target_entity_type.

type_id¶: The id of the Type of this entity. Mainly used by SQLAlchemy to create a Many-to-One relates between SimpleEntities and Types.

updated_by¶: The User who has updated this object.

updated_by_id¶: The id of the User who has updated this entity.