Browse Source

Docs: Better documentation of attributes for images

Carsten Dominik 16 years ago
parent
commit
babcfd2d58
2 changed files with 15 additions and 4 deletions
  1. 2 0
      doc/ChangeLog
  2. 13 4
      doc/org.texi

+ 2 - 0
doc/ChangeLog

@@ -1,6 +1,8 @@
 2009-02-11  Carsten Dominik  <carsten.dominik@gmail.com>
 
 	* org.texi (CSS support): Document CSS classes for section numbers.
+	(Links, Images in HTML export): Better documentation of hot to set
+	attribute for images.
 
 2009-02-05  Carsten Dominik  <carsten.dominik@gmail.com>
 

+ 13 - 4
doc/org.texi

@@ -8033,12 +8033,12 @@ publishing directory see @ref{Publishing links}.
 
 If you want to specify attributes for links, you can do so using a special
 @code{#+ATTR_HTML} line to define attributes that will be added to the
-@code{<a>} or @code{<img>} tags.  Here is an example that sets @code{alt} and
-@code{title} attributes for an inlined image:
+@code{<a>} or @code{<img>} tags.  Here is an example that sets @code{title}
+and @code{style} attributes for a link:
 
 @example
-#+ATTR_HTML: alt="This is image A" title="Image with no action"
-[[./img/a.jpg]]
+#+ATTR_HTML: title="The Org-mode homepage" style="color:red;"
+[[http://orgmode.org]]
 @end example
 
 @node Images in HTML export, Text areas in HTML export, Links, HTML export
@@ -8062,6 +8062,15 @@ will link to a high resolution version of the image, you could use:
 [[file:highres.jpg][file:thumb.jpg]]
 @end example
 
+If you need to add attributes to an inlines image, use a @code{#+ATTR_HTML},
+for example:
+
+@example
+#+CAPTION: A black cat stalking a spider
+#+ATTR_HTML: alt="cat/spider image" title="one second before action"
+[[./img/a.jpg]]
+@end example
+
 @noindent
 and you could use @code{http} addresses just as well.