DMSF markup macros not in wiki help?

[DirkHoffmann]

As opposed to the statement made in the README, I do not find any help about the (very much appreciated) dmsf macros in the wiki editor/toolbar. It would be nice to have a list elsewhere, and unless a quick fix can be found to make them available online, I list here, what I could extract from macros.rb.

• dmsf - (download) link to DMSF file
• dmsff - link to a folder
• dmsfd - link to document's details
• dmsfdesc - text referring to the document's description
• dmfsversion - text referring to the document's version
• dmsflastupdate - text referring to the document's last update timestamp
• dmsft - link to the document's content preview
• dmsf_image - link to an image (restricted to some file formats)
• dmsf_video - link to a video (restricted to some file formats)
• dmsftn - link to an image thumbnail (restricted to some file formats, obviously)
• dmsfw - link to a document's approval workflow status

Usage: {{macro_name(dmsf_id)}}, e.g. {{dmsfd(1234)}} for the link to the details of DMSF document 1234.

From what I understood, DMFS numbers (IDs) are unique, no project-prefix needed. DMFS folder numbers use a separate, unique sequence.

[liaham]

Hi @DirkHoffmann ,

Did you notice that you can create a full list of all macros in any text field containing the wiki toolbar?

You only need to add the macro {{macro_list}} in a wiki page for example. This would be a quick first solution for your problem.

Best Regards, @liaham

[DirkHoffmann]

Yes, that's an excellent first solution!

However, a search for "dmsf macros textile redmine" does not give a single useful result. (I ended up finding this github repo, which is the best I could find. And of course, I can do a look-in-the-sourcecode, which is the most reliable source of information.) But I think it is still worth lowering the hurdle for Redmine users, who are not familiar with programming (in Ruby). So, unless there is a better solution already on the way, I would try to suggest an addition to the DMSF wiki (including correcting the link for cloning, which is outdated/dead). If OK, what would be the best way to do that?

[picman]

There is such a help in the wiki toolbar:

[liaham]

Much better. :)

[DirkHoffmann]

There is such a help in the wiki toolbar: [...]

What is the prerequisite to have this available in the standard editor? The icon shown in your screenshot is not available on my instance:

(And of course, that does not make it "googlable", even if it works in each Redmine instance.)

[picman]

The toolbar has been extended in DMSF v3.0.9. And, it is googlable as the help is an ordinary HTML page.

[DirkHoffmann]

Thanks for the indication. But would you mind to cite the URL of that ordinary HTML page here?

The first result close to a DMSF macro list that I get in a search for "redmine dmsf help page" is this one.

I get it also with the search term "redmine dmsf macro help page", in addition to this (wiki page)[https://hephaistos.lpp.polytechnique.fr/redmine/projects/instru/wiki/MacroList] based on a rather private initiative.

My point is that there should be an institutional DMSF-macro markup help page provided within the framework of this project. But I am done discussing. If you don't see the point, please close the ticket. My offer to provide an update to the wiki of this project is still valid though (albeit a bit difficult to introduce through PR). Just let me know.

[picman]

The URL is /plugin_assets/redmine_dmsf/help/en/wiki_syntax.html. Concerning updating the wiki page a problem is that I'm only a developer of this project. The owner left this project many years ago and I don't have the permission to manage access to the project. I think that there is no option to create a pull request for wiki. However, if you post txt version here, I will update it in the wiki.