Skip to content

Home

Jump to bottom
IzChrisHodges edited this page Oct 13, 2017 · 13 revisions

The following documentation is about the structure of Izenda 7's Wiki Documentation hosted at https://www.izenda.com/docs/ .

Table of Contents

Structural Guidelines

Legacy Structure

The initial structure of the Izenda 7 Wiki was created in an effort to port the content from one platform (MediaWiki) to another (Sphinx). This structure includes modifications to the Wiki before 03/15/17.

New Structure

Images

  • All images are located at ./_static/images
  • When adding an image to this file structure, adhere to the following convention
    • Create a folder for the category. For instance, if you are adding images to the introduction section, create a folder named "intro"
    • Within the category folder, create a folder for your topic. If you are adding images to the category landing page, create a folder named "root." For instance, if you are adding an image to the Izenda Concepts page, create a folder labeled "Izenda_Concepts
    • Add your image with a meaningful name. For instance, if you are uploading an image of your really awesome logo, name the image really_awesome_logo.png
    • Now, you can reference the image with the file structure ./_static/images/intro/Izenda_Concepts/really_awesome_logo.png
  • To reference an image within a page, refer to the guidelines found here

Pages

  • Pages are written in RST and then later compiled into HTML
  • If you create a new page, adhere to a similar structure outlined for images
    • Category folders have been created (outlined in the file structure above). For instance, if you are adding pages to the introduction page, create a folder named "intro"
    • Within the category folder, create a folder for your topic. For instance, if you are adding a topic for really awesome things you can do with Izenda, create a folder labeled "Really_Awesome_Things_You_Can_Do_With_Izenda"
  • To reference a page within a page, refer to the guidelines found here

Styling Guidelines

Sphinx Styling

  • Sphinx uses prebuilt themes to style your Wiki page
  • For more information, refer to the guide found here.

Modifying Izenda's CSS

  • Izenda's custom CSS is located at ./_static/css/custom.css
  • To modify the navigation pane:
    • div.wy-side-nav-search

Modifying Logo Image and Favicon

  • Logo images and favicons are set within your conf.py file.
    • Locate the resource that you would like to define and un-comment it within the file. For instance, if I wish to add a logo to the theme, I would find un-comment "html_logo" and modify it to say "html_logo = 'image/global/logo.png'"

Page Formatting

RST Overview

Title

  • CREATES SIDE PANEL CLICKABLE LINK
    My Title
    ------------

Section Heading

  • CREATES SIDE PANEL CLICKABLE LINK UNDER A TITLE
    ==========
    My Heading
    ==========

Sub Section Heading

  • CREATES A SIDE PANEL CLICKABLE LINK UNDER A HEADING
    --------------
    My Subheading
    --------------

Images

.. figure:: /sub_folder_of_project_directory/sub_sub_folder/fileName.png
:scale: 100 %
:alt: Alternative text that would be displayed in place of the image

Numbered List

#. Entry one
#. Entry two
#. Entry three
Alternatively,
1. one
2. two
3. three

Bullets

*. Bullet 1
*. Bullet 2
*. Bullet 3

Nesting Elements

  • RST is spatially sensitive. Nesting can be accomplished with indentation.

Tables

  • If you have an excel spreadsheet saved as a csv, you can devise and quick “Find and Replace” of commas in your favorite text editor.
  • All spacing has to line up visually in your text editor to make a chart.
  • Try the Pandoc Converter for large tables

+----+----+----+
| A | B | C |
+----+----+----+
| 1 | 2 | 3 |
+----+----+----+
| x | y | z |
+----+----+----+

Downloading A Copy of Izenda Documentation

Auto Building Sphinx Documentation

Sphinx can be configured to update the HTML Build whenever a change is detected. For more, refer to sphinx-autobuild

Clone this wiki locally