Difference between revisions of "Documentation/4.5/FAQ/Wiki"

From Slicer Wiki
Jump to: navigation, search
(Nightly -> 4.5)
 
 
Line 12: Line 12:
  
 
See [[Special:Listusers|Users List]]
 
See [[Special:Listusers|Users List]]
 +
 +
== How are FAQs organized ? ==
 +
 +
Both User and Developer FAQs are aggregation of sub-FAQs.
 +
 +
A sub-FAQ is domain specific set of questions.
 +
 +
'''Rational''': This is done to avoid duplication, facilitate maintenance and allow sub-FAQs to be included in any other pages.
 +
 +
'''Implementation''': This is achieved by [https://www.mediawiki.org/wiki/Transclusion Transclusion] using template functionality of MediaWiki to include the same content in multiple documents without having to edit those documents separately.
 +
 +
'''Editing FAQs''': By construction, it means that the questions listed in the User and Developer FAQs can NOT be edited directly, instead the transcluded templates should be edited. The list of templates used in any given page can conveniently be displayed by clicking on the "Templates used on this page" link at the bottom of any Edit page.

Latest revision as of 15:13, 5 January 2016

Home < Documentation < 4.5 < FAQ < Wiki


For the latest Slicer documentation, visit the read-the-docs.


Wiki

How to create a wiki account ?

See Create user account

How to list all wiki users ?

See Users List

How are FAQs organized ?

Both User and Developer FAQs are aggregation of sub-FAQs.

A sub-FAQ is domain specific set of questions.

Rational: This is done to avoid duplication, facilitate maintenance and allow sub-FAQs to be included in any other pages.

Implementation: This is achieved by Transclusion using template functionality of MediaWiki to include the same content in multiple documents without having to edit those documents separately.

Editing FAQs: By construction, it means that the questions listed in the User and Developer FAQs can NOT be edited directly, instead the transcluded templates should be edited. The list of templates used in any given page can conveniently be displayed by clicking on the "Templates used on this page" link at the bottom of any Edit page.