Skip to content

Latest commit

 

History

History
 
 

doc

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
NOTE: this README is essentially deprecated and will be heavily rewritten once changes I made over the years are reverted to align with a more preservationist method of development. The changelog is no longer needed since I use git more. Any TODO or bugs will be noted in an issue tracker. I will keep some information about dependencies and compiling and also some general style guidance for needed additions to blend in well.

% -- TODO -- %

    % Add index entries - mChat, community project, https://7kfans.com/, forums, download page, 7kfans.com multiplayer service, and cheat mode/cheat codes, idle caravans/ships.
    % Organize key/mouse commands.
    % set text as \raggedright. Currently prefer left and right justified text.
    % set chapter sectioning with small caps (universalis font lacks them). force with \Huge vs. \huge font declaration.
    % set sectioning to mimic original manual - bolder / different size.
    % adjust space between sectioning.
    % make title on title page bolder.
    % remove sectioning numbers.
    % make TOC entries not capital letters.
    % fix large letters not appearing in index.
    % fix bugs:
    	% Manual: Incomplete Tabular Box the3dfxdude#210
    	% Extra Whitespace in the Manual the3dfxdude#209
    	% A Few Bugs in the Manual the3dfxdude#206 
    	% Sectioning and Text Spacing the3dfxdude#202
    	% Chapter Headings Misaligned the3dfxdude#203
	% BUG HERE: ~ pg 11, pg 12, pg 14, pg 17, pg 18, pg 44, pg 47, pg 62, pg 64, pg 65, pg 69, pg 73, pg 93, pg 86, pg 87, pg 91 ...
    % "index anchor is in the wrong spot. It is before the section break, so it's on the last page of credits."
    % reduce whitespace in chapter 16.
    % sort 7kfans credits as chronological.
    % Align "Ancient Adversaries" with the Seven Kingdoms graphic.
    % Restore purple cover.
    % Expand on:  
        % Added trade locations to the trade report. pg#?
        % Sort and filter trade locations based on the map selected caravan. pg#?
        % Allow setting stops using the trade report. pg#? select caravan and right-click on location within the trade scroll to set stop.
        % Allow copying trade routes using the trade report. pg#? Select caravan and right-click on another caravan to clone the trade stop.
    % Improve new assets Itrade and Icaravan.
    % set TOC and index as universalis font. \textsf{} and modify index file.
    % add missing hot keys.
    % modify header text to mimic original manual.
    % change chapter number font and size.
    % make chapter number align with chapter title on bottom line
    % Modify titlesec code to remove the bugs it creates.
    % Period usage in the hotkeys/mouse commands/cheats.
    % the box in the mouse commands looks a bit gray.
    % hotkeys are slightly indented in the original. 
    % 

% -- TODO end -- %

% -- Notes -- % 

    % the original manual "has been designed as an in-depth reference book."
    % Acrobat Distiller 3.02 for Power Macintosh
    % FrameMaker 5.1.1
    % Invoice, Portrait (5.51 × 8.51 inch)
    % Fonts: (ITC) Galliard (Serif) - Black, Bold, Roman, Italic, BoldItalic. GloudyTextMT. Univers (neo-grotesque sans-serif).

    % Some tile graphics extend past top textline. - some due to Huge font. Issue with specific font and size declaration. See font documentation.
    % Uses in, cm, pt, etc. Use just one type? Use in instead of cm.
    % Disagreement between troop and troops in pronoun use.
    % Capitalization is not consistent.

% -- Notes end -- %

% -- Changelog -- %

% v0.3.0

% Summary of changes: 

% Stylistic:
    % Replaced proprietary fonts with substitutable open fonts: Galliard with Accanthis and GloudyTextMT with ygothic.
    % REMOVED ampersands.

% Grammar:
    % Used gender neutral term when referring to all Greater Beings.

% Punctuation:    
    % Modified comma usage: consistency with comma rules, REMOVED comma stops, and separated beginning clauses; REMOVED Oxford commas.
    % REMOVED en and em dashes.
    % REMOVED scare quotes.
    % REMOVED the two dot, non spaced ellipsis; ".."

% Formatting:
    % Text is both left and right justified.
    % More or less whitespace in different locations.
    % Condensed some sentences into 3 sentence minimum paragraphs to correct spacing issues.
    % New manual is a bit longer.
    % Some graphics are different sizes but close approximations to the original.
    % Used simple LaTeX, non colored, ~4in tables.
    % Additional TOC entries. - Standard LaTeX. - Subsections included.
    % ADDED additional sub/sections.
    % Capitalized sectioning according to M.L.A. except for trade situations and FAQ.
    % Used standard LaTeX chapter heading/counter.

% Content:
    % ADDED re-publication date to front page.
    % ADDED the author, original and new, to front page.
    % REMOVED copyright notice.
    % ADDED GPL header, music copyright notice, and Enlight trademark notice with help from the3dfxdude.
    % REMOVED Imagic from manual such as warranty, registration, and help -- except for Imagic credits.
    % ADDED introduction for the open source project, quoted from jlac1024.
    % ADDED website information such as frontpage/news, wiki, forum, download.
    % Rewrote installation chapter with help from the3dfxdude.
    % ADDED information about 7kfans.com multiplayer service.
    % REMOVED troubleshooting information.
    % Updated 7k icon to (color) 7kaa icon.
    % Rearranged interface chapter to preceed the village chapter.
    % Updated reputation penalties with help from the3dfxdude.
    % ADDED and updated hotkeys from MicroVirus' documentation.
    % ADDED more mouse commands from MicroVirus' documentation.
    % ADDED cheat codes from MicroVirus' documentation.
    % ADDED 7kfans credits.
    % Credited manual content authors.
    % Updated lobby graphic to show new lobby.
    % Rearranged material such as registration (repurposed), mouse commands.
    % Fixed factual errors.
    % REMOVED CD-ROM references.
    % REMOVED spinners and troubleshooting index entries.
    % Respelled multi-player to multiplayer and single-player to single player.

% v0.3.1

    % REMOVED \clearpage where not needed.
    % Defined sectioning as textsf.
    % Standardized on listing roles as volunteering for 7kfans credits.
    % Changed from textgoth to textswab.
    % REMOVED installation instructions.
    % Changed 7kaa icon to grayscale.
    % Removed references to the 7kfans.com\wiki link.
    % ADDED 1.4 inch whitespace in addition to the margin for the chapter starts, modifying {before} in \titlespacing\chapter - from original manual.
    % REMOVED dummy section from FAQ and removed sectioning for bf text.
    % Capitalized chapter titles as per original manual. Previously used M.L.A. style. Contents is not all capitalize like the INDEX in the original. This has the consequence of changing the chapter titles to all capital letters in the contents, yet in the original manual, they are not all capital letters.
    % Created new assets Itrade and Icaravan and included them in document with new text regarding updated trade scroll and idle caravans. Expand.

% v0.3.2-dev

    % reduced textswab to huge.
    % commented out titlesec code. Recommented and font size reduced to huge and 30.
    % force smallcaps for universalis by defining starting capital letters as \Huge vs. \huge. This has the effect of making the header text buggy. Original manual has the text in small italics instead of bold/etc. Opposing page has Seven Kingdoms: Ancient Adversaries in italics. And it does not include sectioning numbering. It is most likely the universalis font. Due to bugs, this is being held off.
    % included recent contributor.
    % README - changed internal and arbitrary versioning to 0.3 to reflect the status of the manual being in its third iteration (7k -> 7kaa -> 7kaa GPLv2).
    % Begin using v0.3.2-dev to coincide with 2.15.5-dev in the README.
    % 

% -- Changelog end -- %