emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Melanie Bacou <mel@mbacou.com>
To: emacs-orgmode@gnu.org
Subject: Re: [ox, patch] Add #+SUBTITLE
Date: Sat, 28 Mar 2015 04:26:19 -0400	[thread overview]
Message-ID: <mf5ojj$m73$1@ger.gmane.org> (raw)
In-Reply-To: <877fu49h0c.fsf@gmx.us>

See inline.

On 3/26/2015 6:42 AM, Rasmus wrote:
> Rasmus <rasmus@gmx.us> 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:          author1@email.com
                   author2@email.com
#+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:author1@email.com">author1@email.com</a>
Affiliation 1
</address>

<address>
Author 2
<a href="mailto:author2@email.com">author2@email.com</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 m.bacou@cgiar.org
Visit www.harvestchoice.org

      reply	other threads:[~2015-03-28  8:26 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-03-20 23:23 [ox, patch] Add #+SUBTITLE Rasmus
2015-03-21  2:26 ` Marcin Borkowski
2015-03-21  2:32   ` Melanie Bacou
2015-03-22 14:02 ` Nicolas Goaziou
2015-03-22 15:29   ` Rasmus
2015-03-22 20:47     ` Marcin Borkowski
2015-03-22 21:21       ` Thomas S. Dye
2015-03-22 21:23       ` John Williams
2015-03-22 22:43       ` Rasmus
2015-03-22 23:19         ` Marcin Borkowski
2015-03-23  0:05           ` Rasmus
2015-03-23  8:32             ` Marcin Borkowski
2015-03-23  9:00       ` Sebastien Vauban
2015-03-24  9:05     ` Nicolas Goaziou
2015-03-24  9:37       ` Rasmus
2015-03-28 15:17         ` Nicolas Goaziou
2015-03-26  2:36       ` Melanie Bacou
2015-03-26  2:38         ` Melanie Bacou
2015-03-26 10:10         ` Rasmus
2015-03-22 14:34 ` Eric Abrahamsen
2015-03-22 15:32   ` Rasmus
2015-03-23  1:17     ` Eric Abrahamsen
2015-03-26  2:47       ` Melanie Bacou
2015-03-26  9:52         ` Rasmus
2015-03-26 10:42           ` Rasmus
2015-03-28  8:26             ` Melanie Bacou [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to='mf5ojj$m73$1@ger.gmane.org' \
    --to=mel@mbacou.com \
    --cc=emacs-orgmode@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).