docs(views): documented the difference between page/elements/foot and

footer fixes: #3330
Elgg · Feb 23, 2015 · 001be7e · 001be7e
1 parent 99cbd32
commit 001be7e
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/docs/guides/views.rst b/docs/guides/views.rst
@@ -270,4 +270,5 @@ Related
 
    views/page-structure
    views/simplecache
+   views/foot-vs-footer
 
diff --git a/docs/guides/views/foot-vs-footer.rst b/docs/guides/views/foot-vs-footer.rst
@@ -0,0 +1,16 @@
+Page/elements/foot vs footer
+============================
+
+``page/elements/footer`` is the content that goes inside this part of the page:
+
+.. code-block:: html
+
+	<div class="elgg-page-footer">
+		<div class="elgg-inner">
+			<!-- page/elements/footer goes here -->
+		</div>
+	</div>
+
+It's content is visible to end users and usually where you would put a sitemap or other secondary global navigation, copyright info, powered by elgg, etc.
+
+``page/elements/foot`` is inserted just before the ending ``</body>`` tag and is mostly meant as a place to insert scripts that don't already work with ``elgg_register_js(array('location' => 'footer'));`` or ``elgg_require_js('amd/module');``. In other words, you should never override this view and probably don't need to extend it either. Just use the ``elgg_*_js`` functions instead