Difference between revisions of "User Manual/TODO"

User Manual/TODO (view source)

Revision as of 12:43, 17 July 2009

1,320 bytes added , 12:43, 17 July 2009

→‎Reorganise the content as described above: update plans for manual structure modification

Criezy

TrustedUser

2,147

edits

@@ Line 67: / Line 67: @@
 == TO DO ==
 === Reorganise the content as described above ===
+I would like to keep the history and discussion for the existing pages of the current documentation. Therefore some of the pages will be kept or renamed. We will need to create new pages.
+Until I make all the modifications in the structure, work can go on on the existing pages and the new pages can be created.
+List of pages after reorganisation:
+ + Introduction
+ + Quick Start
+ ScummVM interface (or everything on one page?)
+  + Main Window
+  + Options
+  + Game settins
+  + In-game menu
+ Using ScummVM
+  + Getting and installing ScummVM
+  + Setting up ScummVM
+  + Installing games for use with ScummVM
+  + Adding and running a game in ScummVM
+  + Setting up a game in ScummVM
+  + Removing a game from ScummVM
+  + Uninstalling ScummVM
+ Getting Help
+  + FAQ
+  + Contacts
+ Appendix
+  + Command line options
+  + Config file descripion
+  + Tools
+Here is the mapping between the old pages and new pages I intend to do:
+ Introduction -> Introduction
+ Getting started -> Getting and installing ScummVM
+ Running and using ScummVM -> Adding and running a game in ScummVM
+ Game Specific Instructions -> Installing a game for use with ScummVM
+ Configuration -> Setting up ScummVM
+ Appendix: Tools -> Appendix: Tools
+And a list of pages that will need to be created:
+ Quick Start
+ ScummVM interface (one or four pages?)
+  + Main Window
+  + Options
+  + Game settins
+  + In-game menu
+ Setting up a game in ScummVM
+ Removing a game from ScummVM
+ Uninstalling ScummVM
+ FAQ
+ Contacts
+ Command line options
+ Config file descripion
 I ([[User:Criezy|Criezy]]) would like to reorganize the content of the manual on the weekend of August 1.
 Here is how I plan to proceed:
-# Keep current manual as it is while I am working on the reorganization
+# Add a notice on the manual entry page (reorganisation of manual structure underway)
-# Lay down the new skeleton (i.e. create new pages, with _new extension if it clashes with pages of old manual)
+# Rename existing pages
-# Freeze content of old doc (can we make a page read-only?) From that points all the contributions should be done on the new pages.
+# Create new pages (if not already done)
-# Copy all the content from old to new manual.
+# Update manual entry page
-# Remove old manual (or move it to User_Manual_old ?)
+# Fix all links to manual pages/sections.
-# Rename pages (if needed) of new manual. Fix all links to manual pages/sections.
+# Move content around
+# Remove notice from manual entry page
 === Add ScummVM and game installation instructions ===