Changeset 698347

Timestamp:

04/16/2013 08:28:10 AM (13 years ago)

Author:

divinenephron

Message:

Changed the readme formatting and installation instructions.

File:

• latex-everything/trunk/readme.txt (modified) (6 diffs)

latex-everything/trunk/readme.txt

@@ -25 +25 @@
 1. This plugin requires `pdflatex` and `pdftk` installed. You can check for
 these by executing `which pdflatex` and `which pdftk` on your host.
-2. Upload latex fold to the /wp-content/plugins/ directory
+2. This plugin also requires you to know at least enough about Wordpress to
+cut-and-paste code into your theme.
+2. Upload this plugin to the /wp-content/plugins/ directory.
 3. Activate the plugin Latex for WordPress through the 'Plugins' menu in
-WordPress.
-4. Link to the pdf version of a post by putting the following into The Loop:  
+WordPress. Behind the scenes it will generate PDFs for your posts using a
+default Latex template.
+4. Link to the PDF version of a post by putting the following into [The Loop][the-loop]:  
         `<a href="<?php the_latex_url( 'single_post', get_the_ID() ) ?>">PDF Version</a>`
 5. For more advanced usage (user-defined templates and generating Latex
-documents for other things) see the Frequently Asked Questions.
+documents for pages, categories and others) see the [Frequently Asked Questions][faq].
+
+[the-loop]: http://codex.wordpress.org/The_Loop
+    "Documentation for The Loop in WordPress."
+[faq]: http://wordpress.org/extend/plugins/latex-everything/faq/
+    "FAQ for Latex Everything."
 
 == Frequently Asked Questions ==
@@ -38 +46 @@
 
 If something isn't working, check this FAQ for a relevant answer. If there isn't one,
-create a new topic in the [plugin forum](http://wordpress.org/tags/latex-everything?forum_id=10#postform)
-and the author will try to get back to you.
+create a new topic in the [plugin forum][forum] and the author will try to get back to you.
+
+[forum]: http://wordpress.org/tags/latex-everything?forum_id=10#postform
+    "The forum where questions can be asked about Latex Everything."
 
 = How do I typeset things besides posts? =
@@ -82 +92 @@
 The arguments you give depend on the type of PDF document you're requesting:
 
-For a `single_post` PDF:  
-    `the_latex_url( 'single_post', (int) $post_id )`
+For a `single_post` PDF:
+
+    the_latex_url( 'single_post', (int) $post_id )
 
 For a `post_type` PDF:  
-    `the_latex_url( 'post_type', (string) $post_type )`
+    
+    the_latex_url( 'post_type', (string) $post_type )
 
 For a `term` PDF:  
-    `the_latex_url( 'term', (int) $term_id, (string) $taxonomy)`
+    
+    the_latex_url( 'term', (int) $term_id, (string) $taxonomy)
 
-Here's how you would use them in The Loop.  
-    `<a href="<?php the_latex_url( 'single_post', get_the_ID() ) ?>">PDF of this post</a>`  
-    `<a href="<?php the_latex_url( 'post_type', get_post_type() ) ?>">PDF of all posts</a>`  
-    `<?php foreach( get_the_category() as $category ) : ?>`  
-    `<a href="<?php the_latex_url( 'term', $category->cat_ID, 'category' ) ?>">PDF of a category</a>`  
-    `<?php endforeach; ?>`  
+Here's how you would use them in The Loop.
+
+    <a href="<?php the_latex_url( 'single_post', get_the_ID() ) ?>">PDF of this post</a>
+    <a href="<?php the_latex_url( 'post_type', get_post_type() ) ?>">PDF of all posts</a>
+    <?php foreach( get_the_category() as $category ) : ?>
+    <a href="<?php the_latex_url( 'term', $category->cat_ID, 'category' ) ?>">PDF of a category</a>
+    <?php endforeach; ?>
 
 NB: These don't automatically figure out which post you're on while in The Loop,
@@ -102 +116 @@
 
 If you are going to use these functions in a theme, check they exist and produce
-a url first:  
-    `<?php if( function_exists('get_latex_url')`  
-    `          && $latex_url = get_latex_url( 'single_post', get_the_ID() ) ): ?>`  
-    `<a href="<?php echo $latex_url ?>">PDF</a>`  
-    `<?php endif; // get_latex_permalink ?>`  
+a url first:
+
+    <?php if( function_exists('get_latex_url')
+              && $latex_url = get_latex_url( 'single_post', get_the_ID() ) ): ?>
+    <a href="<?php echo $latex_url ?>">PDF</a>
+    <?php endif; // get_latex_permalink ?>
 
 = How do I use my own Latex Templates? =
@@ -115 +130 @@
 
 For a `single_post` PDF:  
-    `latex-single-<post_type>-<post id>.php`  
-    `latex-single-<post_type>-<post slug>.php`  
-    `latex-single-<post_type>.php`  
-    `latex-single.php`
-    `latex.php`  
 
-For a `post_type` PDF:  
-    `latex-post-type-<post type name>.pdf`  
-    `latex-post-type.pdf`  
-    `latex.pdf`
+    latex-single-<post_type>-<post id>.php 
+    latex-single-<post_type>-<post slug>.php 
+    latex-single-<post_type>.php 
+    latex-single.php 
+    latex.php 
 
-For a `term` PDF:  
-    `latex-term-<taxonomy>-<term id>.pdf`  
-    `latex-term-<taxonomy>-<term slug>.pdf`  
-    `latex-term-<taxonomy>.pdf`  
-    `latex-term.pdf`  
-    `latex.pdf`  
+
+For a `post_type` PDF:
+
+    latex-post-type-<post type name>.pdf
+    latex-post-type.pdf
+    latex.pdf
+
+For a `term` PDF:
+
+    latex-term-<taxonomy>-<term id>.pdf
+    latex-term-<taxonomy>-<term slug>.pdf
+    latex-term-<taxonomy>.pdf
+    latex-term.pdf
+    latex.pdf
 
 Look at `default-latex-template.php` in the plugin directory for guidance as to
@@ -140 +159 @@
 The plugin has been built with the intention of being extensible. The internals
 have documentation in comments, and if you want to know how to do something that
-isn't obvious, create a new topic in the [plugin forum](http://wordpress.org/tags/latex-everything?forum_id=10#postform)
+isn't obvious, create a new topic in the [plugin forum][forum]
 and the author will try to get back to you.
+
+[forum]: http://wordpress.org/tags/latex-everything?forum_id=10#postform
+    "The forum where questions can be asked about Latex Everything."
 
 == Screenshots ==