Bug 639145 - shorthand syntax for headings
shorthand syntax for headings
Status: RESOLVED FIXED
Product: gtk-doc
Classification: Platform
Component: general
unspecified
Other Linux
: Normal enhancement
: 1.18
Assigned To: gtk-doc maintainers
gtk-doc maintainers
:
Depends on:
Blocks:
  Show dependency tree
 
Reported: 2011-01-10 14:46 UTC by Matthias Clasen
Modified: 2011-03-29 19:26 UTC (History)
1 user (show)

See Also:
GNOME target: ---
GNOME version: ---

Attachments
Add an attachment (proposed patch, testcase, etc.)

Description Matthias Clasen 2011-01-10 14:46:32 UTC 
After moving most long descriptions in gtk inline, it is becoming apparent that a shorthand syntax for section headings would be very nice for avoiding lots of xml in the sources.

Markdown has something like

## some heading ##

bla bla

### deeper heading ###

bla bla


Which would fit the bill, imo
Comment 1 Stefan Sauer (gstreamer, gtkdoc dev) 2011-03-29 18:32:32 UTC 
Yes, this and simple lists would be nice to have. I am giving this a try now.
Comment 2 Stefan Sauer (gstreamer, gtkdoc dev) 2011-03-29 19:26:56 UTC 
Matthias, I have added support for

# some heading #

and

some heading
============

If needed I can add support for

## deeper heading ##
### even deeper heading ###

and

deeper heading
--------------

even deeper heading
~~~~~~~~~~~~~~~~~~~

but I think one level should be enough for most docs. Please reopen if you need more. Will now try to do lists.

commit 5d0ca8c60b20a907040d1e69f128c687ce9f3b8b
Author: Stefan Kost <ensonic@users.sf.net>
Date:   Tue Mar 29 22:23:04 2011 +0300

    mkdb: start simple markdown parser
    
    Turn ConvertBlankLines into a function that handles MarkDown. In addition to
    paragraph markers we now handle simple subsections.
    
    Fixes: #639145
Note You need to log in before you can comment on or make changes to this bug.