GNOME.org
 

[pitivi] docs: Cleanup design section titles and structure

commit bdbdcafd68f7b7e9accfbe2f48fef59c34d1f72e
Author: Alexandru Băluț <alexandru balut gmail com>
Date:   Wed Sep 12 03:40:53 2018 +0200

    docs: Cleanup design section titles and structure

 .../design/2007_design/2007_Advanced_UI_Mockups.md |  4 ++-
 .../2007_design/2007_Advanced_UI_implementation.md |  4 ++-
 .../2008_design/2008_7_28_interview_notes.md       |  2 +-
 .../2008_Architectural_Redesign/Browsers.md        |  2 +-
 .../2008_Architectural_Redesign/Design_Thoughts.md |  2 +-
 .../2008_Architectural_Redesign/Formatter.md       |  4 +--
 .../High-level_Design.md                           |  2 +-
 .../2008_Architectural_Redesign/ObjectFactory.md   | 32 +++++++++++-----------
 .../2008_Architectural_Redesign/Pipeline.md        |  4 +--
 .../2008_Architectural_Redesign/Project.md         |  2 +-
 .../2008_Architectural_Redesign/Streams.md         |  2 +-
 .../2008_Architectural_Redesign/Timeline.md        |  4 +--
 ...008_Jog_and_Shuttle_controls_code_experiment.md |  2 +-
 .../2008_Jog_and_Shuttle_controls_design.md        |  2 +-
 .../2008_Plugin_Interface_development.md           | 20 +++++++-------
 docs/design/2012_Layer_Controls_Redesign.md        | 16 ++++++-----
 docs/design/Multi-Layer_Editing.md                 | 10 ++++---
 docs/design/Why_python.md                          |  2 +-
 docs/sitemap.txt                                   | 14 +++++-----
 19 files changed, 67 insertions(+), 63 deletions(-)
---
diff --git a/docs/design/2007_design/2007_Advanced_UI_Mockups.md 
b/docs/design/2007_design/2007_Advanced_UI_Mockups.md
index 4ba59dcc..7e1c96da 100644
--- a/docs/design/2007_design/2007_Advanced_UI_Mockups.md
+++ b/docs/design/2007_design/2007_Advanced_UI_Mockups.md
@@ -1,4 +1,6 @@
-# Brandon's Design
+# 2007 Advanced UI
+
+Also known as Brandon's Design.
 
 ## Basic Design
 
diff --git a/docs/design/2007_design/2007_Advanced_UI_implementation.md 
b/docs/design/2007_design/2007_Advanced_UI_implementation.md
index 50bdcd2e..007c397e 100644
--- a/docs/design/2007_design/2007_Advanced_UI_implementation.md
+++ b/docs/design/2007_design/2007_Advanced_UI_implementation.md
@@ -1,4 +1,6 @@
-# Design Overview
+# Implementation
+
+## Design Overview
 
 ![Inheritance Diagram](images/Advanced_inheritance.png)
 
diff --git a/docs/design/2008_design/2008_7_28_interview_notes.md 
b/docs/design/2008_design/2008_7_28_interview_notes.md
index 8990f95e..2bdfa8bd 100644
--- a/docs/design/2008_design/2008_7_28_interview_notes.md
+++ b/docs/design/2008_design/2008_7_28_interview_notes.md
@@ -1,4 +1,4 @@
-# 2008 7 28 interview notes
+# 2008.7.28 interview notes
 
 I'll call my friend M. M. Is a 3D animator working for a gaming company,
 so his editing needs are somewhat different than the average
diff --git a/docs/design/2008_design/2008_Architectural_Redesign/Browsers.md 
b/docs/design/2008_design/2008_Architectural_Redesign/Browsers.md
index f4dc3f1b..23148090 100644
--- a/docs/design/2008_design/2008_Architectural_Redesign/Browsers.md
+++ b/docs/design/2008_design/2008_Architectural_Redesign/Browsers.md
@@ -1,4 +1,4 @@
-# Goal
+# Browsers
 
 `Browser`s are meant to assist in three things:
 
diff --git a/docs/design/2008_design/2008_Architectural_Redesign/Design_Thoughts.md 
b/docs/design/2008_design/2008_Architectural_Redesign/Design_Thoughts.md
index 1aefd70e..64bbe398 100644
--- a/docs/design/2008_design/2008_Architectural_Redesign/Design_Thoughts.md
+++ b/docs/design/2008_design/2008_Architectural_Redesign/Design_Thoughts.md
@@ -1,4 +1,4 @@
-# 2008 Architectural Redesign/Design Thoughts
+# Design Thoughts
 
 This is a listing, not entirely sorted, of thoughts, remarks, things to
 do, regarding PiTiVi's design, uses, etc...
