Changeset 489029

Timestamp:

01/12/2012 09:28:18 PM (14 years ago)

Author:

divinenephron

Message:

Added a lot of documentation.

Location:

latex-everything/trunk

Files:

• class-latex-document.php (modified) (4 diffs)
• default-latex-template.php (modified) (2 diffs)
• latex-everything.php (modified) (1 diff)
• readme.txt (added)
• uninstall.php (modified) (1 diff)

latex-everything/trunk/class-latex-document.php

@@ -6 +6 @@
 
 /*
- * get_posts
- * typeset_all_files
- * get_template
- * get_title
- * get_name
- * get_parent_post_id
  */
 
@@ -43 +37 @@
  *      Return: String containing the pdf url.
  *
+ * Methods that must be defined by LE_Latex_Document subclasses
+ * - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+ *
+ * get_posts()
+ *      Return an array of post objects to be typset for the document.
+ *
+ * typeset_all_files()
+ *      Produce a single pdf file from the contents of $this->latex_files.
+ *      Return a string containing its path.
+ *
+ * get_template()
+ *      Return a string containing the path to the template to be used by
+ *      the document.
+ *
+ * get_title()
+ *      Return the title for the attachment (show on the attachment page and
+ *      on the admin screen).
+ *
+ * get_name()
+ *      Return the name of the attachment. This should be a slug. Used as the
+ *      PDF file's name.
+ *
+ * get_parent_post_id()
+ *      (optional) Return the id of the parent of the attachment, if this
+ *      attachment has one.
  */
+
 class LE_Latex_Document {
 
@@ -274 +294 @@
         return wp_get_attachment_url( $this->get_attachment_id() );
     }
+
+    function get_parent_post_id() {
+        return 0;
+    }
 }
 
@@ -329 +353 @@
         return 0;
     }
-
-    function get_parent_post_id() {
-        return 0;
-    }
 }
 

latex-everything/trunk/default-latex-template.php

@@ -6 +6 @@
 \setlength{\parindent}{0ex}
 
+% Note that there isn't a loop, just the_post()
+% This is because Latex isn't designed to typset multiple articles at once.
+% This template typesets a single post, then multiple PDFs will be stitched
+% together by the plugin, so please don't try to make The Loop.
 <?php the_post() ?>
 
+% Note I've used the lt() function.
+% The same job is done by latex_text() and get_latex_text() (which returns
+% a string rather than echoing it).
+% This function performs substitutions to make text pretty and suitable for
+% inclusion in macro arguments. If you don't wrap your output in it you
+% might get errors.
 \date{<?php lt( get_the_date() ) ?>}
 \title{<?php lt( get_the_title() ) ?>}
@@ -16 +26 @@
 \maketitle
 
+% Note the use of the h2l() function.
+% The same job is done by html_to_latex() and get_html_to_latex() (which
+% returns a string rather than echoing it).
+% This converts html into Latex equivalents, and can be found in
+% html-to-latex.php.
 <?php h2l( apply_filters( 'the_content', get_the_content() ) ) ?>
 
+% I've only tested this templating with string output functions such as
+% those shown above. I doubt other functions, most notably the is_something()
+% functions will work correctly.
 \end{document}

latex-everything/trunk/latex-everything.php

@@ -2 +2 @@
 /*
    Plugin Name: Latex Everything
-   Plugin URI: 
-   Version: 0.1
+   Plugin URI: http://wordpress.org/extend/plugins/latex-everything
+   Version: 1.0
    Author: Divinenephron (Devon Buchanan)
    Author URI: http://divinenephron.co.uk
-   Description: 
-   License: GPL
- */
-
-// TODO: Make documentation of API and install process.
+   Description: Produce PDF documents of everything on your site with Latex.
+   License: GPLv3
+ */
 
 global $latex_everything;
 $latex_everything = new Latex_Everything;
 
+include('latex-single-posts.php');
 include('latex-post-types.php');
-include('latex-single-posts.php');
 include('latex-terms.php');
+
+/* Latex_Everything
+ * - - - - - - - - 
+ *
+ * This class decides when to make documents and tells us where they are.
+ *
+ * LE_Latex_<type>_Controller
+ * - - - - - - - - - - - -
+ * These classes are used by Latex_Everything to decide which documents
+ * need to be created. There is one for each document type (post_type,
+ * term, single_post).
+ * 
+ * They are added to Latex_Everything with a function call, e.g.
+ *
+ *      global $latex_everything;
+ *      $latex_post_type_controller = new LE_Latex_Post_Type_Controller();
+ *      $latex_everything->add_controller( 'post_type', &$latex_post_type_controller );
+ *
+ * These controllers need to define certain methods to work
+ * 
+ * documents_for_post( $post_id )
+ *      Return an array of new documents. Latex_Everything will call generate() with them.
+ * 
+ * get_document( arg1, [$arg2] )
+ *      Return a single document object.
+ *
+ * get_settings()
+ *      Return an array containing the settings this controller cares about. It is in the form:
+ *      array( [0] => array( 'name' => "le_post_type_{$post_type}",
+ *                           'title' => "All {$post_type_obj->labels->name}" ),
+ *             [1] => ... );
+ *      Each 'name' index corresponds to a document the controller might generate (e.g. a document
+ *      containing a single post, all posts with a specific tag, or all posts of a custom type).
+ *      The user is able to activate or dactivate their generation with this setting, which should
+ *      be checked with in documents_for_post(). The 'title' index is a human-readable description.
+ */
 
 /* When the plugin is activated, create cron jobs to create the desired pdf.

latex-everything/trunk/uninstall.php

@@ -2 +2 @@
 if( !defined( 'ABSPATH') && !defined('WP_UNINSTALL_PLUGIN') )
     exit();
-
-// Remove every generated pdf
-$args = array( 'post_type' => 'attachment',
-           'numberposts' => -1,
-           'meta_key' => '_a2l_is_latex',
-           'meta_value' => 1,
-           ); 
-$attachments = get_posts($args);
-foreach ($attachments as $attachment)
-    wp_delete_attachment( $attachment->ID );
 
 /* Remove the options