Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

MINOR Moved class-specific documentation from doc.silverstripe.org ba…

…ck into class-level PHPDoc (from r107726)

git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/cms/trunk@112611 467b73ca-7a2a-4603-9d3b-597d59a354a9
  • Loading branch information...
commit 78489ad4fcadc6f373d2d12316226979f45fadf6 1 parent d402ca5
@chillu chillu authored
Showing with 15 additions and 4 deletions.
  1. +5 −2 code/CMSMenu.php
  2. +10 −2 code/StaticExporter.php
View
7 code/CMSMenu.php
@@ -1,7 +1,10 @@
<?php
/**
- * The object manages the main CMS menu.
- * See {@link LeftAndMain::init()} for example usage.
+ * The object manages the main CMS menu. See {@link LeftAndMain::init()} for example usage.
+ *
+ * The menu will be automatically populated with menu items for subclasses of {@link LeftAndMain}.
+ * That is, for each class in the CMS that creates an administration panel, a CMS menu item will be created.
+ * The default configuration will also include a 'help' link to the SilverStripe user documentation.
*
* @package cms
* @subpackage content
View
12 code/StaticExporter.php
@@ -4,8 +4,16 @@
* It creates a huge number of folders each containing an index.html file.
* This preserves the URL naming format.
*
- * Requirements: Unix Filesystem supporting symlinking.
- * Doesn't work on Windows.
+ * Requirements: Unix Filesystem supporting symlinking. Doesn't work on Windows.
+ *
+ * <b>Usage</b>
+ *
+ * The exporter can only be invoked through a URL. Usage on commandline (through [sake](sake)) is not possible at the moment, as we're sending a file to the browser for download.
+ *
+ * <pre>http://localhost/StaticExporter/export</pre>
+ *
+ * Specify a custom baseurl in case you want to deploy the static HTML pages on a different host:
+ * <pre>http://localhost/StaticExporter/export?baseurl=http://example.com</pre>
*
* @see StaticPublisher
*
Please sign in to comment.
Something went wrong with that request. Please try again.