Extension/Plugin Notation

Outline

1. Syntax
2. List
   1. BR
   2. PageBreak
   3. PageOutline
   4. Include
   5. Embed
   6. Thumb
   7. LinkAttach
   8. Footnote
   9. TitleIndex
   10. PageNavi
   11. RecentChanges
   12. ReleaseList
   13. RecentTickets
   14. RecentActivity
   15. RecentCommit
   16. RepositoryInfo
   17. RepositoryReadme
   18. ProjectName
   19. ProjectDescription
   20. paste

Syntax

[[PluginName]]
[[PluginName(arg1, arg2, arg3...)]]

List

BR

• Argument
  • clear={left|right|both}

• Example:

  You can force line break [[BR]] in a sentence.
  You could also use it [[BR(clear=left)]] to cancel wraparound, but you need to be careful.
  

You can force line break
in a sentence. You could also use it
to cancel wraparound, but you need to be careful.

You could do this when you want to force a line break at a specific place. But, in general, try to divide paragraph with blank line.

Currently, clear=right, clear=all are not of very much use. If you use this, (due to the current HTML structure) string text after the line break will be placed below the side bar.

PageBreak

• Argument: nothing
• Example:

  When creating or printing PDF, here,
  [[PageBreak]]
  a page break will be inserted.
  

When creating or printing PDF, here,

a page break will be inserted.

It will assign the exact place for a line break to print/create PDF. You can use this when you want to insert a page break.

PageOutline

• Argument:
  • start=N - assign the header level which starts the tree expression on N . (default=1)
  • depth=N - assign the depth to be expressed on N (default=3)
  • type={ordered|unordered} - choose whether to number the tree items or not. (default=ordered)
• Example:

  [[PageOutline]]
  [[PageOutline(start=2, depth=9, type=unordered)]]
  

It will generate a list of navigation headers on the spot where you insert .

Outline

1. Extension/Plugin Notation
   1. Syntax
   2. List
      1. BR
      2. PageBreak
      3. PageOutline
      4. Include
      5. Embed
      6. Thumb
      7. LinkAttach
      8. Footnote
      9. TitleIndex
      10. PageNavi
      11. RecentChanges
      12. ReleaseList
      13. RecentTickets
      14. RecentActivity
      15. RecentCommit
      16. RepositoryInfo
      17. RepositoryReadme
      18. ProjectName
      19. ProjectDescription
      20. paste

Outline

• Syntax
• List
  • BR
  • PageBreak
  • PageOutline
  • Include
  • Embed
  • Thumb
  • LinkAttach
  • Footnote
  • TitleIndex
  • PageNavi
  • RecentChanges
  • ReleaseList
  • RecentTickets
  • RecentActivity
  • RecentCommit
  • RepositoryInfo
  • RepositoryReadme
  • ProjectName
  • ProjectDescription
  • paste

Include

• Argument: page_name
• Example:

  [[include(WikiPlugins)]]
  

It will embed other pages at the current spot. Nest for loading is limited to 4 tiers.

Embed

• Argument:
  • attached file name
  • caption=string text for caption
  • float={right|left}
