SN:Template Elements

From Sense/Net Wiki
Jump to: navigation, search

Overview

This page contains examples of the elements which you have to use if you write any official documentation about Sense/Net.

When creating a new page always link it to the Table of Contents page first so that the page is linked to a well-known location thus enabling users to find it more easily!

Proper use of the Sense/Net name

If you have to write the name of Sense/Net in the Wiki, always use the following: Sense/Net (with slash and capitalize the words!) Don't include the version number, except if you refer to a specific version!


Wrong:

Sensenet 6.0 Content types

Correct:

Sense/Net Content types

Compulsory elements for every page

Content categories

Always give the proper category for every page what you've created in the wiki! If it's a user profile related page, use the following categories:

[[Category:End users]]
[[Category:Portal builders]]
[[Category:Developers]]
[[Category:System operators]]

Don't forget to include the type of your content:

[[Category:Features]]
[[Category:Portlets]]
[[Category:Content types]]
[[Category:Fields]]
[[Category:Field controls]]
[[Category:Applications]]
...

..and if you write about an epic theme, include your own categories as well (for example: [[Category:Skin system]])

Be careful, the wiki content names are case sensitive! Category:Skin system != Category:Skin System


Feature information panel

This panel gives general information for the readers about the state of the feature in the software (edition/version/completeness.. see below). You need to include the Template:FeatureInfo at the top of your page with the following parameters:

Parameters of the FeatureInfo template
Possible values Description
editions wcm,ecm,comm Enumerate -with a comma separated list- the editions where the feature is implemented (wcm = Web, ecm = Enterprise, comm = Community)
fromversion x.xx

in progress

obsolete

The version number when the feature has implemented ('in progress' if not released yet, 'obsolete' if the feature is a legacy from previous versions)
wikicomplete 0-100% The completeness of the current documentation (wiki page)
interest enduser,builder,developer,sysop Enumerate -with a comma separated list- the people who are interested with the feature (enduser= end users, builder = portal builders, developer = developers/coders, sysop = system operators)
enduserlink

builderlink

developerlink

sysoplink

any Wiki page name If you want to create a separated feature page by profile, you can set those links with these parameters

Example

Wiki code:

{{FeatureInfo|editions=wcm,ecm|fromversion=6.0|wikicomplete=80%|interest=enduser,builder,developer|enduserlink=Feature for Enduser|builderlink=Feature for Builder}}

Preview:

  •  
  •  
  •  
  • 80%
  • 6.0
  • Enterprise
  • Community
  • Planned

Common elements for documentations

Table of Contents

Use the SNTOC template for your articles if needed. (This a right floated standard Wiki TOC)

Our TOCs are limited to 3 level depth, please take care of this if you are using the heading tags! (Are you sure about that you need the 3126th level in a content?)

Wiki code:

{{SNTOC}}

Images/Screenshots

If you want to put an image into your document, please follow MediaWiki guidelines about Images and use the 'thumb' mode with a caption whenever is possible! For screenshots, you have to use our Template:Screenshot template which provides a common look for every image. Before you upload any file be sure that the screenshot was taken from a 1024px wide browser's active area (without tool~ and scrollbars) and it's not smaller than 400px wide! If the screenshot doesn't cover the whole page, try to achieve a 4:3 aspect ratio for the image! (Don't create too wide or too tall images, please!)

There is an other template (Template:LeadImage) which works the same way as Screenshot, but produce a smaller, left or right floated image for overview sections. (Alignment depends on the third -optional- parameter of the template, default is 'left')

Example

Wiki code:

{{Screenshot|FullScreenshotExample.jpg|Example title}}

Preview:

Example title


Wiki code:

{{LeadImage|FullScreenshotExample.jpg|Example title|left}}

Preview:

