Commits

Kai Wu committed f3f2be6

Minor edits for consistency, and clarified explanation of image file insertion.

  • Participants
  • Parent commits fab6256

Comments (0)

Files changed (1)

File example/sample.org

 #+TITLE: o-blog
-#-DESCRIPTION: A stand-alone blogging system for Org-mode
+#-DESCRIPTION: A stand-alone blogging system for Org-mode.
 #+DATE: 2012-08-21 11:02:33
 
 #+STARTUP: logdone
 
 #+end_src
 
-** DONE Some bootstrap features				    :usage:Bootstrap:
+** DONE Some Bootstrap features                            :usage:Bootstrap:
    CLOSED: [2012-05-03 Thu 21:40]
 
 *** Hero-unit
 
 #+begin_o_blog_row 8
 
-Adding an image to a post is pretty simple since
-[[http://orgmode.org][Org-mode]] offers a special link scheme for
-that. Image source file can be stored anywhere since its path is
-valid. During the export process, the image file is copied into a folder
-related to the post and all links are corrected to point to its new
-location.
+Adding an image to a post is simple since [[http://orgmode.org][Org-mode]] offers a special
+link scheme for that. An image file can be stored anywhere in your
+local directory structure with a valid path. During the export
+process, the image file is copied into a folder related to the post,
+and all exported links are corrected to point to its new location.
 
 
 #+begin_o_blog_row 5
 
-For example, the following piece of code will copy the =emacs-logo.png= from the current
-directory and is is then copied into it into
+For example, the Org-mode markup of =file:emacs-logo.png= surrounded
+by [[http://orgmode.org/org.html#Link-format][double square brackets]] will result (upon export/publishing) in
+copying that image from its current location (in the same directory as
+this sample.org file) to its target location of
 =tips/2012/08/21_adding-an-image-into-a-post/emacs-logo.png=.
 
 #+o_blog_row_column 3
 
-
 #+BEGIN_SRC org
- file:emacs-logo.png
+# NOTE: double square brackets should surround file:emacs-logo.png but are not shown:
+file:emacs-logo.png
 #+END_SRC
 
 #+end_o_blog_row
 
 
-
 #+o_blog_row_column 4
 [[file:emacs-logo.png]]
 
 #+end_o_blog_row
 
 
-
-The HTML result is something similar to:
+The exported HTML result will resemble:
 
 #+BEGIN_SRC html
  <img src="21_adding-an-image-into-a-post/emacs-logo.png"  alt="21_adding-an-image-into-a-post/emacs-logo.png" />
 
 
 
-A best practice is to have all files info a =/files= folder. Then you can
-create a sub-folder for each posts such as:
- - =/files/post1/file1=
- - =/files/post1/file2=
- - =/files/post2/file=
- - ...
+To keep files organized, you can place all files under a subfolder,
+e.g. =media/=. Then you can create a sub-folder for each post, such
+as:
+- =/media/post1/file1=
+- =/media/post1/file2=
+- =/media/post2/file=
+- etc.