Skip to content

Commit

Permalink
update READMEE a bit
Browse files Browse the repository at this point in the history
  • Loading branch information
toniher committed Oct 20, 2016
1 parent 42e81b5 commit 8e800eb
Showing 1 changed file with 24 additions and 13 deletions.
37 changes: 24 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# SMWParent

Extension for printing out ancestors and descendants of a certain page-based on interconnected Semantic MediaWiki properties.
Extension for printing out ancestors, descendants and relationship trees of pages interconnected with Semantic MediaWiki properties.

## Functions

Expand All @@ -10,6 +10,27 @@ Extension for printing out ancestors and descendants of a certain page-based on
* {{#SMWChildren:}}
Show the children / descendant pages

### Usage

* {{#SMWParent:FULLPAGENAME|PARENT_TYPE/PARENT_LEVEL|link}}


Params:

- If FULLPAGENAME is skipped, current page is used
- PARENT_TYPE to retrieve, or alternately up to which level PARENT_LEVEL to reach
- If input is 'link', resulting pages are shown as links instead of as text.

## API

An API endpoint is available. action=smwparent.
* retrieve: 3 possible methods (parent, children, tree)
* title: fullpage title of page in the wiki
* type: the type of pages to be retrieved (according to a given properties)
* link_properties: properties used for linking between pages
* type_properties: properties used for defining the types. If 'Categories', MediaWiki categories are also used.
* print_properties: properties to be printed and appended to the nodes.

## Parameters and default values

You can override these values by modifying LocalSettings.php below extension requirement.
Expand All @@ -26,18 +47,8 @@ $wgSMWParentProps = array('Comes_from_Process', 'Comes_from_Sample', 'Has_Reques

$wgSMWParentPrintProps = array('Start', 'End'); // Properties associated to an object which are printed

## Usage

* {{#SMWParent:FULLPAGENAME|PARENT_TYPE/PARENT_LEVEL|link}}

Params:

- If FULLPAGENAME is skipped, current page is used
- PARENT_TYPE to retrieve, or alternately up to which level PARENT_LEVEL to reach
- If input is 'link', resulting pages are shown as links instead of as text.

## TODO

* Producing a full tree from parent and children outputs
* Design API
* Better handling of SMW property types
* Refactor some functions and variables

0 comments on commit 8e800eb

Please sign in to comment.