Example title
Suspendisse ut ipsum eget libero luctus vestibulum. Phasellus scelerisque turpis nec lectus facilisis in consectetur massa placerat. Morbi ornare, tellus eget eleifend aliquam, lacus ligula sagittis metus, eget vulputate lorem nisl ut tellus. Maecenas rutrum odio aliquam nunc aliquam id rutrum enim rutrum. Etiam varius lobortis varius. Phasellus sollicitudin adipiscing bibendum. Pellentesque tincidunt, metus in luctus ultrices, dolor lorem hendrerit enim, id imperdiet turpis metus ornare metus. Cras a nulla lacus. Quisque massa ipsum, commodo rutrum mattis quis, venenatis ac massa. Mauris metus justo, ultrices non vestibulum id, auctor vitae dolor. Etiam eget elit metus. Fusce sed dolor turpis, vel dictum erat. Aliquam ornare, nibh in tempus scelerisque, lectus nibh venenatis sem, sed pharetra mauris justo non nisi. Nullam pharetra placerat mauris, eleifend eleifend tellus porta a.

Table

For tables we created a special css class (sn-table) which provides common style for every table in the documentation. If you want to highlight some of the cells or rows, user the dark css class! There are some templates to create simple icons into your tables like 'N/A' or 'Ok' sign. You can use them as usual:
{{ok}} - for ok / yes / true ..etc
{{na}} - for no / false / none / not available ..etc

Furthermore you can use the default MediaWiki syntax for tables.

Example

Wiki code:

{|class="sn-table"
|+ align="bottom" | '''Caption text'''
! table head 1
! table head 2
! table head 2
|-
|class="dark"| cell value 11
| cell value 12
| {{ok}}
|- class="dark"
|class="dark"| cell value 21
| cell value 22
| {{na}}
|-
|class="dark"| cell value 31
| cell value 32
| {{na}}
|}

Preview:

Caption text
table head 1 table head 2 table head 2
cell value 11 cell value 12 Ico-ok.gif
cell value 21 cell value 22 Ico-na.gif
cell value 31 cell value 32 Ico-na.gif

Source code

Use the built-in <source> tag for source code examples. Don't forget to set the correct language type!

Example

Wiki code:

<source lang="xml">
<xsl:template match="/">
    <xsl:apply-templates select="Content"/>
</xsl:template>
</source>

Preview:

<xsl:template match="/">
    <xsl:apply-templates select="Content"/>
</xsl:template>


Warning message

If you need a warning message in the documentation just use our Template:Warning template for that. The first parameter of the template will be the content of the warning box.

Example

Wiki code

{{Warning|This feature is incompatible with old settings!}}

Preview

This feature is incompatible with old settings!


Info message

If you need an informational message in the documentation just use our Template:Info template for that. The first parameter of the template will be the content of the information box.

Example

Wiki code

{{Info|This feature has made for demo purposes only!}}

Preview

This feature has made for demo purposes only!


Bug in the document

If you found some mistake/bug in the documentation just mark it with the BUG in the documentation  Template:bug template! We can filter these pages to fix them later. This template has an optional parameter where you can describe the problem shortly.

Example

Wiki code

Sense/Net is a {{bug| ASP.Net }}PHP based ECMS.

Preview

Sense/Net is a ASP.Net PHP based ECMS.

Link for live (localhost) examples

For live demo links you have to use our Template:Demo template. The first parameter should be the full url from the demo site on localhost!

Example

Wiki code

{{Demo|http://localhost/features/gallery}}

Preview

http://localhost/features/gallery This link works only if you have a live demo install on your localhost! (Don't forget! Some feature needs authentication and/or admin rights!)

Download

To display a binary download link, use the Template:Download template. The first parameter should be the name of the NuGet package.

Example

Wiki code

{{Download|SenseNet.Tools}}

Preview

SenseNet.Tools.png

Download source

To display a GitHub link, use the Template:DownloadSource template. The first parameter should be the name of the GitHub repository under the SenseNet organization.

Example

Wiki code

{{DownloadSource|sn-tools}}

Preview

sn-tools.png

Template pages

The following samples are the guidelines for specific page types in this wiki. Some of them includes a Category definition in the first lines between <includeonly> tags. In this case, don't forget to include this Category definition (without includeonly tags) in your created page!