WIP: FujiNet Users Guide

[tschak909]

Hello all.

 

I've finally started on a User's Guide for the ATARI FujiNet.

 

It's being written in DocBook, which is a standard for publishing technical books, articles, etc. Its big advantages are that it separates content from style, but it also has a good deal of tags to provide semantic context (such as marking up commands, screen shots, call-outs, etc.) 

 

The current style-sheet is being based on the type setting used by Atari for its more technical software products, such as "Telelink I" and "Music Composer" where the Optima font face is used as the primary font, and the highlight color is a light blue.

 

The documentation, like everything else in FujiNet is being developed publicly, and is available in GitHub:

https://github.com/FujiNetWIFI/fujinet-manuals in the fujinet_for_atari_users folder.

 

The main DocBook file is: https://github.com/FujiNetWIFI/fujinet-manuals/blob/main/fujinet_for_atari_users/fujinet_for_atari_users.dbk

 

I am using a combination of emacs, and XMLMind DocBook Editor to compose the material:

http://www.xmlmind.com/xmleditor/docbook_editor.html

 

 

While there is preliminary styling in place, this isn't being actively changed at the moment, as content floods in. Once content is stable, we can start thinking about refining the style sheets, not just for PDF, but for HTML and EPUB as well.

 

I will periodically attach a render of content, as a PDF, as we go along.

 

Any and all help would be appreciated, as this is a very important undertaking.

 

Some snips of pages:

 

I also recorded a video showing the process, here:

 

-Thom

 

fujinet_for_atari_users.pdf

Edited March 11 by tschak909

[+Allan]

I love the use of the 400/800 style. Looks fantastic.

[tschak909]

18 minutes ago, Allan said:

I love the use of the 400/800 style. Looks fantastic.

Thanks, any images at the moment, are placeholders, which will be re-drawn to match. (especially because as is, the images are far too dark to print well)

 

-Thom

[tschak909]

Part of the reason for writing the #Atari8bit #FujiNet Users Guide, is to formally document the correct behavior of commands. NCD is a complex command, with a lot of expected implicit behavior. It doesn't quite work like this, but it will someday. #retrocomputing

 

[+x=usr(1536)]

@tschak909: Any thoughts on fujinet-pc instructions being included, or is that out of scope?

[tschak909]

4 minutes ago, x=usr(1536) said:

@tschak909: Any thoughts on fujinet-pc instructions being included, or is that out of scope?

it's a good idea. Will need to think on how to fold it in.

 

-Thom

[+x=usr(1536)]

@tschak909: Thom, when you have a moment, can you please look at the following thread:

 

 

AFAIK, no howto was done for building fujinet-pc.  Hopefully this is useful; feel free to use any parts of it that might be.  It (very obviously) wasn't written specifically for inclusion in documentation, but may serve as an outline or similar.  I'd also love for people to try it out and see where the strong and weak points are.

 

I'll be doing one for MacOS at some point (hopefully) soon.  Someone else will have to handle the Windows side  

[tschak909]

For anyone who hacks in MAD Pascal, could you please help me, and take the PASCAL section in part 2, and convert the example programs to build in MAD Pascal? (Optionally cut and paste and adjust the content in the other parts to match?) it's intended to be a Rosetta Stone to show the same examples and pattern for every language.

 

-Thom