Archived talk

Difference between revisions of "Upgrading and Migrating FAQs version 1.0"

From Joomla! Documentation

m
(4 intermediate revisions by one other user not shown)
Line 1: Line 1:
This page seems like a good source to replace the various individual Wiki templates used in most "info boxes". The wiki extension "Labeled Section Transclusion" (LST) seems suitable to replace the regular (limited) transclusion feature.
+
This page is a good source to replace the various individual Wiki templates used in most "info boxes". The wiki extension "Labeled Section Transclusion" (LST) seems suitable to replace the regular (limited) transclusion feature. Update/upgrade instruction pages could then use "LST" to fetch the content from a ''labeled section'' (= heading) only, i.e. using the <tt>#section-h</tt> template function:
Update/upgrade instruction pages could then use "LST" to fetch the content from a section only, i.e. using the <tt>#section-h</tt> function:
 
 
  <nowiki>{{#section-h: Upgrading and Migrating FAQs | What is a patch?}}</nowiki>
 
  <nowiki>{{#section-h: Upgrading and Migrating FAQs | What is a patch?}}</nowiki>
 
results in:
 
results in:
 
<div style="margin:1ex 1em;">{{#section-h: Upgrading and Migrating FAQs | What is a patch?}}</div>
 
<div style="margin:1ex 1em;">{{#section-h: Upgrading and Migrating FAQs | What is a patch?}}</div>
  
Wrapped up in a wiki template on its own, which also takes care of the "ambox info style", this can be reduced to:
+
Wrapped in a wiki template, which also takes care of the "ambox info style", this can be reduced to:
 
  <nowiki>{{update_faq | What is a patch? }}</nowiki>
 
  <nowiki>{{update_faq | What is a patch? }}</nowiki>
and would trasclude the content.
+
and would transclude the content.
If an optional caption is supplied, it creates a link to the FAQ:
+
 
 +
If an optional caption is provided it creates a link to the FAQ instead:
 
  <nowiki>{{update_faq | What is a patch? | How to apply a patch package}}</nowiki>
 
  <nowiki>{{update_faq | What is a patch? | How to apply a patch package}}</nowiki>
 +
 
==Example renderings==
 
==Example renderings==
 
<!-- the must be NO SPACE surrounding the pipe for this demo. will be fixed in the "real" template -->
 
<!-- the must be NO SPACE surrounding the pipe for this demo. will be fixed in the "real" template -->
{{{{FULLPAGENAME}}/update_faq|1=What is a patch?}}
+
<nowiki>{{update_faq|What is a patch?}}</nowiki>
 +
{{{{FULLPAGENAME}}/update_faq|What is a patch?}}
 +
 
 +
<nowiki>{{update_faq|What is a patch?|How to apply a patch package}}</nowiki>
 +
{{{{FULLPAGENAME}}/update_faq|What is a patch?|How to apply a patch package}}
  
{{{{FULLPAGENAME}}/update_faq|1=What is a patch?|2=How to apply a patch package}}
+
And here's the temporary "template" :[[/update_faq/]]. DON'T use it in production :)

Revision as of 07:47, 19 November 2008

This page is a good source to replace the various individual Wiki templates used in most "info boxes". The wiki extension "Labeled Section Transclusion" (LST) seems suitable to replace the regular (limited) transclusion feature. Update/upgrade instruction pages could then use "LST" to fetch the content from a labeled section (= heading) only, i.e. using the #section-h template function:

{{#section-h: Upgrading and Migrating FAQs | What is a patch?}}

results in:

A patch in Joomla! is a bunch of bugfixes, and might or might not include security issues. The patch announcement will always tell if a patch has fixed security issues. A patch is a minor upgrade. From Joomla! 1.0.0 to Joomla! 1.0.7 is considered a patch. Going from Joomla! 1.0,x to Joomla! 1.5 will be a major upgrade and should be treated differently.

Wrapped in a wiki template, which also takes care of the "ambox info style", this can be reduced to:

{{update_faq | What is a patch? }}

and would transclude the content.

If an optional caption is provided it creates a link to the FAQ instead:

{{update_faq | What is a patch? | How to apply a patch package}}

Example renderings[edit]

{{update_faq|What is a patch?}}

Archived talk:Upgrading and Migrating FAQs version 1.0/update faq

{{update_faq|What is a patch?|How to apply a patch package}}

Archived talk:Upgrading and Migrating FAQs version 1.0/update faq

And here's the temporary "template" :update_faq. DON'T use it in production :)