• Example:

  [[Embed(hello.rb)]]
  [[Embed(https://static.osdn.jp/magazine/magazine-h23.png)]]
  [[Embed(magazine-300x88.png, caption=OSDN Magazine Logo)]]
  [[Embed(magazine-300x88.png, float=right)]]
  

It embeds the file at current location in expanded state as much as possible. It can handle images, all kinds of source codes, diff, text, PDF, and Flash. With “page name: file name”, you can load files of other pages. By assigning URL starting with http(s) for the file name, you can embed external sites images as well.

 def hello(name)
   puts "Hello, #{name}!"
 end
 
 hello "world"

OSDN Magazine Logo

If you assign cation=, you can add caption to the image. If this option is assigned , you can no longer display inline image. If the caption is assigned, it will be centered at default.

By assigning float, you can position it either to the left or right, or go around the text. (But, as of now, you can't make it to clear.)

Thumb

• Arguments:
  • attachment filename
  • caption=caption text
  • float={right|left}
  • size={small|default|large|NNNxNNN}
• Example:

  [[Thumb(slashdot-jp.png, size=240x240, caption=SRAD on Konqueror)]]
  

SRAD on Konqueror

It automatically converts image to thumbnail. The options are basically the same as Embed, but you can not pass on anything except image files.

You can specify the size of thumbnail if you pass on the size to size=. You can specify it to be "small" (128x128), "default" (300x300), "large" (480x480), or you can also assign a string, like any number x any number (for example 123 x 456). If you omit this value, it will be set to default. The actual image will be the largest rectangle that fits the inner edge to the specification.

LinkAttach

• Arguments:
  • attachment filename
  • caption=text used for display
• Example:

  You can create a link to an attachment [[LinkAttach(slashdot-jp.png)]] like this from within a text, . If you write a caption, that message will be [[LinkAttach(slashdot-jp.png, caption=displayed)]] instead of the filename.
  

You can create a link to an attachment slashdot-jp.png like this from within a text, . If you write a caption, that message will be displayed instead of the filename.

Footnote

• Argument:
  • A string text you want to use as footnote.
• Example:

  You can write anything you want as long as it is contained in one line. [[Footnote(But you can not use comma as of now)]]
  

You can write anything you want as long as it is contained in one line. *1

It will display the footnote at the bottom and embed the link to that footnote. Due to the syntax, currently you can not insert comma “,”.

It can interpret all kinds of links, but, as of now, you can not use inline style.

TitleIndex

• Arguments (The first “identifier=” can be omitted. Upon omitting, if it's a value, it will be treated as max, and everything else will be treated as prefix.)
  • max=maximum display number (default 1024)
  • prefix=generate a list of pages based on prefix only
  • exclude=prefix that excludes pages from the list
• Example:

  [[TitleIndex(10)]]
  [[TitleIndex(FAQ/)]]
  [[TitleIndex(prefix=FAQ/, max=1024)]]
  [[TitleIndex(prefix=FAQ/, prefix=Help/, exclude=FAQ/member)]]
  

This is used to display a list of pages.

You can write multiple prefixes and excludes (the order is irrelevant). Without the prefix, it will list all the pages.

PageNavi

• Argument:
  • This page maintains a list that shows page structure
• Example:

  [[PageNavi(NavigationList)]]
  

  • NavigationList fed to the argument:

     * [WikiGuide Wiki Documents]
       * [WikiSyntax Wiki Syntax]
       * [WikiLinks Wiki Links]
       * [WikiBlockProcessor Block Processor]
       * [WikiPlugins Extension / Plugin]
       * [WikiSideBar Sidebar]
    

You can embed page navigation bar to display “above page”, “previous page”, “next page”. You can feed Wiki page to the argument, that maintains the structure list of all pages, like NavigationList.

The navigation bar will not be displayed if the page is not included in the Wiki page fed to the argument.

RecentChanges

• Arguments (You can omit the first “identifier=” . In that case, if it is a value, it will be treated as max, and others will be treated as prefix.)
  • max=maximum display number (default 60)
  • prefix=generate a list of pages specifically based on prefix
  • exclude=prefix that excludes pages from the list
• Example:

  [[RecentChanges(10)]]
  [[RecentChanges(FAQ/)]]
  [[RecentChanges(prefix=FAQ/, max=1024)]]
  

This is used to display recent update.

The options are the same as TitleIndex.

ReleaseList

• Arguments:
  • Project name (optional)
• Example:

  [[ReleaseList(sevenzip)]]
  

It displays a box for a list of the latest release files. By specifying a profile name, you can display another project. Currently you can not customize the looks. Because it is displayed to fill the width, you might want to use it for side bar.

RecentTickets

• Argument:
  • limit=display number (optional. When omitted, it is set to 10.)
• Example:

  [[RecentTickets(limit=3)]]
  

It will display a list of tickets that were recently updated.

RecentActivity

• Arguments:
  • max=display number (optional. When omitted, it is set to 10.)
  • style={list,table} (optional. When omitted, it is set to list.)
• Example:

  [[RecentActivity(max=5)]]
  

It displays the recent activity history. If you choose list for style, it is displayed in a list form same as RecentChanges and such, and if you choose table for style, it is displayed in a table form.

RecentCommit

• Argument: nothing
• Example:

  [[RecentCommit]]
  

It displays a list of recent repository commits. (This is not offered to Projects.)

RepositoryInfo

• Argument: nothing
• Example:

  [[RepositoryInfo]]
  

It displays a link buttons that is linked to Chamber's repository URL or code browser. (This is not offered to Projects.)

RepositoryReadme

• Argument: nothing
• Example:

  [[RepositoryReadme]]
  

It displays README file within the code repository. (This is not offered to Projects.)

ProjectName

• Argument: nothing
• Example:

  [[ProjectName]]
  

It embeds the name of a Project or Chamber. If it's a Project, with a translator that renders into a certain language, it will be translated suitably.

ProjectDescription

• Argument: nothing
• Example:

  [[ProjectDescription]]
  

It embeds the description of a Project or Chamber. If it's a Project, with a translator that renders into a certain language, it will be translated suitably.

paste

• Argument:
  • Pastebin number (The last digit of the of a pastebin URL.)
• Example:

  [[paste(1)]]
  

 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
 <head>
  <meta http-equiv="content-type" content="application/xhtml+xml; charset=UTF-8" />
  <title>Hello, World!</title>
 </head>
 <body>
  <p>Hello, World!</p>
 </body>
 </html>
 

It embeds the pastebin to the OSDN Pastebin. You will need the pastebin number.

1. *1But you can not use comma as of now