psychic-octo-robot
  • Introduction
  • Quick Start Guide
    • Installing the package
    • Create a repository
    • Commit a modified file
    • Diff the two previous commits
    • Merge the output of the diff
    • Restore an HTML file from a repo
  • Problem Statement
    • The Gospel of Git & and Source Control
    • What Everyone else does
    • Who Cares?
    • Place your trust in the mighty Gitlit
  • Feature List
    • Initialize/Create a repository with a structured document
      • Description
      • Risks
      • Priority
    • Commit a new revision provided a new document
      • Description
      • Risks
      • Priority
    • Commit a new revision provided a changed subsection?
      • Description
      • Risks
      • Priority
    • View differences between revisions of a document
      • Description
      • Risks
      • Priority
    • Accept/Reject capability for merge conflicts
      • Description
      • Risks
      • Priority
    • Line-by-line Pull Requests
      • Description
      • Risks
      • Priority
    • Commit new revisions of a document to a branch
      • Description
      • Risks
      • Priority
  • Using Gitlit
    • Getting started
    • Creating a repository
    • Generating HTML from a repository
    • Making a commit
  • Setting up the Development Environment
    • Initial Setup
    • After Initial Setup
    • Errors in File Location After Initial Setup
  • HTML to Repository Serialization
    • Design Issues
      • How do we represent text nodes?
      • How do we represent ordering of text nodes mixed with other nodes?
      • How do we store node type?
      • How do we store node attributes (src, href, etc)?
    • Simple Paragraph Addition
      • Initial Content
        • After GUID-ization
        • Lexicographical Representation
        • Table Representation
      • Edit 1: Additional 2nd Paragraph
        • Lexicographical Representation
        • Table Representation
      • Edit 2: Additional Last Paragraph
        • Lexicographical Representation
        • Table Representation
      • Merged Edit 1 and Edit 2
        • Lexicographical Representation
        • Table Representation
    • Nested Nodes
      • Initial Content
    • Node Moves
      • Initial Content
        • Lexicographical Representation
        • Table Representation
      • Edit 1: Last to First
        • Lexicographical Representation
        • Table Representation
      • Edit 2: Last to First with content change
        • Lexicographical Representation
        • Table Representation
      • Merged Edit 1 and Edit 2
        • Lexicographical Representation
        • Table Representation
    • Design Decision
  • Text Node Name-Tracking
  • Method explanation
    • Custom HTML Tags with id Info
      • Pros
      • Cons
    • XML-style Text & Tail
      • Pros
      • Cons
  • Do we even need tags to track text nodes?
  • Case 1: Editing A Text Node
    • Custom Tags
    • XML text tail
  • Case 2: Deleting A Text Node
    • Custom Tags
    • XML text-tail
  • Case 3: Inserting A Text Node
    • Custom Tags
    • XML text-tail
  • Case 4: Moving A Text Node
    • Custom Tags
    • XML text-tail
  • Case 5: Moving an Edited Text Node
    • Custom Tags
    • XML text-tail
  • A Note about Diff implementation
  • Design Decision
 
psychic-octo-robot
  • Docs »


© Copyright 2014, Ian Hallam, John Kulczak, Sydney Satchwill, and Devon Timaeus.

Built with Sphinx using a theme provided by Read the Docs.