emacs-orgmode
[Top][All Lists]
Advanced
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [O] [ox, patch] Add #+SUBTITLE

From: Melanie Bacou
Subject: Re: [O] [ox, patch] Add #+SUBTITLE
Date: Sat, 28 Mar 2015 04:26:19 -0400
User-agent: Mozilla/5.0 (Windows NT 6.1; WOW64; rv:31.0) Gecko/20100101 Thunderbird/31.5.0 
See inline.

On 3/26/2015 6:42 AM, Rasmus wrote:

Rasmus <address@hidden> writes:


<div class="page-header">
   <h1>This would be the title <small>and this the subtitle</small></h1>
</div>

ref: http://getbootstrap.com/components/#page-header


According to html5doctor.com:

     Note: Some have been advocating of the use of the small element to
     signify subtitles. This has been under discussion in the HTML working
     group, but no compelling arguments for its use have been
     made. Therefore it is not advised to use small to mark up subtitles.

That puts the nail in that coffin. . .
Right, not saying Bootstrap's implementation is pretty. More on Twitter Bootstrap (TWBS) though, as this has become one of the easiest and most expandable CSS frameworks (due to many contributed plugins). There is an existing org export backend for TWBS at https://github.com/marsmining/ox-twbs defining a series of TWBS export options in `org-export-twbs`. 

I found this package very useful because it allows:
- using TWBS default CSS theme, or any other CSS theme found for example at https://bootswatch.com/ - using any available TWBS JS plugin to add nifty features, like dynamic sidebar (useful for navigating long documents), menubar (when publishing more than 1 page), dynamic/sortable tables, etc. 
- support code highlighting
- is mobile-ready
Just FYI, but if you use Org to maintain technical documents or publish entire websites, this is very useful. 



Another commonly seen approach is this (many web CMS use this pseudo
standard):

<h1 class="title">My Title</h1>
<h2 class="subtitle">My Subtitle</h1>


This is basically how it's handled.  I guess you could get the former by
writing a custom preamble and disabling title export.


The same page as above leads to this interesting documents, which
unfortunately has draft in its name.

     http://www.w3.org/html/wg/drafts/html/master/semantics.html#sub-head

It suggests the following:

     <header>
     <h1>title</h1>
     <p>subtitle</p>
     </header>

I really like this one!  This is the HTML5 solution, it seems.  Then this
could be used for non-HTML5:

     <h1>Ramones <br>
     <span>Hey! Ho! Let's Go</span>
     </h1>

WDYT?

—Rasmus
I like the HTML5 solution as well, I'd vote for using this one as default in ox-html.
I also suggested in an earlier message adding (LaTeX, ODT, and HTML) support for the most common meta tags as well (all optional).
The multiple Authors, Emails, and Affiliation are required in quite a few LaTeX journal classes, but currently not supported in Org. I'd vote for using a similar markup approach as in YAML (with indented new lines), e.g. 


#+TITLE:          Document Title
#+SUBTITLE:       Document Subtitle
#+DATE:           2015-03-28
#+AUTHOR:         Author 1
                  Author 2
#+EMAIL:          address@hidden
                  address@hidden
#+AFFILIATION:    Affiliation 1
                  Affiliation 2
#+CLASSIFICATION: JEL
#+KEYWORDS:       H00, H87, F2, F12
#+DESCRIPTION:    Document description
#+REVISION:       1.0
#+COPYRIGHT:      Right Owner, 2015. All rights reserved.

ox-html could use these extra tags as follows:

<head>
<title>Document Title</title>
<meta name="title" content="Document Title" />
<meta name="date" content="2015-03-28" />
<meta name="author" content="Author 1, Author 2" />
<meta name="keywords" content="JEL: H00, H87, F2, F12" />
<meta name="description" content="Document description" />
<meta name="classification" content="JEL" />
<meta name="copyright" content="Right Owner, 2015. All rights reserved."/>
<meta name="version" content="revision"/>

<meta name="citation_title" content="Document Title" />
<meta name="citation_publication_date" content="2015-03-28" />
<meta name="citation_author" content="Author 1" />
<meta name="citation_author" content="Author 2" />
</head>

<body>

<header>
<h1>Document Title</h1>
<p>Document Subtitle</p>
<p>Revision 1.0, <time datetime="2015-03-28">2015-03-28</time></p>
</header>

<address>
Author 1
<a href="mailto:address@hidden";>address@hidden</a>
Affiliation 1
</address>

<address>
Author 2
<a href="mailto:address@hidden";>address@hidden</a>
Affiliation 2
</address>
<div class="classification"><label>Classification</label> JEL: H00, H87, F2, F12</div> <div class="copyright"><label>Copyright</label> Right Owner, 2015. All rights reserved.</div> <div class="description"><label>Description</label> Document description</div> 

<div class="abstract"><label>Abstract</label> Document abstract</div>

<div class="toc"><label>Contents</label> [TOC]</div>
<div class="toc"><label>Tables</label> [TOC:tables]</div>
<div class="toc"><label>Figures</label> [TOC:figures]</div>
<div class="toc"><label>Equations</label> [TOC:equations]</div>
<div class="toc"><label>Listings</label> [TOC:listings]</div>

[...]


<div class="bibliography">
<h2>References</h2>
[BIBLIOGRAPHY]
</div>

</body>

See ref:
- http://dev.w3.org/html5/spec-author-view/the-meta-element.html#the-meta-element 
- https://scholar.google.com/intl/en/scholar/inclusion.html#indexing
- http://html5doctor.com/the-address-element/
I'm probably opening Pandora's box here, but in my long experience this is the information that's most commonly found or required in any type of publication or technical document. 

Would be useful to hear others' opinions.

--
Melanie BACOU
International Food Policy Research Institute
Snr. Program Manager, HarvestChoice
E-mail address@hidden
Visit www.harvestchoice.org
reply via email to
[Prev in Thread] Current Thread [Next in Thread]