diff --git a/admin/rfc.sh b/admin/rfc.sh index 5efbd0d46..a37426b9b 100755 --- a/admin/rfc.sh +++ b/admin/rfc.sh @@ -358,7 +358,7 @@ create) -f "./doc/devel/rfc_dropped/${name}.txt" ]]; then echo "$name.txt exists already" else - source ./doc/template/rfc.txt >"./doc/devel/rfc_pending/${name}.txt" + source ./doc/devel/template_rfc.sh >"./doc/devel/rfc_pending/${name}.txt" edit "./doc/devel/rfc_pending/${name}.txt" 2 abstract git add "./doc/devel/rfc_pending/${name}.txt" process "./doc/devel/rfc_pending/${name}.txt" diff --git a/doc/design/application/Config.txt b/doc/design/application/Config.txt index cc3bfcec4..9f01793e6 100644 --- a/doc/design/application/Config.txt +++ b/doc/design/application/Config.txt @@ -12,6 +12,4 @@ The Lumiera application uses two quite different sources for configuration -> see also the link:{ldoc}/technical/backend/ConfigLoader.html[Config Loader brainstorming from 2008] (implementation details) -[icon="warning.png"] -WARNING: Website under construction diff --git a/doc/design/application/index.txt b/doc/design/application/index.txt index 154614f8d..71b7cebe4 100644 --- a/doc/design/application/index.txt +++ b/doc/design/application/index.txt @@ -5,6 +5,4 @@ Design Documents: Application Framework * link:plugin_loader.html[Plugin Loader] * link:SubsystemLifecycle.html[Application Subsystems and Lifecycle] -[icon="warning.png"] -WARNING: Website under construction diff --git a/doc/design/application/plugin_loader.txt b/doc/design/application/plugin_loader.txt index 4bb5e10c8..a0e2d9a1a 100644 --- a/doc/design/application/plugin_loader.txt +++ b/doc/design/application/plugin_loader.txt @@ -1,7 +1,5 @@ Lumiera Design: Plugin system ============================= - -[icon="warning.png"] -WARNING: Website under construction +Eventually, this will have design documentation for the Plugin system. diff --git a/doc/design/backend/index.txt b/doc/design/backend/index.txt index a16cb5f18..44c57ca8b 100644 --- a/doc/design/backend/index.txt +++ b/doc/design/backend/index.txt @@ -1,7 +1,5 @@ Design Documents: Backend ========================= - -[icon="warning.png"] -WARNING: Website under construction +Eventually, this will have design documentation for the Backend. diff --git a/doc/design/engine/index.txt b/doc/design/engine/index.txt index 946e239e6..7d9b5ea39 100644 --- a/doc/design/engine/index.txt +++ b/doc/design/engine/index.txt @@ -1,7 +1,5 @@ Design Documents: Renderengine ============================== - -[icon="warning.png"] -WARNING: Website under construction +Eventually, this will have design documentation for the Engine. diff --git a/doc/design/gui/GuiDiscussion/Proposal.AkhiL.txt b/doc/design/gui/GuiDiscussion/Proposal.AkhiL.txt index 206115dd0..fc28a9ff0 100644 --- a/doc/design/gui/GuiDiscussion/Proposal.AkhiL.txt +++ b/doc/design/gui/GuiDiscussion/Proposal.AkhiL.txt @@ -1,7 +1,7 @@ GUI Brainstorming Proposal ========================== :Author: IL'dar AKHmetgaleev (»AkhIL«) -Date: 2008-30-03 +:Date: 2008-30-03 Wiring nodes within the timeline diff --git a/doc/design/gui/GuiDiscussion/Proposal.Alcarinque.svg b/doc/design/gui/GuiDiscussion/Proposal.Alcarinque.svg new file mode 100644 index 000000000..7049baf5d --- /dev/null +++ b/doc/design/gui/GuiDiscussion/Proposal.Alcarinque.svg @@ -0,0 +1,579 @@ + + +image/svg+xmlLumiera GUI proposalFrancisco G. Rodriguez (»Alcarinque«)07.05.2008passed in as part of the Lumiera GUI discussion. +Added to Lumiera Website 2/2011 by IchthyostegaNode Compositor +Timeline +Node layout I +Strip I +Strip II +Strip III +In +Clip I +In +NL II +Effect +I +Effect +II +Out +Node layout II +Node layout III +Media Library +Clip II +Clip I +Clip III +Node +layout I +Node +layout II +Node +layout III +Viewport +Display +Interactive +Interface +and +Controls + \ No newline at end of file diff --git a/doc/design/gui/GuiDiscussion/Proposal.Alcarinque.txt b/doc/design/gui/GuiDiscussion/Proposal.Alcarinque.txt new file mode 100644 index 000000000..954ec3702 --- /dev/null +++ b/doc/design/gui/GuiDiscussion/Proposal.Alcarinque.txt @@ -0,0 +1,171 @@ +GUI Brainstorming Proposal +========================== +:Author: Francisco G. Rodriguez +:Date: 07.05.2008 + + +This are some of my ideas for the interface of Lumiera. Some of this ideas are +just things I saw in the GUI brainstorm and my intent is to bring them together. +I will be adding images and more ideas, but I need some feedback because maybe +this gui is only good at the work I'm used to. If you find this is no good for +you, please write me telling me why so I can think a better way to do it. + + +General +------- + +* The GUI must be configurable. A lot of different tasks can be done using a + NLE, and we cannot make all of them accesible at the same time. This means allow + changing keybindings, windows/tiles positions, and colors. Just like ct wrote, + saving them in the project file, etc. +* If we use a custom api for the gui, we should allow themes(or changing colors + from a preferences dialog), and if we use gtk or qt, each user could use the + program with his custom theme. (Done) +* We could provide presets for keybindings/UI copying the behaviour of others + programs. For example make it behave like cinelerra 2.0. +* If we use tiles and multiple windows, we should allow these to be created + while using the program, like blender. Each tile should have a little icon to + allow changing the module the tile is showing, and clicking on a border would + allow to divide/merge. +* All icon shortcuts, and toolbars can be hidden alowing a workflow using keybindings. + +The Gui has to be divided into indepent parts or modules that will communicate +each other. Each module can be developed separately, making easy correct bugs, +and add new functions. Of course this modules I am talking about, are not the +modules described in the architecture overview. This is the gui, which is an +abstraction of the real program. + +image::{imgg}/Alcarinque.proposal.png[Alcarinque's GUI proposal] + +Here I made a sample of the architecture of the UI. Please don't take this too +seriously, it is just a draft so you can understand the workflow. I haven't +thought how this will communicate with the proc layer or backend. + + +Modules +------- + +* Main Menu + + - It doesn't have to be a menu. + - Contains a a way to manage proyects, render as movie, setup the preferences, + customize the UI, manage the others modules, and capture a footage. + +* Node Compositor + + - This is a new feature that I think is very important because it allows a lot + of new special effects. + - Also it will bring a lot user contribution with the sharing of _node presets_. + + . Just think of this... I have a footage of a kid playing with some red stick. + . I add this as an _In_ node. Then connect its output to a _Glow_ node. + Also connect the output of the _In_ node to a _RGB Curves_ node which I use + to filter a certain tone of red. The output to the curves is sent to the + alpha input of the glow node. The output of glow is sent to an _Out_ node. + . I save this node layout as a preset, a file called `lightsaber.np`. I go + to the Lumiera's site and share it so everyone can use it, improve it. + + - Lumiera would just provide basic but poweful nodes, which would be useful + to construct very complex effects. + - There are audio and video nodes some of them can interact. See below. + - Nodes could be gruped and used as another node. A group of nodes is a + _Node layout_. When created, it appears in a tab in the media library. + Each node layout has one or more _In_ and _Out_ nodes, that let it + communicate with the others objects. + + . The In node brings an input from a file and converts it into an audio/video stream. + . The Out node transforms a stream into an image drawable into the ``canvas''. + It has options like transform(position, scale, rotation) and opacity. Also + it saves a In/Out positions, relative to the internal node layout time. This + is to be able to have multiple instances of the same node layout but showing + different parts of the stream. + + - Transform trayectory is shown in the interactive interface of the visor. Of course if the strip/node layout is selected. + - Opacity keys and level is shown above the strip(like cinelerra). + - If it is an audio out node, the variables are volumes for each channel. + - Each node has some parameters, these are keyable. When selecting a node, + curves for each parameter are shown in the node options module. + - Nodes should be easily programmed, and adding them should not require + recompilation of the whole program. Maybe there will be an exception to + this for the In/out nodes, etc. + - Nodes can also generate, for example a FractalExplorer node, a waveform + node (to convert audio to video), oscilators, noise, etc. For example, we + could drive a brightness/contrast node with a one dimension noise generator, + to obtain an scene with lightnings or broken lamps like “doom” + +* Sound +* Media Library: + + - It can be tabbed or grupped to make organization easier. + - When selecting files, the images sequences like `image0000.jpg`, + `image0001.jpg`, `image0002.jpg`, etc should show like +image[0-3000].jpg+. + - It should display the properties of the media, like resolution, fps, + bitrate, etc. Maybe in each clip or in a container. + - Be able to select for a list or a thumbnail or waveform preview. + - In each clip there is a preview button. + - Maybe add an option to “make a new clip from this clip” to change things + like fps, size, codec, etc. Just a wrapper for ffmpeg or something. + - You can drop the clip in the node compositor as _In_ node, or in the + timeline as a stripe. Doing the latter, will create a node group with the name + of the clip, that will have an “In” node(pointing to the file) connected to an + _Out_ so that the file is seen by the timeline. + - When we import a clip it should create a proxy. We don't use the original + clip anymore until render. + +* Timeline + + - Should provide a palette with tools like knife, in/out points, etc that can + be hidden. This could be achieved using a ``no header'' option like... again... + blender. I'm open to new ideas about this + - Scaling the clips vertically could be a good idea, especcially when working + with too many tracks. Using an amplifier tool could do the magic. + - Should allow tabbing, to have more than a timeline at in a project. We can + create a +{scene-1, scene-2, scene-3}+ timelines and then mix them in a + fourth timeline called ``film'' as if they were simple strips... + +* Viewport + + - The viewport should be interactive. Maybe a key toggle to allow panning and + zooming. Clicking on it should make the clicked clip to transform. Being able + to keys in the current keyframe to things like rotation, translation, and + scale. Maybe opacity with the mouse wheel. + - Clicking on the clip the first time, will add a transform node before its + out node. This transform node, has as input a time curve node, which will + be keyframmed. + - Should allow seeing the result of the current timeline, or a custom media + library element. + - Should allow setting In/out points to allow inserting in the timeline. + - Transform trayectory is shown in the interactive interface of the visor. + Of course if the strip/node layout is selected. + +* Palette + + - For custom common tasks, like Maya's toolbar. + +* Effects and Transitions + + - A section where we can drag and drop nodes and transitions to the node + compositor/timeline + - Transitions can be added in both, timeline and node editor. I'm open to + new ideas about this + - Droping a node on a stripe would add it before its out node, Using the + nodes, default connections. This way the program can be used as a normal + NLE or a compositor in a seamless way. + +* Options + + - Shows the options for the current node layout the one selected in current + timeline. What happens when we have two timelines modules showing different + timelines? Each options modules has a bar to select what timeline is using. + I don't understand why someone would want two timelines modules running + different timelines, maybe when selecting in one module the others could + switch inmmediatly, but maybe it is useful in some case. + - It would be divided into three parts. + + . A list of nodes into the node layout + . The options of the selected node in the list. + . A curve timeline. A list for of the node parameters and curves for it. + Just like Blender's IPO curves. + + + diff --git a/doc/design/gui/GuiDiscussion/TimelineDiscussion.txt b/doc/design/gui/GuiDiscussion/TimelineDiscussion.txt index 7f4cbd0b1..e1ec41786 100644 --- a/doc/design/gui/GuiDiscussion/TimelineDiscussion.txt +++ b/doc/design/gui/GuiDiscussion/TimelineDiscussion.txt @@ -1,6 +1,7 @@ Timeline: Discussion ==================== -:author: Joel Holdsworth +:Author: Joel Holdsworth +:Date: Fall 2008 This is Joel Holdsworth's attempt to amalgamate all the ideas from all the brainstorming to one consistent idea that makes sense, can be implemented, and seems like it would be nice to use. Comments are welcome. @@ -410,3 +411,10 @@ apply to "all applicable" is not actually a problem. Again, in the rare cases where more is needed, the user is free to split off a channel as a separate clip. +.historical Note by Ichthyo (2/2011) +This page sumarises the state of the GUI Discussion in early 2009 + +Since end of 2009, Gui development is mostly stalled (Joel left the project +due to other obligations). Meanwhile we had a bit of discussion here and there, +and personally I got a somewhat clearer understanding of what the Model in +Proc-Layer can / will provide. But basically that's along the lines of what +I wrote in my last comment at the bottom of this page diff --git a/doc/design/gui/GuiDiscussion/index.txt b/doc/design/gui/GuiDiscussion/index.txt index d5f97da23..b4fb45adc 100644 --- a/doc/design/gui/GuiDiscussion/index.txt +++ b/doc/design/gui/GuiDiscussion/index.txt @@ -4,15 +4,14 @@ GUI Design and Feature Discussion In the early stages of the project, there was a lot of debate regarding GUI concepts and -features and proposals. -- link:GuiBrainstormingReviewed.html[GUI Brainstorming page] 'TODO: explain whats this all about' +- link:GuiBrainstormingReviewed.html[GUI Brainstorming page] '[red]#TODO#: explain whats this all about' - several Proposals * link:Proposal.AkhiL.html[AkhIL] + * link:Proposal.Alcarinque.html[Alcarinque] * link:Proposal.RichardSpindler.html[Richard Spindler] * link:Workspaces.html[about Workspace organsiation] * link:scrolling.html[about scrolling..] * link:MenuAndShortcuts.html[Ideas for menus and shortcuts] - link:TimelineDiscussion.html[Conclusions by Joel Holdsworth] -[icon="warning.png"] -WARNING: Website under construction diff --git a/doc/design/gui/index.txt b/doc/design/gui/index.txt index 33090d858..2ecddacf8 100644 --- a/doc/design/gui/index.txt +++ b/doc/design/gui/index.txt @@ -16,8 +16,3 @@ integral, so its rather treated separately of individual GUI features. .*TODO* more contributions please... ;-) We had several additional discussions and contributions on the mailinglist, several people did even concept drawings. Collect these and add them here - - -[icon="warning.png"] -WARNING: Website under construction - diff --git a/doc/design/index.txt b/doc/design/index.txt index 5ebd09a37..a19f26e78 100644 --- a/doc/design/index.txt +++ b/doc/design/index.txt @@ -1,51 +1,67 @@ -== Lumiera Design Documents +Lumiera Design Documents +======================== -The goal of Lumiera is to provide a professionnal tool for video editing on GNU/Linux systems. -The vision of the development team defines a modern design for the core of a Non-Linear Editing software. -One of the key aspect of Lumiera is the strong separation between the user interface and the processing core. -Lumiera as a software will come along with a GTK GUI but that does not make this exclusive, any other GUI could be written as well as scripts to drive the core. -This is made possible by the above-mentioned quality of Lumiera being considered as two strictly separate parts. -Lumiera as a processing core will be able to do anything possibly conceivable, therefore it may be used to do any task on video (and audio?), even unrelated to video editing. +The goal of Lumiera is to provide a professional tool for video editing on +GNU/Linux systems. The vision of the development team defines a modern design +for the core of a Non-Linear Editing software. One of the key aspect of Lumiera +is the strong separation between the user interface and the processing core. +Lumiera as a software will come along with a GTK GUI but that does not make this +exclusive, any other GUI could be written as well as scripts to drive the core. +This is made possible by the above-mentioned quality of Lumiera being considered +as two strictly separate parts. Lumiera as a processing core will be able to do +anything possibly conceivable, therefore it may be used to do any task on video +(and audio?), even unrelated to video editing. .Workflow **** The word Workflow is used to name the way tasks can be achieved in an application. Any operation in Lumiera must be possible in the most suitable and stringent fashion. The Workflow is closely related to how flexible the GUI is but also the concern of deeper and more technical parts of the application. **** -=== Overview -The internal structure of Lumiera is divided in numerous subsystems. -This overview will try to go through the elements from the highest to the lowest piece of the structure. -They can be categorized into three main categories plus extra components : +Overview +-------- -==== link:gui/index.html[Graphical User Interface] +The internal structure of Lumiera is divided in numerous subsystems. This +overview will try to go through the elements from the highest to the lowest +piece of the structure. They can be categorized into three main categories plus +extra components : -User interfaces are basically handled like plugins, consequently it is possible to interface with Lumiera through scripts. It is also possible to create specialized GUIs. -The interface is the closest component to the user, it is purely visual. There the user manipulates, organizes, loads, configures all sorts of datas, especially MObjects (media objects) and Assets. These elements are contained within a structure called the Session. +link:gui/index.html[Graphical User Interface] +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -==== The Processing Layer +User interfaces are basically handled like plugins, consequently it is possible +to interface with Lumiera through scripts. It is also possible to create +specialized GUIs. The interface is the closest component to the user, it is +purely visual. There the user manipulates, organizes, loads, configures all +sorts of datas, especially MObjects (media objects) and Assets. These elements +are contained within a structure called the Session. -The Processing layer (or proc) is where the elements from the Session are assembled to form a network of nodes, to be sent to the Backend. The lowest data structure is called the Low-level model. + +The Processing Layer +~~~~~~~~~~~~~~~~~~~~ + +The Processing layer (or proc) is where the elements from the Session are +assembled to form a network of nodes, to be sent to the backend. The lowest data +structure is called the Low-level model. + * link:model/index.html[Model] + * link:engine/index.html[Engine] -==== link:backend/index.html[The Backend] +link:backend/index.html[The Backend] +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The backend uses the Low-level model. It allows the rendering and makes a heavy use of the Input/Output System to the screen or to external monitors. +The backend uses the Low-level model. It allows the rendering and makes a heavy +use of the Input/Output System to the screen or to external monitors. Extra components ---------------- - link:application/index.html[The Application] ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The application controls the initialization and shutdown procedures as well as loading external elements like plugins that are widely used. +The application controls the initialization and shutdown procedures as well as +loading external elements like plugins that are widely used. link:plugins/index.html[Plugins] ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -They are key elements in Lumiera since the application relies heavily on this concept of modules. For example, the GUI of Lumiera is a plugin. - - - +Plugins are key elements in Lumiera since the application relies heavily on this +concept of modules. For example, the GUI of Lumiera is a plugin. diff --git a/doc/design/model/index.txt b/doc/design/model/index.txt index ab8fdbd66..2541c63c5 100644 --- a/doc/design/model/index.txt +++ b/doc/design/model/index.txt @@ -3,7 +3,3 @@ Design Documents: Model * two models: high-level and low-level * RfC: link:{rfc}/../rfc_pending/ProcHighLevelModel.html[high-level model basics] - -[icon="warning.png"] -WARNING: Website under construction - diff --git a/doc/design/plugins/index.txt b/doc/design/plugins/index.txt index 2c843477f..6ad7e6138 100644 --- a/doc/design/plugins/index.txt +++ b/doc/design/plugins/index.txt @@ -2,7 +2,3 @@ Design Documents: Plug-In ========================= * link:PluginBrainstorm.html[early draft for the plugin interface] - -[icon="warning.png"] -WARNING: Website under construction - diff --git a/doc/design/workflow/index.txt b/doc/design/workflow/index.txt index c82698708..48147d31e 100644 --- a/doc/design/workflow/index.txt +++ b/doc/design/workflow/index.txt @@ -9,8 +9,3 @@ integral, so it's rather treated separately of individual GUI features. -> see also link:../gui/index.html[general GUI discussion...] * link:LumieraWorkflowOutline.html[Workflow outline by BJMR] - - -[icon="warning.png"] -WARNING: Website under construction - diff --git a/doc/devel/draw/rendered b/doc/devel/draw/rendered new file mode 120000 index 000000000..f53e14315 --- /dev/null +++ b/doc/devel/draw/rendered @@ -0,0 +1 @@ +../../../wiki/draw \ No newline at end of file diff --git a/doc/devel/report.txt b/doc/devel/report.txt index 903b02768..7734b66dc 100644 --- a/doc/devel/report.txt +++ b/doc/devel/report.txt @@ -1,6 +1,7 @@ Statistics and Reports ====================== +//Menu: label Statisticts ++++++++++++++++++++++++++++++++++++++ @@ -17,19 +18,29 @@ Statistics and Reports ++++++++++++++++++++++++++++++++++++++ '''' -^Statistics generated automatically by *Ohloh* based on Git master^ +^Statistics generated automatically by *Ohloh* based on Git master.^ Tickets ------- + * link:http://issues.lumiera.org/query?group=status&milestone=0integration[report: Milestone Integration] * link:http://issues.lumiera.org/report/14[recently changed tickets] - * link:http://issues.lumiera.org/report/8[core tickets in work] + * link:http://issues.lumiera.org/report/13[blocked tickets] * link:http://issues.lumiera.org/report/5[stalled tickets] - * link:http://issues.lumiera.org/report/15[non-codin small tasks] -See the link:http://issues.lumiera.org/report[Trac overview for more ticket reports] +See the link:http://issues.lumiera.org/report[Trac overview] for more ticket reports. -[icon="warning.png"] -WARNING: Website under construction +Mailing List +------------ + +image:http://gmane.org/plot-rate.php?group=gmane.comp.video.lumiera.general[Lumiera Mailinglist activity] + +^activity stats by link:http://dir.gmane.org/gmane.comp.video.lumiera.general[Gmane.org]^ + +.... + + + +.... + \ No newline at end of file diff --git a/doc/devel/rfc.txt b/doc/devel/rfc.txt index 36db7c289..06873b7db 100644 --- a/doc/devel/rfc.txt +++ b/doc/devel/rfc.txt @@ -1,28 +1,42 @@ Design Process ============== +//Menu: include rfc +//Menu: include rfc_pending +//Menu: include rfc_dropped + +//Menu: put child 'rfc_dropped' after 'rfc' + How it Works ------------ +Design Process entries (RfC) can be created by anyone. +Each entry goes through several stages until it's accepted (or rejected). +All our RfC entries are filed here, either in the link:rfc/index.html[RfC accepted] section, +or as link:rfc_pending/index.html[pending RfC] or as link:rfc_dropped/index.html[RfC dropped]. * Every proposal starts out as _*Idea*_, allowing other people to review and comment on it, while still working out details. -* When the _Idea_ is in a proper shape and worked out in most details it becomes a _*Draft*_. This _Draft_ need to be carefully reviewed, commented, perhaps corrected and rated by the other Developers. +* When the _Idea_ is in a proper shape and worked out in most details it becomes a _*Draft*_. + This _Draft_ need to be carefully reviewed, commented, perhaps corrected and rated by the other Developers. * We decide on some proposals to talk about that another time, these get a _*Parked*_ state. -* At some point we may decide that a _Draft_ becomes a _*Final*_. Usually, this happens in our link:MonthlyMeetings[]. _Final_ Documents will be imported into the git repository (currently to the tiddlywiki). -* Sometimes proposals will become dropped for some reason, this is indicated by changing their state to _*Dropped*_, they still stay in the system for further reference. +* At some point we may decide that a _*Draft*_ becomes a _*Final*_. + Usually, this happens in our link:/devs-vault/meeting/index.html[monthly developers meetings]. +* Sometimes proposals will become dropped for some reason, this is indicated by changing their state to _*Dropped*_, + they still stay in the system for further reference. -Generally you should refrain from editing someone others proposals (except for typo and gramatic fixes) when this is not acknowleded with the original author. Rather only add comments to the pages and end them with `@SIG@` to make it easier to find out who is the contact person for some note. +Generally you should refrain from editing someone others proposals (except for typo and grammar fixes) +when this is not acknowledged with the original author. Rather only add comments to the pages and please +care to sign your comments in order to make it easier to find out who is the contact person for some note. -.Add a new Proposal: -. Check if there is no similar proprosal below! If yes, contact it's author and contribute to that one. -. Think of a good/descriptive *WikiName* for the Proposal. It will be used to create a RfC subpage. -. Read the instructions and add your proposed text. +What qualifies as an RfC proposal +--------------------------------- +CAUTION: to be written + +Handling of RfC entries in practice +----------------------------------- + +.Adding a new Proposal: +. Check if there is no similar proposal below! If yes, contact it's author and contribute to that one. +. Think of a good/descriptive _Name-ID_ for the Proposal. It will be used to create a RfC sub-page, so no embedded spaces please. +. [red,yellow]#!TODO!# _please describe how to use the +rfc.sh+ here_. - * link:rfc[RfC accepted] - * link:rfc_pending[RfC pending] - * link:rfc_dropped[RfC dropped] - - -[icon="warning.png"] -WARNING: Website under construction - diff --git a/doc/devel/rfc/AllPluginInterfacesAreC.txt b/doc/devel/rfc/AllPluginInterfacesAreC.txt index 84121f9f4..5408d2f23 100644 --- a/doc/devel/rfc/AllPluginInterfacesAreC.txt +++ b/doc/devel/rfc/AllPluginInterfacesAreC.txt @@ -170,5 +170,6 @@ after a talk on irc, we decided to do it this way, further work will be documented in the repository (tiddlywiki/source) -- link:ct[] [[DateTime(2007-07-11T13:10:07Z)]] + '''' -Back to link:Lumiera/DesignProcess[] +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] diff --git a/doc/devel/rfc/ArchitectureOverview.txt b/doc/devel/rfc/ArchitectureOverview.txt index f0aa3691c..116703b57 100644 --- a/doc/devel/rfc/ArchitectureOverview.txt +++ b/doc/devel/rfc/ArchitectureOverview.txt @@ -12,9 +12,10 @@ Architecure Overview -------------------- This proposal intends to capture envisioned Architecture of the Application. -See the SVG drawing -http://www.lumiera.org/gitweb?p=LUMIERA;a=blob_plain;f=doc/devel/draw/Lumi.Archi -ecture-1.svg;hb=HEAD[Overview of Lumiera Architecture)] maintained in GIT +image:{ldoc}/devel/draw/rendered/Lumi.Architecture-1.png[Overview of Lumiera Architecture] + +^The SVG source of this drawing is +link:http://www.lumiera.org/gitweb?p=LUMIERA;a=blob_plain;f=doc/devel/draw/Lumi.Architecture-1.svg;hb=HEAD[maintained in GIT]^ Description @@ -38,10 +39,11 @@ Description Comments -------- - * Alcarinque made http://telniratha.atspace.com/ui_architecture.jpg[some - drafts] for the ui. Here is the - http://telniratha.atspace.com/ui_architecture.odg[oodraw document]. This is - not a technical draft at all, it is just an idea. + * Alcarinque made link:/documentation/design/gui/GuiDiscussion/Proposal.Alcarinque.html[some + design drafts] for the UI. Here is the + link:/documentation/design/gui/GuiDiscussion/Proposal.Alcarinque.svg[SVG source] (converted + from OODraw by Ichthyo 2011). This is not a technical draft at all, it is just + an idea. * Wouldn't the Config Rules (embedded Prolog) also interact with the High Level Model? Or would that be expanding its scope too much? I imagine @@ -75,4 +77,4 @@ maintained in future. -Back to link:Lumiera/DesignProcess[] +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] diff --git a/doc/devel/rfc/CCodingStyleGuide.txt b/doc/devel/rfc/CCodingStyleGuide.txt index d4d725863..72914077d 100644 --- a/doc/devel/rfc/CCodingStyleGuide.txt +++ b/doc/devel/rfc/CCodingStyleGuide.txt @@ -212,4 +212,4 @@ point", i.e. every point in the sytem, that can be extended by plugins. -- 217.110.94.1 [[DateTime(2007-07-10T17:23:33Z)]] '''' -Back to link:Lumiera/DesignProcess[] +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] diff --git a/doc/devel/rfc/CodingStyle.txt b/doc/devel/rfc/CodingStyle.txt index a96adc211..a353bc6c0 100644 --- a/doc/devel/rfc/CodingStyle.txt +++ b/doc/devel/rfc/CodingStyle.txt @@ -97,4 +97,4 @@ most any style. The only thing I really dislike is using tabs (with the exeption of database DDLs and CSound files, where tab are actually helpful) :) '''' -Back to link:Lumiera/DesignProcess[] +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] diff --git a/doc/devel/rfc/DataBackend.txt b/doc/devel/rfc/DataBackend.txt index d4a1db749..b416a9404 100644 --- a/doc/devel/rfc/DataBackend.txt +++ b/doc/devel/rfc/DataBackend.txt @@ -72,4 +72,4 @@ Developement takes place in the repo now -- link:ct[] [[DateTime(2007-06-27T16:14:56Z)]] '''' -Back to link:Lumiera/DesignProcess[] +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] diff --git a/doc/devel/rfc/DevelopmentFramework.txt b/doc/devel/rfc/DevelopmentFramework.txt index 235021bbe..76a03255f 100644 --- a/doc/devel/rfc/DevelopmentFramework.txt +++ b/doc/devel/rfc/DevelopmentFramework.txt @@ -128,4 +128,4 @@ We have now a \'compatibility wiki\', finalized this proposal -- link:ct[] [[DateTime(2008-03-26T13:43:26Z)]] '''' -Back to link:Lumiera/DesignProcess[] +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] diff --git a/doc/devel/rfc/DistributedDevelopmentFramework.txt b/doc/devel/rfc/DistributedDevelopmentFramework.txt index 2665cb5a0..926dc1549 100644 --- a/doc/devel/rfc/DistributedDevelopmentFramework.txt +++ b/doc/devel/rfc/DistributedDevelopmentFramework.txt @@ -62,4 +62,4 @@ much discussion -- link:ct[] [[DateTime(2007-06-27T16:07:13Z)]] -Back to link:Lumiera/DesignProcess[] +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] diff --git a/doc/devel/rfc/EDLsAreMetaClips.txt b/doc/devel/rfc/EDLsAreMetaClips.txt index 8df2d722e..9f474f124 100644 --- a/doc/devel/rfc/EDLsAreMetaClips.txt +++ b/doc/devel/rfc/EDLsAreMetaClips.txt @@ -163,4 +163,4 @@ This Design Entry concerns whether to include such a feature and discusses the general questions when doing so. As we for sure include meta-clip, and so so exactly in the way described here, this proposal is 'final' now. -Back to link:Lumiera/DesignProcess[] +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] diff --git a/doc/devel/rfc/GloballInitialization.txt b/doc/devel/rfc/GloballInitialization.txt index 92e8df2f6..45dd7d828 100644 --- a/doc/devel/rfc/GloballInitialization.txt +++ b/doc/devel/rfc/GloballInitialization.txt @@ -185,4 +185,4 @@ on such an init, but i would add one if really needed. basically agreed on it iirc. -- link:ct[] [[DateTime(2008-07-26T09:08:11Z)]] -Back to link:Lumiera/DesignProcess[] +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] diff --git a/doc/devel/rfc/HowToProceed.txt b/doc/devel/rfc/HowToProceed.txt index 561f0d35e..9efad43e0 100644 --- a/doc/devel/rfc/HowToProceed.txt +++ b/doc/devel/rfc/HowToProceed.txt @@ -53,4 +53,4 @@ Comments * Accepted, deployed, done ... Final -- link:ct[] [[DateTime(2007-06-27T16:13:25Z)]] -Back to link:Lumiera/DesignProcess[] +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] diff --git a/doc/devel/rfc/InterfaceNamespaces.txt b/doc/devel/rfc/InterfaceNamespaces.txt index bc9d8a39b..78e00b0a6 100644 --- a/doc/devel/rfc/InterfaceNamespaces.txt +++ b/doc/devel/rfc/InterfaceNamespaces.txt @@ -139,4 +139,4 @@ make no guarantee about backwards compatibility. When we spot someone using this interfaces we ''will break'' his plugin ''intentionally''! -- link:ct[] [[DateTime(2008-10-24T03:43:43Z)]] -Back to link:Lumiera/DesignProcess[] +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] diff --git a/doc/devel/rfc/LumieraDesignProcess.txt b/doc/devel/rfc/LumieraDesignProcess.txt index bebf46256..1c8331e74 100644 --- a/doc/devel/rfc/LumieraDesignProcess.txt +++ b/doc/devel/rfc/LumieraDesignProcess.txt @@ -81,4 +81,4 @@ wiki (or maybe bouml). Comments -------- -Back to link:Lumiera/DesignProcess[] +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] diff --git a/doc/devel/rfc/Manifest.txt b/doc/devel/rfc/Manifest.txt index adc41ca2e..beb8f0178 100644 --- a/doc/devel/rfc/Manifest.txt +++ b/doc/devel/rfc/Manifest.txt @@ -109,4 +109,4 @@ Comments -Back to link:Lumiera/DesignProcess[] +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] diff --git a/doc/devel/rfc/MasterRepositorySetup.txt b/doc/devel/rfc/MasterRepositorySetup.txt index 85c19e720..31c3b6ceb 100644 --- a/doc/devel/rfc/MasterRepositorySetup.txt +++ b/doc/devel/rfc/MasterRepositorySetup.txt @@ -53,4 +53,4 @@ repos to push relevant things, be careful not to push cruft or tags (which tags shall be present here is not yet resolved -> no tags for now) -- link:ct[] [[DateTime(2008-04-08T21:48:51Z)]] -Back to link:Lumiera/DesignProcess[] +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] diff --git a/doc/devel/rfc/MonthlyDeveloperMeetingOnIRC.txt b/doc/devel/rfc/MonthlyDeveloperMeetingOnIRC.txt index d7cfba332..68053e908 100644 --- a/doc/devel/rfc/MonthlyDeveloperMeetingOnIRC.txt +++ b/doc/devel/rfc/MonthlyDeveloperMeetingOnIRC.txt @@ -94,4 +94,4 @@ Comments we have more devs than now :P) -- link:ct[] [[DateTime(2007-06-17T17:20:37Z)]] -Back to link:Lumiera/DesignProcess[] +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] diff --git a/doc/devel/rfc/NoBugFlags.txt b/doc/devel/rfc/NoBugFlags.txt index 8714a5fd5..926e544bf 100644 --- a/doc/devel/rfc/NoBugFlags.txt +++ b/doc/devel/rfc/NoBugFlags.txt @@ -51,4 +51,4 @@ cehteh will care for further integration -Back to link:Lumiera/DesignProcess[] +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] diff --git a/doc/devel/rfc/ProcBuilder.txt b/doc/devel/rfc/ProcBuilder.txt index f64ecb261..6762c98ed 100644 --- a/doc/devel/rfc/ProcBuilder.txt +++ b/doc/devel/rfc/ProcBuilder.txt @@ -74,4 +74,4 @@ This proposal reflects a distinct approach taken right from start. Marked 'final' at October.2008 developer meeting -Back to link:Lumiera/DesignProcess[] +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] diff --git a/doc/devel/rfc/RepositorySetup.txt b/doc/devel/rfc/RepositorySetup.txt index 7c08213d2..e01bfed99 100644 --- a/doc/devel/rfc/RepositorySetup.txt +++ b/doc/devel/rfc/RepositorySetup.txt @@ -118,4 +118,4 @@ Comments in the git repository (and we already started to define things there) see ./admin/treeinfo.sh -- link:ct[] [[DateTime(2007-06-27T16:01:52Z)]] -Back to link:Lumiera/DesignProcess[] +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] diff --git a/doc/devel/rfc/ScriptingLanguage.txt b/doc/devel/rfc/ScriptingLanguage.txt index 2f49fc73a..1cb126e6d 100644 --- a/doc/devel/rfc/ScriptingLanguage.txt +++ b/doc/devel/rfc/ScriptingLanguage.txt @@ -142,4 +142,4 @@ Conclusion Lua is '''accepted''' as the required scripting language by October.2008 dev meeting. -Back to link:Lumiera/DesignProcess[] +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] diff --git a/doc/devel/rfc/TimeHandling.txt b/doc/devel/rfc/TimeHandling.txt index c185c8e18..6896bc966 100644 --- a/doc/devel/rfc/TimeHandling.txt +++ b/doc/devel/rfc/TimeHandling.txt @@ -138,4 +138,4 @@ Conclusion added on demand. When doing so, we need to add thorough test coverage for time calculations too. -Back to link:Lumiera/DesignProcess[] +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] diff --git a/doc/devel/rfc/index.txt b/doc/devel/rfc/index.txt new file mode 100644 index 000000000..c9e8a4515 --- /dev/null +++ b/doc/devel/rfc/index.txt @@ -0,0 +1,11 @@ +Accepted Design Proposals +========================= + +//Menu: label accepted +//Menu: sort children + +-> read link:../rfc.html[more about Lumiera RfC] and the Design Process + +The RfC entries listed here where discussed, maybe modified and finally agreed upon +during some developers meeting in the past. So they represent design decisions taken. + diff --git a/doc/devel/rfc_dropped/ApplicationStructure.txt b/doc/devel/rfc_dropped/ApplicationStructure.txt index 584d063b2..3b18ab92b 100644 --- a/doc/devel/rfc_dropped/ApplicationStructure.txt +++ b/doc/devel/rfc_dropped/ApplicationStructure.txt @@ -183,10 +183,9 @@ don't think we get much program options, maybe something to set a GUI skin. Moreover, I've written last year a thin wrapper around the commandline and integrated it with the boost options parser such that user code can receive the remaining options as a vector of std::strings. Please have a look at -http://git.lumiera.org/gitweb?p=LUMIERA;a=blob;f=tests/common/mainsuite.cpp;h=45 -bfd98effd0b7dbe6597f712a1bdfa35232308;hb=HEAD[the test class runner main] for -an usage example. I really want our Lumiera main to be clean and expressive in -the way showed there. Probably the most important part of the startup is +link:http://git.lumiera.org/gitweb?p=LUMIERA;a=blob;f=tests/common/mainsuite.cpp;h=455bfd98effd0b7dbe6597f712a1bdfa35232308;hb=80e1e382f42512ebf2e10a802f77e50327b8fb73[the test class runner main] +for an usage example. I really want our Lumiera main to be clean and expressive +in the way showed there. Probably the most important part of the startup is pulling up the session core; because of that I think most of the startup process falls into the realm of the Proc-Layer. Within Proc, I don't want any significant string manipulations done with C-strings and I don't want raw @@ -198,4 +197,4 @@ to document this here :P -- link:ct[] [[DateTime(2009-02-03T17:28:28Z)]] '''' -Back to link:Lumiera/DesignProcess[] +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] diff --git a/doc/devel/rfc_dropped/GitSubmoduleTransistion.txt b/doc/devel/rfc_dropped/GitSubmoduleTransistion.txt index 54240002b..fdbcd69db 100644 --- a/doc/devel/rfc_dropped/GitSubmoduleTransistion.txt +++ b/doc/devel/rfc_dropped/GitSubmoduleTransistion.txt @@ -84,4 +84,4 @@ We concluded that that submodules are not yet needed with exception for the ./doc folder. Parked for now. -- ct 2008-07-26 09:09:57 -Back to link:Lumiera/DesignProcess[] +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] diff --git a/doc/devel/rfc_dropped/MistakestoAvoid.txt b/doc/devel/rfc_dropped/MistakestoAvoid.txt index 57fba0bc0..4c671b8c8 100644 --- a/doc/devel/rfc_dropped/MistakestoAvoid.txt +++ b/doc/devel/rfc_dropped/MistakestoAvoid.txt @@ -424,4 +424,4 @@ is inherently dangerous. We think the basic algorithms involved are sufficiently well-known and understandable to implement them in a sound manner. '''' -Back to link:Lumiera/DesignProcess[] +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] diff --git a/doc/devel/rfc_dropped/OfficialAssemblyLanguage.txt b/doc/devel/rfc_dropped/OfficialAssemblyLanguage.txt index f2be3063d..a60444951 100644 --- a/doc/devel/rfc_dropped/OfficialAssemblyLanguage.txt +++ b/doc/devel/rfc_dropped/OfficialAssemblyLanguage.txt @@ -158,4 +158,4 @@ Comments [[DateTime(2008-08-04T18:33:58Z)]] '''' -Back to link:Lumiera/DesignProcess[] +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] diff --git a/doc/devel/rfc_dropped/SkillsCollection.txt b/doc/devel/rfc_dropped/SkillsCollection.txt index 557fee8e7..c2c4f3d68 100644 --- a/doc/devel/rfc_dropped/SkillsCollection.txt +++ b/doc/devel/rfc_dropped/SkillsCollection.txt @@ -77,4 +77,4 @@ Comments -------- -Back to link:Lumiera/DesignProcess[] +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] diff --git a/doc/devel/rfc_dropped/TagCloudsOnResources.txt b/doc/devel/rfc_dropped/TagCloudsOnResources.txt index fdc115f59..2c36d76dc 100644 --- a/doc/devel/rfc_dropped/TagCloudsOnResources.txt +++ b/doc/devel/rfc_dropped/TagCloudsOnResources.txt @@ -78,4 +78,4 @@ link:DelectusShotEvaluator[Delectus] '''' -Back to link:Lumiera/DesignProcess[] +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] diff --git a/doc/devel/rfc_dropped/TodoLists.txt b/doc/devel/rfc_dropped/TodoLists.txt index e8c3c135c..1d3b987ac 100644 --- a/doc/devel/rfc_dropped/TodoLists.txt +++ b/doc/devel/rfc_dropped/TodoLists.txt @@ -46,4 +46,4 @@ Comments We decided to use a Tiddlywiki for now until this is further worked out -- link:ct[] [[DateTime(2008-03-08T03:38:50Z)]] -Back to link:Lumiera/DesignProcess[] +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] diff --git a/doc/devel/rfc_dropped/index.txt b/doc/devel/rfc_dropped/index.txt new file mode 100644 index 000000000..fd3958f2d --- /dev/null +++ b/doc/devel/rfc_dropped/index.txt @@ -0,0 +1,18 @@ +Design Proposals not accepted +============================= + +//Menu: label dropped +//Menu: sort children + +-> read link:../rfc.html[more about Lumiera RfC] and the Design Process + +The RfC entries listed here where discussed, but then concluded not to be applicable +for some reason. Either the discussion turned up a completely different solution, or +maybe they got just superseded by changing circumstances. + +Besides that, sometimes we find an entry impossible to care for and discuss in detail +currently, because we know to be occupied with other stuff. In that case, we put that +entry ``on hold'' (state _*Parked*_). Currently (as of 2/2011) these entries show +up in this category here too. + + diff --git a/doc/devel/rfc_pending/ClipCatalogingSystem.txt b/doc/devel/rfc_pending/ClipCatalogingSystem.txt index 18bb651d5..8d9ca5fa5 100644 --- a/doc/devel/rfc_pending/ClipCatalogingSystem.txt +++ b/doc/devel/rfc_pending/ClipCatalogingSystem.txt @@ -117,4 +117,4 @@ without even having to "drive" the development.. --link:Tree[][[DateTime(2008-08-27T20:38:00NZ)]]. '''' -Back to link:Lumiera/DesignProcess[] +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] diff --git a/doc/devel/rfc_pending/DelectusShotEvaluator.txt b/doc/devel/rfc_pending/DelectusShotEvaluator.txt index 554cd3244..fa8d2df12 100644 --- a/doc/devel/rfc_pending/DelectusShotEvaluator.txt +++ b/doc/devel/rfc_pending/DelectusShotEvaluator.txt @@ -385,4 +385,4 @@ very expensive. I'm a sound guy, so I feel your pain... - link:NicholasSA[] 2009-01-04 -Back to link:Lumiera/DesignProcess[] +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] diff --git a/doc/devel/rfc_pending/DesignParamAutomation.txt b/doc/devel/rfc_pending/DesignParamAutomation.txt index f6795b0be..9ed2d9b4a 100644 --- a/doc/devel/rfc_pending/DesignParamAutomation.txt +++ b/doc/devel/rfc_pending/DesignParamAutomation.txt @@ -81,4 +81,4 @@ Comments -------- -Back to link:Lumiera/DesignProcess[] +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] diff --git a/doc/devel/rfc_pending/DesignRenderNodesInterface.txt b/doc/devel/rfc_pending/DesignRenderNodesInterface.txt index 90d1be5f4..19bae98ff 100644 --- a/doc/devel/rfc_pending/DesignRenderNodesInterface.txt +++ b/doc/devel/rfc_pending/DesignRenderNodesInterface.txt @@ -118,4 +118,4 @@ Comments -------- -Back to link:Lumiera/DesignProcess[] +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] diff --git a/doc/devel/rfc_pending/EngineInterfaceOverview.txt b/doc/devel/rfc_pending/EngineInterfaceOverview.txt index 9e242a27f..7e89c4a9c 100644 --- a/doc/devel/rfc_pending/EngineInterfaceOverview.txt +++ b/doc/devel/rfc_pending/EngineInterfaceOverview.txt @@ -242,4 +242,4 @@ Conclusion //////////////////// -Back to link:Lumiera/DesignProcess[] +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] diff --git a/doc/devel/rfc_pending/FeatureBundle_PluggableModules.txt b/doc/devel/rfc_pending/FeatureBundle_PluggableModules.txt index 146e85e76..7124b01b1 100644 --- a/doc/devel/rfc_pending/FeatureBundle_PluggableModules.txt +++ b/doc/devel/rfc_pending/FeatureBundle_PluggableModules.txt @@ -186,4 +186,4 @@ link:Plugin/Interface[] system self-describing this will also be used to bootstrap a session on itself (by the serializer which is tightly integrated) -- link:ct[] [[DateTime(2008-09-04T09:28:37Z)]] 2008-09-04 09:28:37 -Back to link:Lumiera/DesignProcess[] +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] diff --git a/doc/devel/rfc_pending/LumieraForwardIterator.txt b/doc/devel/rfc_pending/LumieraForwardIterator.txt index 72dd17041..5994865bd 100644 --- a/doc/devel/rfc_pending/LumieraForwardIterator.txt +++ b/doc/devel/rfc_pending/LumieraForwardIterator.txt @@ -135,4 +135,4 @@ Comments -------- -Back to link:Lumiera/DesignProcess[] +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] diff --git a/doc/devel/rfc_pending/MarbleMode.txt b/doc/devel/rfc_pending/MarbleMode.txt index 130ac80ce..a77afdd85 100644 --- a/doc/devel/rfc_pending/MarbleMode.txt +++ b/doc/devel/rfc_pending/MarbleMode.txt @@ -134,4 +134,4 @@ Comments -------- -Back to link:Lumiera/DesignProcess[] +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] diff --git a/doc/devel/rfc_pending/NormalizedDeviceCoordinates.txt b/doc/devel/rfc_pending/NormalizedDeviceCoordinates.txt index 87496b4e8..e5bbd7cdb 100644 --- a/doc/devel/rfc_pending/NormalizedDeviceCoordinates.txt +++ b/doc/devel/rfc_pending/NormalizedDeviceCoordinates.txt @@ -101,4 +101,4 @@ framerate" and a fixed resolution in pixels. But we certainly can do better. -- Ichthyostega 18:09:50 -Back to link:Lumiera/DesignProcess[] +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] diff --git a/doc/devel/rfc_pending/ProcHighLevelModel.txt b/doc/devel/rfc_pending/ProcHighLevelModel.txt index 4f8c6918f..408c020a0 100644 --- a/doc/devel/rfc_pending/ProcHighLevelModel.txt +++ b/doc/devel/rfc_pending/ProcHighLevelModel.txt @@ -240,4 +240,4 @@ Comments -------- -Back to link:Lumiera/DesignProcess[] +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] diff --git a/doc/devel/rfc_pending/ProcPlacementMetaphor.txt b/doc/devel/rfc_pending/ProcPlacementMetaphor.txt index d6ba41545..7617b97e8 100644 --- a/doc/devel/rfc_pending/ProcPlacementMetaphor.txt +++ b/doc/devel/rfc_pending/ProcPlacementMetaphor.txt @@ -228,4 +228,4 @@ benchmark in more ways than one, for some time. . --link:Tree[][[DateTime(2008-08-23T12:54:00NZ)]]. -Back to link:Lumiera/DesignProcess[] +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] diff --git a/doc/devel/rfc_pending/RenderOptimizer.txt b/doc/devel/rfc_pending/RenderOptimizer.txt index ce2c57b7c..956aa89a4 100644 --- a/doc/devel/rfc_pending/RenderOptimizer.txt +++ b/doc/devel/rfc_pending/RenderOptimizer.txt @@ -86,4 +86,4 @@ The good news is, that: the matrix can be transformed from e.g. RGB to YUV, so these filters can always work in both colorspaces directly -Back to link:Lumiera/DesignProcess[] +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] diff --git a/doc/devel/rfc_pending/Roadmap-first.txt b/doc/devel/rfc_pending/Roadmap-first.txt index a8a38d50a..57aea6d97 100644 --- a/doc/devel/rfc_pending/Roadmap-first.txt +++ b/doc/devel/rfc_pending/Roadmap-first.txt @@ -203,4 +203,4 @@ with other media related projects), than this shouldn't be a barrier. -- link:Ichthyostega[] 2009-02-01 -Back to link:Lumiera/DesignProcess[] +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] diff --git a/doc/devel/rfc_pending/StreamTypeSystem.txt b/doc/devel/rfc_pending/StreamTypeSystem.txt index 4a81eaf9b..2b6adbc06 100644 --- a/doc/devel/rfc_pending/StreamTypeSystem.txt +++ b/doc/devel/rfc_pending/StreamTypeSystem.txt @@ -231,4 +231,4 @@ frameinfo* get_frame(unsigned num)+ where +struct frameinfo+ (not yet defined) is something like +{ void* data; size_t size; struct metadata* meta; ...}+ -- link:ct[] 2008-10-06 -Back to link:Lumiera/DesignProcess[] +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] diff --git a/doc/devel/rfc_pending/TimelineSequenceOutput.txt b/doc/devel/rfc_pending/TimelineSequenceOutput.txt index 6df043dcd..d94071cb8 100644 --- a/doc/devel/rfc_pending/TimelineSequenceOutput.txt +++ b/doc/devel/rfc_pending/TimelineSequenceOutput.txt @@ -267,4 +267,4 @@ GUI handling could make use of expanded view features like ; Tree 2008-12-19 22:58:30 -Back to link:Lumiera/DesignProcess[] +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] diff --git a/doc/devel/rfc_pending/UseCases.txt b/doc/devel/rfc_pending/UseCases.txt index 2c8ca2884..423263e87 100644 --- a/doc/devel/rfc_pending/UseCases.txt +++ b/doc/devel/rfc_pending/UseCases.txt @@ -291,4 +291,4 @@ credit roll for each episode. Add in stopmotion, and 3D model animations with vocal commentaries. Gather together separate items from "outworkers". Tree (@)SIG(@) -Back to link:Lumiera/DesignProcess[] +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] diff --git a/doc/devel/rfc_pending/index.txt b/doc/devel/rfc_pending/index.txt new file mode 100644 index 000000000..c553617c7 --- /dev/null +++ b/doc/devel/rfc_pending/index.txt @@ -0,0 +1,21 @@ +Design Proposals in discussion +============================== + +//Menu: label pending +//Menu: sort children + +-> read link:../rfc.html[more about Lumiera RfC] and the Design Process + +The RfC entries listed here where proposed but not finally decided or agreed on -- + +* entries in the _*Idea*_ stage are yet to be worked out in detail. Usually they + just sit there and only receive occasional discussions, until the original author + considers them mature and puts them on agenda on some developers meeting. +* entries in the _*Draft*_ stage are basically ready for discussion or decision; + but sometimes they are kept _on hold_ -- maybe there is something controversial + or some details need to be investigated further. +* sometimes we just decide to postpone the discussion -> see + link:../rfc_dropped/index.html[dropped and parked entries] + + + diff --git a/doc/template/rfc.txt b/doc/devel/template_rfc.sh similarity index 94% rename from doc/template/rfc.txt rename to doc/devel/template_rfc.sh index 0988835bd..a08ac3d06 100644 --- a/doc/template/rfc.txt +++ b/doc/devel/template_rfc.sh @@ -73,4 +73,7 @@ Comments //endof_comments: + +'''' +Back to link:/documentation/devel/rfc.html[Lumiera Design Process overview] EOF diff --git a/doc/index.txt b/doc/index.txt index 86eaac0d9..ad0c5d3ee 100644 --- a/doc/index.txt +++ b/doc/index.txt @@ -1,8 +1,5 @@ == Documentation -[icon="warning.png"] -WARNING: Website under construction - This documentation section contains documentation for both users and developers. === User diff --git a/doc/technical/backend/index.txt b/doc/technical/backend/index.txt index a3973d3f1..58fd1a5e9 100644 --- a/doc/technical/backend/index.txt +++ b/doc/technical/backend/index.txt @@ -1,9 +1,8 @@ Technical Documentation: Backend ================================ +Eventually, this will have technical documentation for the Backend. + +For now, we have: + * link:ConfigLoader.html[Config Loader brainstorming from 2008] - - -[icon="warning.png"] -WARNING: Website under construction - diff --git a/doc/technical/build/index.txt b/doc/technical/build/index.txt index b9575cbd2..a9b3261da 100644 --- a/doc/technical/build/index.txt +++ b/doc/technical/build/index.txt @@ -1,5 +1,7 @@ -Lumiera Buildsystem -=================== +Lumiera build system +==================== + +As work progresses, we will add more information on the Lumiera build system. build -- continuous integration -- packaging @@ -7,9 +9,7 @@ build -- continuous integration -- packaging * Autotools * Dependencies * link:BuildDroneDraft.html[»Builddrone« concept from 2008] -* packaging: Debian RPM +* Packaging: Debian RPM * Lumiera debian depot -[icon="warning.png"] -WARNING: Website under construction diff --git a/doc/technical/gui/index.txt b/doc/technical/gui/index.txt index c88640368..e51ed8ee1 100644 --- a/doc/technical/gui/index.txt +++ b/doc/technical/gui/index.txt @@ -1,7 +1,5 @@ Technical Documentation: GUI ============================ - -[icon="warning.png"] -WARNING: Website under construction +Eventually, this will have technical documentation for the GUI. diff --git a/doc/technical/howto/index.txt b/doc/technical/howto/index.txt index 50e3158f4..20450cd49 100644 --- a/doc/technical/howto/index.txt +++ b/doc/technical/howto/index.txt @@ -1,6 +1,8 @@ Developer HOWTOs ================ +//MENU: title Dev HOWTOs + This section contains a loose collection of instructions, recipes, tutorials and similar usefull pieces of information targeted at Lumiera developers. See also @@ -10,9 +12,3 @@ similar usefull pieces of information targeted at Lumiera developers. See also == Notepad - link:DebugGdbPretty.html[Python pretty printers for GDB] - - -[icon="warning.png"] -WARNING: Website under construction - - diff --git a/doc/technical/index.txt b/doc/technical/index.txt index eeaa78017..845b88346 100644 --- a/doc/technical/index.txt +++ b/doc/technical/index.txt @@ -2,13 +2,16 @@ Technical Documentation ======================= -This documentation section contains technical documentation about Lumiera. -To get an overview of all the internals and components, you might want to read +This documentation section contains technical documentation about Lumiera. To +get an overview of all the internals and components, you might want to read link:innerCore/the_inner_core.html[Lumiera the Inner Core] == Three Layers -The technical documentation is split in three parts, one for each of the three main layers of Lumiera. -You may want to read the link:../design/index.html[Design Documents] first to get an overview of all the components. + +The technical documentation is split in three parts, one for each of the three +main layers of Lumiera. You may want to read the +link:../design/index.html[Design Documents] first to get an overview of all the +components. * link:gui/index.html[*Graphical User Interface*] : Documents related to the GTK based Lumiera GUI @@ -28,9 +31,3 @@ You may want to read the link:../design/index.html[Design Documents] first to ge .HOWTO * link:howto/index.html[*Developer HOWTOs*] : Collection of instructions, recipes, hints and similar materials intended for developers - - -[icon="warning.png"] -WARNING: Website under construction - - diff --git a/doc/technical/infra/MenuGen.txt b/doc/technical/infra/MenuGen.txt new file mode 100644 index 000000000..7691f8528 --- /dev/null +++ b/doc/technical/infra/MenuGen.txt @@ -0,0 +1,277 @@ +Website Navigation Generator +============================ +:Author: Hermann Voßeler +:Date: 2/2011 + + +This page contains documentation and notes regarding the +menugen.py+ -- +written 2/2011 during our attempt to get the new Lumiera website online finally. +The link::http://git.lumiera.org/gitweb?p=website-staging;a=blob;f=menugen.lua;h=aad2129d7f4ed3f3b35b2fc3ac2a63a9f1bfb62d;hb=menugen[initial draft version] was written by _cehteh_ in Lua + + +************************************************************************** +The purpose of the +*menugen*+ script is to maintain the navigation menu +on the Lumiera website semi-automatically. In the usual setup, this script +is triggered from a _Git push_ -- it walks the web subdirectories and +discovers menu entries. The generated HTML page contains both visible +elements and JavaScript snippets to display and highlight the menu +on the client side appropriately +************************************************************************** + +Overview: how it works +---------------------- +The menu generation and display is comprised of several parts working together + +. the +build_website.sh+ is triggered as a Git post-receive hook, whenever new + commits are transfered to the website Git repository. After discovering new + Asciidoc source files and generating the corresponding HTML files, the + menu generator script is invoked +. the +menugen+ python script walks the subdirectories to discover possible + menu contents. It visits Asciidoc source files (`*.txt`) and picks up + + - the location / URL + - the title + - special `//MENU:` directives embedded in Asciidoc comments + +. after building a complete menu tree (actually a DAG), this data structure + is walked to generate output HTML into a `menu.html` file in website root. +. the page template (`page.conf`) for generated Asciidoc pages contains an + +