diff --git a/docs/design/2008_design/2008_Architectural_Redesign/Formatter.md 
b/docs/design/2008_design/2008_Architectural_Redesign/Formatter.md
index 6ea3134b..4bcbffa0 100644
--- a/docs/design/2008_design/2008_Architectural_Redesign/Formatter.md
+++ b/docs/design/2008_design/2008_Architectural_Redesign/Formatter.md
@@ -1,6 +1,6 @@
-# Goal
+# Formatter
 
-A **Formatter** is responsible for :
+A **Formatter** is responsible for:
 
 -   Storing a [Project](design/2008_design/2008_Architectural_Redesign/Project.md) and all of
     its contents for later usage, **and/or**
diff --git a/docs/design/2008_design/2008_Architectural_Redesign/High-level_Design.md 
b/docs/design/2008_design/2008_Architectural_Redesign/High-level_Design.md
index 0b88d77e..5f378d3b 100644
--- a/docs/design/2008_design/2008_Architectural_Redesign/High-level_Design.md
+++ b/docs/design/2008_design/2008_Architectural_Redesign/High-level_Design.md
@@ -1,4 +1,4 @@
-# 2008 Architectural Redesign/High-level Design
+# High-level Design
 
 **High Level overview**
 
diff --git a/docs/design/2008_design/2008_Architectural_Redesign/ObjectFactory.md 
b/docs/design/2008_design/2008_Architectural_Redesign/ObjectFactory.md
index 1956a6f6..1463c127 100644
--- a/docs/design/2008_design/2008_Architectural_Redesign/ObjectFactory.md
+++ b/docs/design/2008_design/2008_Architectural_Redesign/ObjectFactory.md
@@ -1,29 +1,29 @@
-# Overall
+# ObjectFactory
 
-> **ObjectFactory are the descriptions of objects producing and/or
-> consuming data streams.**
+**ObjectFactory are the descriptions of objects producing and/or
+consuming data streams.**
 
 -   They contain a list of the Stream(s) they can produce and/or
     consume.
 
-> This implies **ALL** The potential streams the factory can
-> provide/consume.
+This implies **ALL** The potential streams the factory can
+provide/consume.
 
-> Ex: A **FileSourceFactory** of a raw DV File will list the following
-> streams:
->
-> -   `video/x-dv,systemstream=True`, The container stream,
-> -   `video/x-dv,systemstream=False`, The I-Frame only DV video stream,
-> -   `video/x-raw-yuv`, The decoded raw video stream
-> -   `audio/x-raw-int`, The audio stream
+Ex: A **FileSourceFactory** of a raw DV File will list the following
+streams:
+
+-   `video/x-dv,systemstream=True`, The container stream,
+-   `video/x-dv,systemstream=False`, The I-Frame only DV video stream,
+-   `video/x-raw-yuv`, The decoded raw video stream
+-   `audio/x-raw-int`, The audio stream
 
 -   They produce GStreamer elements for all, or a selected number of,
     streams.
 
-> Some factories will be able to produce a different GStreamer element
-> every time, some will only be able to produce one at a time (Ex:
-> Video4Linux source, or audio sink with retarded backend that can have
-> multiple sockets opened).
+Some factories will be able to produce a different GStreamer element
+every time, some will only be able to produce one at a time (Ex:
+Video4Linux source, or audio sink with retarded backend that can have
+multiple sockets opened).
 
 ## Properties
 
diff --git a/docs/design/2008_design/2008_Architectural_Redesign/Pipeline.md 
b/docs/design/2008_design/2008_Architectural_Redesign/Pipeline.md
index abdc4547..f76817f2 100644
--- a/docs/design/2008_design/2008_Architectural_Redesign/Pipeline.md
+++ b/docs/design/2008_design/2008_Architectural_Redesign/Pipeline.md
@@ -1,10 +1,8 @@
-# 2008 Architectural Redesign/Pipeline
+# Pipeline
 
 ![Pipeline functional
 view](Pipeline-functional.png "Pipeline functional view")
 
-# Functional Description
-
 A **Pipeline** is where all the media processing takes place in PiTiVi.
 
 In order to hide the complexity of the underlying GStreamer pipeline, we
diff --git a/docs/design/2008_design/2008_Architectural_Redesign/Project.md 
b/docs/design/2008_design/2008_Architectural_Redesign/Project.md
index e1481b46..7734615b 100644
--- a/docs/design/2008_design/2008_Architectural_Redesign/Project.md
+++ b/docs/design/2008_design/2008_Architectural_Redesign/Project.md
@@ -1,4 +1,4 @@
-# Description
+# Project
 
 A **Project** is the object containing everything specific to an
 *editing project*.
