Recent Changes

2021-04-09
2021-03-17
2021-03-08
2021-03-03
2021-01-22
2021-01-21

Extension/Plugin Notation

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 .

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.

  1. def hello(name)
  2. puts "Hello, #{name}!"
  3. end
  4. hello "world"
magazine-h23.png

magazine-300x88.png
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.

magazine-300x88.png

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)]]
    

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.

LineComment

  • Argumenst:
    • rows=value
    • direction={above|below}
  • Example:
    [[LineComment]]
    
:
  • 1
    -- zbdrariI (2021-04-09 02:59:41 JST)
  • 1
    -- zbdrariI (2021-04-09 02:59:35 JST)
  • 1
    -- zbdrariI (2021-04-09 02:59:27 JST)
  • 1
    -- zbdrariI (2021-04-09 02:59:21 JST)
  • 1
    -- zbdrariI (2021-04-09 02:57:41 JST)
  • 1
    -- zbdrariI (2021-04-09 02:57:34 JST)
  • 1
    -- @@IHjeT (2021-04-09 02:57:27 JST)
  • 1
    -- 1

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