Documentation

docs/readthedocs/Makefile

@@ -0,0 +1,192 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  applehelp  to make an Apple Help Book"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+	@echo "  coverage   to run coverage check of the documentation (if enabled)"
+
+clean:
+	rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/n2cms.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/n2cms.qhc"
+
+applehelp:
+	$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
+	@echo
+	@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
+	@echo "N.B. You won't be able to view it unless you put it in" \
+	      "~/Library/Documentation/Help or install it in your application" \
+	      "bundle."
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/n2cms"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/n2cms"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+coverage:
+	$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
+	@echo "Testing of coverage in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/coverage/python.txt."
+
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

docs/readthedocs/_build/html/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 153dc67ce5070733e770b6caa4842ef6
+tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/readthedocs/_build/html/_sources/index.txt

@@ -0,0 +1,14 @@
+Welcome to N2CMS documentation!
+===================================
+
+.. image:: logo.png
+
+N2 is a lightweight CMS framework to help you build great web sites that anyone can update. Using its 
+interface is intuitive and empowering. The developer story is something exquisite. Give it a try and 
+you'll see.
+
+.. toctree::
+   :maxdepth: 3
+
+   getting-started/index.rst
+   setting-up-your-environment/index.rst

docs/readthedocs/_build/html/_sources/setting-up-your-environment/index.txt

@@ -0,0 +1,108 @@
+===========================
+Setting up your environment
+===========================
+
+Development Environment
+=======================
+
+There are two supported environments that you can use for developing a site with N2:
+    1. Git-based environment
+    2. Nuget-based environment
+
++------------------------+----------------------------------------------------------------------------------+
+|| Choose this           || If you want this                                                                |
++========================+==================================================================================+
+|| Nuget-based           || You want the easiest integration of N2 in an existing project.The Nuget         | 
+|| environment           || framework will downloadand install all required dependenciesinto an existing    |
+||                       || Visual Studio project.                                                          |
++------------------------+----------------------------------------------------------------------------------+
+|| Git-based             || You always want to have the most recent code, or you want to use one of the     |
+|| environment           || sample template projects. The Git-based environment contains both the           |      
+||                       || WebForms and MVC template packs, sample data, plus the N2 Core and all          |
+||                       || dependency binaries.This is a great way to get started with N2CMS, particularly |
+||                       || if you don't already have a project started. You can use one of the existing    |
+||                       || projects as a basis for your new N2-based site:                                 |
+||                       ||                                                                                 |
+||                       ||   * WebForms Templates Pack                                                     |
+||                       ||   * ASP.NET MVC Templates                                                       |
+||                       ||   * ASP.NET MVC "Dinamico" Templates Pack (uses the Razor engine)               |  
++------------------------+----------------------------------------------------------------------------------+
+
+
+Getting the Bits
+================
+
+Each of the supplied packages is supplied either as a Git repository or as a Nuget package.
+
+    * Start with Git: check out the N2 repository located at http://github.com/n2cms/n2cms. Note: We don't recommend using Github's 
+      archive formats (tgz, zip). Using the archive formats will make your installation more difficult to update as Git's patching 
+      infrastructure will not be available.
+    * Start with Nuget: install the requisite Nuget package from within your Visual Studio project
+        - n2cms_webforms
+        - n2cms_mvc
+        - n2cms_dinamico
+
+
+Overview of Available Packages
+==============================
+
++----------------------+----------------------------------------------------------------------------+
+|| Package             || Description                                                               |
++======================+============================================================================+
+|| N2 CMS 2.x          || This package reflects the N2 CMS framework development environment and    |
+|| Source Code         || contains both template packs and all examples along with the framework    |
+||                     || source code. For site development it’s recommended to start from one of   |
+||                     || the template packs, or examples.                                          |
++----------------------+----------------------------------------------------------------------------+
+|| N2 CMS 2.x          || This is the source code of the MVC template package along with a          |
+|| ASP.NET             || compiled version of the framework. Use this package to develop your own   |
+|| MVC Templates Pack  || site with existing functionality using ASP.NET MVC.                       |
++----------------------+----------------------------------------------------------------------------+
+|| N2 CMS 2.x ASP.NET  || This is the source code of the WebForms template package along with       |
+|| WebForms            || a compiled version of the framework. Use this package to develop          |
+|| Templates Pack      || your own site with existing functionality using ASP.NET WebForms.         |
++----------------------+----------------------------------------------------------------------------+
+|| N2 CMS 2.x MVC      || This package contains a simple example site along with a compiled version |
+|| Minimal Example     || of the framework. Use this package to understand the basics of            |
+||                     || ASP.NET MVC + N2 CMS or if you don’t need existing templates.             |
++----------------------+----------------------------------------------------------------------------+
+|| N2 CMS 2.x C#       || This package contains a simple example site along with a compiled version |
+|| Minimal Example     || of the framework. Use this package to understand the basics of            |
+||                     || WebForms/C# + N2 CMS or if you don’t need existing templates.             |     
++----------------------+----------------------------------------------------------------------------+
+|| N2 CMS 2.x          || This package contains a simple example site along with a compiled version |
+|| Visual Basic        || of the framework. Use this package to understand the basics of            |
+|| Minimal Example     || WebForms/Visual Basic + N2 CMS or if you don’t need existing templates.   |
++----------------------+----------------------------------------------------------------------------+
+|| N2 CMS 2.x          || This is the N2 CMS framework compiled and zipped for upgrade              |
+|| Compiled Framework  || of a previous version, or integration with an existing site.              |
+|| and Management UI   ||                                                                           |
++----------------------+----------------------------------------------------------------------------+
+
+
+Getting up and Running
+======================
+
+Each package contains one or more Visual Studio Solution (*.sln) files. Open the Solution file for what you 
+want to run, and edit the web.config file to use the database engine of your choosing. Invoke the Run command 
+in Visual Studio to launch a development web server with N2 running inside. You should see the setup wizard right away.
+
+The next step is to either start using N2 and begin building your content using the pre-defined templates, or 
+start developing with N2 to customize the system to suit your needs. Most users will want to do at least some 
+development and customization as every website has different needs and the templates don't cover every possible 
+scenario that can be achieved with N2 CMS.
+
+Web Platform Installer (WPI)
+----------------------------
+
+The same WPI package can be installed from the “Microsfot Web Platform Installer”, from “Internet Information 
+Services (IIS) Manager” or from “Microsoft WebMatrix”.
+
+Updating N2CMS
+--------------
+
+After you've installed N2CMS in one of these ways, you will want to update it from time to time to take advantage 
+of the latest features, security patches, and other updates. If you opted to use the Nuget deployment model, the 
+Nuget packages will be updated periodically, and you can update using the built-in Nuget update mechanism to update 
+your local instance of N2CMS. If you chose the Git deployment model, you can use git pull to get the latest updates 
+in your own Git repository.