diff --git a/docs/design/2008_design/2008_Architectural_Redesign/Streams.md 
b/docs/design/2008_design/2008_Architectural_Redesign/Streams.md
index 587ab2a4..18275f92 100644
--- a/docs/design/2008_design/2008_Architectural_Redesign/Streams.md
+++ b/docs/design/2008_design/2008_Architectural_Redesign/Streams.md
@@ -1,4 +1,4 @@
-# Description
+# Streams
 
 **Stream** objects help to solve two problems:
 
diff --git a/docs/design/2008_design/2008_Architectural_Redesign/Timeline.md 
b/docs/design/2008_design/2008_Architectural_Redesign/Timeline.md
index 0b245cfa..d2c5ab2f 100644
--- a/docs/design/2008_design/2008_Architectural_Redesign/Timeline.md
+++ b/docs/design/2008_design/2008_Architectural_Redesign/Timeline.md
@@ -1,4 +1,4 @@
-# Overall
+# Timeline
 
 The **Timeline** object:
 
@@ -12,8 +12,6 @@ taking place on the overall Timeline, or on the individual Tracks.

This allows both creating simple and complex UI while offering the
same interfaces

 
-.
-
 **All of the following editing actions must be done on the `Timeline`,
 `TimelineObject`(s) or `TimelineSelection`s** and not on the `Track`(s)
 or `TrackObject(s)`:
