From ac4d974abb73a7bcc1f04e76a3a307e8610d1ca7 Mon Sep 17 00:00:00 2001 From: Thomas Keller Date: Sat, 3 Dec 2011 02:23:37 +0100 Subject: [PATCH] Define and document the new resource embedding syntax in the FAQ, and while we're at it, also document that one can put simple relations as crew member instead of only "soft" issue links. --- src/IDF/templates/idf/faq.html | 23 +++++++++++++++++++++- src/IDF/templates/idf/wiki/createPage.html | 2 +- src/IDF/templates/idf/wiki/edit-info.html | 6 ++++-- 3 files changed, 27 insertions(+), 4 deletions(-) diff --git a/src/IDF/templates/idf/faq.html b/src/IDF/templates/idf/faq.html index 3df824f..73371c0 100644 --- a/src/IDF/templates/idf/faq.html +++ b/src/IDF/templates/idf/faq.html @@ -5,6 +5,7 @@
  • {trans 'What are the keyboard shortcuts?'}
  • {trans 'How to mark an issue as duplicate?'}
  • {trans 'How can I display my head next to my comments?'}
    • +
  • {trans 'How can I embed images and other resources in my documentation pages?'}
  • {trans 'What is this "Upload Archive" functionality about?'}
  • {trans 'What is the API and how is it used?'}
    • @@ -40,7 +41,9 @@ {blocktrans}

    This is simple:

      -
    1. Write in the comments "This is a duplicate of issue 123", change 123 with the corresponding issue number.
      2. +
    2. Write in the comments "This is a duplicate of issue 123" or - if you are a member of the crew - +directly add the "duplicates" relation with the value "123" below the comment field. Change "123" +with the corresponding issue number.
    3. Change the status of the current issue to Duplicate.
    4. Submit the changes.
    {/blocktrans} @@ -49,6 +52,24 @@

    {blocktrans}You need to create an account on Gravatar, this takes about 5 minutes and is free.{/blocktrans}

    +

    {trans 'How can I embed images and other resources in my documentation pages?'}

    + +{blocktrans} +

    To embed any previously uploaded resource into your wiki page, you can use the [!ResourceName] syntax.

    + +

    The rendering of the resource can then be further fine-tuned: +

    +

    + +Resources are versioned, just like wiki pages. If you update a resource, old wiki pages still show the state of the resource +at the time when the wiki page was edited. If you specifically want to update a resource on a page, you therefor need to update +the resource at first and then also the page where it is referenced, otherwise the change won't be visible until the next regular edit. +{/blocktrans}

    {trans 'What is this "Upload Archive" functionality about?'}

    diff --git a/src/IDF/templates/idf/wiki/createPage.html b/src/IDF/templates/idf/wiki/createPage.html index b5cdf48..9ef86a5 100644 --- a/src/IDF/templates/idf/wiki/createPage.html +++ b/src/IDF/templates/idf/wiki/createPage.html @@ -1,5 +1,5 @@ {extends "idf/wiki/base.html"} -{block docclass}yui-t1{assign $inCreatePage = true}{/block} +{block docclass}yui-t2{assign $inCreatePage = true}{/block} {block body} {if $preview} diff --git a/src/IDF/templates/idf/wiki/edit-info.html b/src/IDF/templates/idf/wiki/edit-info.html index 088421c..329a634 100644 --- a/src/IDF/templates/idf/wiki/edit-info.html +++ b/src/IDF/templates/idf/wiki/edit-info.html @@ -1,8 +1,10 @@ {assign $eurl = 'http://michelf.com/projects/php-markdown/extra/'} {assign $burl = 'http://daringfireball.net/projects/markdown/syntax'} +{aurl 'furl', 'IDF_Views::faq'} {blocktrans}

    Instructions:

    The content of the page can use the Markdown syntax with the Extra extension.

    -

    Website addresses are automatically linked and you can link to another page in the documentation using double square brackets like that [[AnotherPage]].

    -

    To directly include a file content from the repository, embrace its path with triple square brackets: [[[path/to/file.txt]]].

    +

    Website addresses are automatically linked and you can link to another page in the documentation using double square brackets like that [[AnotherPage]].

    +

    If you want to embed uploaded resources, use the [!ResourceName] syntax for that. This is described more in detail in the FAQ.

    +

    To directly include a file content from the repository, embrace its path with triple square brackets: [[[my/file.txt]]].

    {/blocktrans}