Menu

#55 Tag alias for unorderedList and orderedList

open
nobody
None
5
2014-08-18
2013-10-30
No

How about using alias @ol for @orderedList and @ul for @unorderedList tags?
The use will be same:

@ol(
    @item Item 1
    @item Item 2
)

@ul(
    @item This is an item
    @item This is an item, too
)

Discussion

  • Michalis Kamburelis

    I don't know about this. Our tags do not look like HTML anyway, and do not follow HTML naming anyway (otherwise, why not @item -> @li, @bold -> @b...). Making shorter aliases doesn't seem too useful IMHO?

    I would much prefer to instead implement some wiki-like format parsing, so that you will not have to use any @-tags to make a list. E.g. something similar to MarkDown. See http://pasdoc.sipsolutions.net/MichalisKamburelis#More_wiki-like_syntax_for_pasdoc_descriptions . But that's indeed a larger feature.

     
  • Marcos Rocha

    Marcos Rocha - 2013-10-30

    In front of that, we have two critical points:
    Make sure that actual pasdoc features still working with new wiki format; or
    Change completely Pasdoc wiki language and give a tool to convert old to new wiki-like format.

    For the code I already know from Pasdoc, I think it will take several hours... over 100h, maybe.

     
    • Michalis Kamburelis

      That is why I propose to simply add a command-line like --wiki-syntax that will need to be used to activate wiki-like syntax. Wiki syntax will support the same pasdoc features (all @-tags will still be available, you will just have handy shortcuts when lists etc. are automatically detected).

       
      • Marcos Rocha

        Marcos Rocha - 2013-10-31

        That should be the better solution. I don't saw with details the tag parser, but I think it will simply add "alias" to actual tags to parse wiki syntax. Am I wrong?

         
        • Michalis Kamburelis

          That's one solution, yes. It could even be done as pre-processing step of the comment, i.e. first you run the description through some wiki engine that simply inserts the @unorderedList etc. tags into the description, and then you run it through normal processing.

          Or the "wiki engine" could be directly implemented in TTagManager, to handle the wiki features during normal text processing. Whatever is comfortable.

           

Log in to post a comment.

Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.