cfillion / reapack-index

Package indexer for git-based ReaPack repositories
GNU General Public License v3.0
28 stars 1 forks source link

[FR] Reapack-index desn't recognize block comment #9

Closed MathieuCGit closed 2 years ago

MathieuCGit commented 2 years ago

Hello,

I'm trying to use reapack but it seems reapack index doesn't recognize lua block comment. BUT block comments are a very easier (and clearer) way to write long description into a code file. In additoin I should mentioned I'm trying to figure out what is the best workflow to get luadox and reapack working together.

here is my header :

-- Description: Draw separator on folder track - aka A la Logic X
-- Author: Mathieu CONAN   
-- Version: 0.0.1
-- Changelog: Initial release
-- Link: Github repository https://github.com/MathieuCGit/MC_VariousScripts
--[[ About: This script aims to reproduce the folder separation in a way Logic X does it.
   ## Draw separator on folder track

   This script aimes to provide a mechanism similar to the one in LogicProX to separate 
   folders in the Arrange View.

---
   ## Options

   Actually you have to customize your preferences directly into the script.

  **``TRACK_HEIGHT``**
    This **MUST** be **AT LEAST** 2 pixels higher than the size defined in Preferences > Apparence > Media > "Hide labels for items when item take lane height is less than". 
    You also have to uncheck "draw labels above items, rather than within items"
    _Default value is **``28``**_ but I got better result with 20pixels.
   - Default 6 and dafault 5 theme TRACK_HEIGHT=25. 
   - 25 Also works with Jane, Funktion.
   - iLogic V2 = 28
   - iLogic V3 = 24
   - Flat Madness and CubeXD= 22

   **``TRACK_COLOR_SINGLE``**
    Do you want all the item folder to get the same color ? Otherwise, default folder track color will be used. _Default is **``0``**_

   **``TRACK_COLOR``**
    Use RGB color code. _Default is **``{111,121,131}``**_

   **``TRACK_COLOR_DARKER_STEP``**
    This is the amount of darkness yo uwant to apply to default track color. 0 means NO darkness. _Default is **``25``**_

   User profile [https://forum.cockos.com/member.php?u=153781]([https://forum.cockos.com/member.php?u=153781])

---
 ]]--
-- Licence: GPL V3.0

Markdown syntax is validated with : https://spec.commonmark.org/dingus/ as mentioned in the documentation https://github.com/cfillion/reapack-index/wiki/Packaging-Documentation

cfillion commented 2 years ago

reapack-index requires the indentation and decoration of every line in a multi-line tag to be identical (it's language-agnostic). In the snippet above the about tag is decorated with "--[[". The subsequent lines (until the next tag) are expected to begin with the same (+ an additional arbitrary indentation level).

You could do this (no decoration to be repeated on every line):

--[[
@version 1.0
@about
  Line 1
  Line 2
  ...
--]]
MathieuCGit commented 2 years ago

Okkaayyy ! Thanks, I missed this part in the documentation, sorry :-s

Here is the final version i used, if someone passing by look for an example.

--[[--
Description: Draw separator on folder track - aka A la Logic X
Author: Mathieu CONAN   
Version: 0.0.1
Changelog: Initial release
Link: Github repository https://github.com/MathieuCGit/MC_VariousScripts
About: This script aims to reproduce the folder separation in a way Logic X does it.
   ## Draw separator on folder track

   This script aimes to provide a mechanism similar to the one in LogicProX to separate 
   folders in the Arrange View.

   ---
   ## Options

   Actually you have to customize your preferences directly into the script.

   **``TRACK_HEIGHT``**
    This **MUST** be **AT LEAST** 2 pixels higher than the size defined in Preferences > Apparence > Media > "Hide labels for items when item take lane height is less than". 
    You also have to uncheck "draw labels above items, rather than within items"
    _Default value is **``28``**_ but I got better result with 20pixels.
   - Default 6 and dafault 5 theme TRACK_HEIGHT=25. 
   - 25 Also works with Jane, Funktion.
   - iLogic V2 = 28
   - iLogic V3 = 24
   - Flat Madness and CubeXD= 22

   **``TRACK_COLOR_SINGLE``**
    Do you want all the item folder to get the same color ? Otherwise, default folder track color will be used. _Default is **``0``**_

   **``TRACK_COLOR``**
    Use RGB color code. _Default is **``{111,121,131}``**_

   **``TRACK_COLOR_DARKER_STEP``**
    This is the amount of darkness yo uwant to apply to default track color. 0 means NO darkness. _Default is **``25``**_

   User profile [https://forum.cockos.com/member.php?u=153781]([https://forum.cockos.com/member.php?u=153781])

   ---
]]--

Thanks for the clarification :)