diff --git a/docs/design/2008_design/2008_Jog_and_Shuttle_controls_code_experiment.md 
b/docs/design/2008_design/2008_Jog_and_Shuttle_controls_code_experiment.md
index 2ddd9961..a4243597 100644
--- a/docs/design/2008_design/2008_Jog_and_Shuttle_controls_code_experiment.md
+++ b/docs/design/2008_design/2008_Jog_and_Shuttle_controls_code_experiment.md
@@ -1,4 +1,4 @@
-## Introduction
+## Code Experiment
 
 ![wxPython prototype seeker with warning about inaccurate codec and some
 (green)
diff --git a/docs/design/2008_design/2008_Jog_and_Shuttle_controls_design.md 
b/docs/design/2008_design/2008_Jog_and_Shuttle_controls_design.md
index eaab2591..3ecd011c 100644
--- a/docs/design/2008_design/2008_Jog_and_Shuttle_controls_design.md
+++ b/docs/design/2008_design/2008_Jog_and_Shuttle_controls_design.md
@@ -1,4 +1,4 @@
-## Introduction
+## 2008 Jog and Shuttle controls
 
 This is just a proposal for bringing frame seeking to the user interface
 in advanced mode. If you want to follow the development progress read
diff --git a/docs/design/2008_design/2008_Plugin_Interface_development.md 
b/docs/design/2008_design/2008_Plugin_Interface_development.md
index bc1b84ea..6e5a4c70 100644
--- a/docs/design/2008_design/2008_Plugin_Interface_development.md
+++ b/docs/design/2008_design/2008_Plugin_Interface_development.md
@@ -1,4 +1,4 @@
-## Introduction
+## 2008 Plugin Interface
 
 ### About
 
@@ -50,20 +50,20 @@ exception if its called before then
 The current API uses epydoc for its documentation and is structured as
 follows:
 
--   pitivi
-    -   PluginInterface
-        -   gui
-            -   show\_gui(self, \*args, \*\*kwargs) shows or hides the
+-   `pitivi`
+    -   `PluginInterface`
+        -   `gui`
+            -   `show_gui(self, *args, **kwargs)` shows or hides the
                 main application window depending on the value of
                 'visible'
-            -   add\_menu\_item(self, \*args, \*\*kwargs) Adds a menu
+            -   `add_menu_item(self, *args, **kwargs)` Adds a menu
                 item to the appropriate main window menu
-            -   remove\_menu\_item(self, name) removes the given menu
+            -   `remove_menu_item(self, name)` removes the given menu
                 item from the user interface
-            -   remove\_ui(self) removes all changes this instance of
+            -   `remove_ui(self)` removes all changes this instance of
                 the plugininterface has made to the user interface
-        -   Project
-            -   add\_source
+        -   `Project`
+            -   `add_source`
 
 ## Settings
 
diff --git a/docs/design/2012_Layer_Controls_Redesign.md b/docs/design/2012_Layer_Controls_Redesign.md
index 5161c6ec..cf40572e 100644
--- a/docs/design/2012_Layer_Controls_Redesign.md
+++ b/docs/design/2012_Layer_Controls_Redesign.md
@@ -1,3 +1,12 @@
+# 2012 Layer Controls Redesign
+
+## Key ideas
+
+-   don't eat to much horizontal space
+-   show type of layer
+-   show/edit layer name
+-   provide fold action
+
 ## Solutions from other software
 
 Sony Vegas Pro 11
@@ -25,10 +34,3 @@ Avid DS
 ![](images/Glade-1.png "Glade-1.png")
 
 ![](images/Layers.png "Layers.png")
-
-## Key ideas
-
--   don't eat to much horizontal space
--   show type of layer
--   show/edit layer name
--   provide fold action
diff --git a/docs/design/Multi-Layer_Editing.md b/docs/design/Multi-Layer_Editing.md
index 015da2e5..eb75cd36 100644
--- a/docs/design/Multi-Layer_Editing.md
+++ b/docs/design/Multi-Layer_Editing.md
@@ -1,4 +1,6 @@
-# Multi-Layer is not Multi-Track
+# Multi-Layer Editing
+
+## Multi-Layer is not Multi-Track
 
 PiTiVi distinguishes between multi-layer and multi-track editing. In
 PiTiVi at 'track' is a separate channel of output. A layer is a separate
@@ -19,7 +21,7 @@ other media types. Subtitle information could be kept on a subtitle
 track, or midi data used to control synthesizers and/or lighting systems
 could be kept on a score track and edited alongside the video.
 
-# Multi-Layer Editing
+## Multi-Layer Editing
 
 Multi-layer editing is how the notion of priority is handled in the UI.
 Numeric priority is mapped to the vertical position of an object in the
@@ -32,7 +34,7 @@ together with a superimpose effect.
 The user can change the priority of an object by moving it up or down. A
 new visual layer will be created if necessary.
 
-# Multi-Track Editing
+## Multi-Track Editing
 
 The current implementation supports a limited form of multi-track
 editing: there is one audio and one video track per project. Future
@@ -43,7 +45,7 @@ Individual tracks can also be enabled or disabled for preview and
 project rendering. Also, Moving sources between tracks is not ordinarily
 possible.
 
-## Linking and Brothers Objects
+### Linking and Brothers Objects
 
 Linking means that two sources are associated so that whatever is done
 to one source is also done to the other. A source can have one linked
diff --git a/docs/design/Why_python.md b/docs/design/Why_python.md
index de418822..24e613a7 100644
--- a/docs/design/Why_python.md
+++ b/docs/design/Why_python.md
@@ -1,4 +1,4 @@
-# Why python ?
+# Why Python?
 
 We like Python. It is a simple, fast and elegant programming language.
 It allows **faster**, **agile** and **robust** software development.
diff --git a/docs/sitemap.txt b/docs/sitemap.txt
index 505ac030..c0c8524d 100644
--- a/docs/sitemap.txt
+++ b/docs/sitemap.txt
@@ -57,21 +57,21 @@ index.md
                design/XGES_Examples.md
                design/Plugins.md
                design/2007_design/2007_Advanced_UI_Mockups.md
-               design/2007_design/2007_Advanced_UI_implementation.md
+                       design/2007_design/2007_Advanced_UI_implementation.md
                design/2007_design/2007_Simple_UI_Mockups.md
                design/2008_design/2008_7_28_interview_notes.md
                design/2008_design/2008_Architectural_Redesign.md
-                       design/2008_design/2008_Architectural_Redesign/Browsers.md
-                       design/2008_design/2008_Architectural_Redesign/Design_Thoughts.md
-                       design/2008_design/2008_Architectural_Redesign/Formatter.md
                        design/2008_design/2008_Architectural_Redesign/High-level_Design.md
-                       design/2008_design/2008_Architectural_Redesign/ObjectFactory.md
-                       design/2008_design/2008_Architectural_Redesign/Pipeline.md
                        design/2008_design/2008_Architectural_Redesign/Project.md
+                       design/2008_design/2008_Architectural_Redesign/ObjectFactory.md
                        design/2008_design/2008_Architectural_Redesign/Streams.md
+                       design/2008_design/2008_Architectural_Redesign/Pipeline.md
                        design/2008_design/2008_Architectural_Redesign/Timeline.md
-               design/2008_design/2008_Jog_and_Shuttle_controls_code_experiment.md
+                       design/2008_design/2008_Architectural_Redesign/Formatter.md
+                       design/2008_design/2008_Architectural_Redesign/Browsers.md
+                       design/2008_design/2008_Architectural_Redesign/Design_Thoughts.md
                design/2008_design/2008_Jog_and_Shuttle_controls_design.md
+                       design/2008_design/2008_Jog_and_Shuttle_controls_code_experiment.md
                design/2008_design/2008_Plugin_Interface_development.md
                design/2008_design/2008_UI_Design.md
                design/2012_Layer_Controls_Redesign.md
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]