Help:Embedded format

From semantic-mediawiki.org
Jump to: navigation, search
Embedded format
Embed selected articles.
Available languages
deenzh-hans
Further Information
Provided by: Semantic MediaWiki
Added: 0.7
Removed: still supported
Requirements: none
Format name: embedded
Enabled by default: 
Indicates whether the result format is enabled by default upon installation of the respective extension.
yes
Authors: Markus Krötzsch
Categories: misc
Group:
Table of Contents

↓ INFO ↓

The result format embedded is used to embed the contents of the pages in a query result into a page. The embedding uses MediaWiki transclusion (like when inserting a template), so the tags <includeonly> and <noinclude> work for controlling what is displayed.

Parameters

General

Parameter Type Default Description
source text empty Alternative query source
limit whole number 50 The maximum number of results to return
offset whole number 0 The offset of the first result
link text all Show values as links
sort list of texts empty Property to sort the query by
order list of texts empty Order of the query sort
headers text show Display the headers/property names
mainlabel text no The label to give to the main page name
intro text empty The text to display before the query results, if there are any
outro text empty The text to display after the query results, if there are any
searchlabel text ... further results Text for continuing the search
default text empty The text to display if there are no query results

Format specific

Parameter Type Default Description
embedformat text h1 The HTML tag used to define headings
embedonly yes/no no Display no headings

The embedded format introduces the following additional parameters:

  • embedformat: this defines which kinds of headings to use when pages are embedded, may be a heading level, i.e. one of h1, h2, h3, h4, h5, h6, or a description of a list format, i.e. one of ul and ol
  • embedonly: if this parameter has any value (e.g. yes), then no headings are used for the embedded pages at all.

Example

The following creates a list of recent news posted on this site (like in a blog):

{{#ask:
 [[News date::+]]
 [[language code::en]]
 |sort=news date
 |order=descending
 |format=embedded
 |embedformat=h3
 |embedonly=yes
 |searchlabel= <br />[view older news]
 |limit=3
}}

This produces the following output:


Semantic MediaWiki 2.5 (SMW 2.5.0), the next feature version after 2.4 has now been released.

This new version brings many enhancements and new features such as full-text search support for datatype "Text", query result caching for better performance and the options to record and reference provenance data, to use property chains and language filters in print requests, to define preferred property labels as well as to integrate edit protection with annotations. Moreover the links in values feature for datatype "Text" was improved a lot and the fixed properties support was repaired which is now no longer experimental. Not to forget special page "SMWAdmin" was renamed to "SemanticMediaWiki" extended and overhauled. See also the version release page for information on further improvements and new features. Additionally this version fixes a lot of bugs and brings stability and performance improvements. Automated software testing was again further expanded to assure software stability. Please see the page Installation for details on how to install and upgrade.

Semantic MediaWiki 2.4.6 (SMW 2.4.6) has been released today as a new version of Semantic MediaWiki.

This new version is a minor release and provides an enhancement for users of MySQL data stores to the current 2.4 branch of Semantic MediaWiki. Please refer to the help page on installing Semantic MediaWiki to get detailed instructions on how to install or upgrade.

Semantic MediaWiki 2.4.5 (SMW 2.4.5) has been released today as a new version of Semantic MediaWiki.

This new version is a minor release and provides bugfixes for the current 2.4 branch of Semantic MediaWiki. Please refer to the help page on installing Semantic MediaWiki to get detailed instructions on how to install or upgrade.
[view older news]

NoteNote: The newline (<br />) is used to put the further results link on a separate line.

Remarks

Note that by default this result format also adds all annotations from the pages that are being embedded to the page they are embedded to.1 Starting with Semantic MediaWiki 2.4.0 this can be prevented for annotations done via parser functions #set parser function and #subobject parser function by setting the embedonly parameter to "yes".2 In-text annotations will continue to be embedded. Thus these annotations need to be migrated to use the #set parser function to prevent this from happening.

Also note that embedding pages may accidently include category statements if the embedded articles have any categories. Use <noinclude> to prevent this, e.g. by writing

<noinclude>[[Category:News feed]]</noinclude>

Semantic MediaWiki will take care that embedded articles do not import their semantic annotations, so these need not be treated specifically.

Last but not least note that printout statements have no effect on embedding queries.

Limitations

You cannot use the embed format to embed a query from another page if that query relies on the magic word {{PAGENAME}}.



This documentation page applies to all SMW versions from 0.7 to the most current version.
      Other languages: defrzh-hans

Help:Embedded format en 0.7