weseek__growi/packages/growi-plugin-attachment-refs/README.md

growi-plugin-attachment-refs

Install

1. install plugin

   yarn add growi-plugin-attachment-refs
   

2. build client app (see official documents)

Usage

ref tag

Syntax

$ref(file.txt)
$ref(file.txt, page=/somewhere/page)

Output

Options

• file : File name of reference file (default: the first argument)
• page : Target page path of reference file (default: current page)

refs tag

Syntax

$refs(/somewhere/page, regexp=/^file.*\.txt$/)

Output

Options

• page : Target page path to search attachments (default: the first argument || current page)
• prefix : Page prefix to search attachments
• depth : page depth to search attachments
• regexp : Regular Expression to retrieve
• format : File format filtering

refimg tag

Syntax

$refimg(pict.png, width=50%, alt=Pic)

Output

<img src="/attachment/xxxxx" width="50%" alt="Pic">

Options

• file : File name of reference file (default: the first argument)
• width : width
• height : height
• max-width : max-width
• max-height : max-height
• alt : alt text

refsimg tag

Syntax

$refsimg(/somewhere/page, regexp=/^.*\.png$/, max-width=200)

Output

<ul>
  <li><img src="/attachment/xxxxx" style="max-width: 200"></li>
  <li><img src="/attachment/yyyyy" style="max-width: 200"></li>
  <li><img src="/attachment/zzzzz" style="max-width: 200"></li>
</ul>

Options

• page : Target page path to search attachments (default: the first argument || current page)
• prefix : Page prefix to search attachments
• depth : page depth to search attachments
• regexp : Regular Expression to retrieve
• format : File format filtering
• width : width
• height : height
• max-width : max-width
• max-height : max-height
• layout : How to layout images (default: block)
  • block : set display: block
  • inline-block : set display: inline-block
  • col-6 : Grid layout with col-6 by Bootstrap
  • col-4 : Grid layout with col-4 by Bootstrap
  • col-3 : Grid layout with col-3 by Bootstrap
  • col-2 : Grid layout with col-2 by Bootstrap
  • col-1 : Grid layout with col-1 by Bootstrap

TODO

• depth option
• format option
• layout option