Welcome to the Atlas Support Site

Atlas is the amazing new knowledgebase and community support system from Countersoft. If a question needs an answer and an answer needs a home then Atlas is where it lives. With unique Relevant Replies and lighting fast Tag and Text Filter, knowledge is at your fingertips.




Index Creating and Compiling Documentation
Previous  |  Next

 1      Installation Guide
 2      About Atlas
 2.1        Tagging
 2.2        Navigating
 3      Content Types
 3.1        Questions
 3.2        FAQs
 3.3        Docs
 3.4        Videos
 4      Documentation
 4.1        Creating and Compiling Documentation
 5      Administering Atlas
 5.1        General Settings
 5.2        Setting up tags
 5.3        Managing Users
 5.4        Integrating with Email
 5.5        Integrating with Gemini Issue Tracker
 5.6        Viewing System Logs
View  |  Print  |  PDF

18 documents found.


Creating and Compiling Documentation

docs
overview

 Creating Documentation

One of the most powerful features of Atlas is the ease and flexibility it provides when it comes to producing documentation around a subject. With Atlas there is no need to produce manuals and guides, if documentation is written and uploaded in logical sections, then users can compile and print their own documentation from the Docs content section. This is a particularly powerful feature for those users who might wish to augment the documentation, or alter it for their specific customizations as they can now take the documentation they want, in digital format, copy and alter it.

Countersoft recommend that rather than produce multiple chapters of information in a single document, authors of documentation, particularly user manuals and guides, place each chapter in its own, separate document and allow users to selectively aggregate the material they require.

Document Numbering & Hierarchies

Atlas maintains a structure to documentation for you. All documents are sequentially numbered and this numbering takes the form set out below:

1.0 Section Heading

      1.1 Document

      1.2 Document

            1.2.1. Document

            1.2.2 Document

      1.3 Document

2.0 Section Heading

      2.1 Document

      2.2 Etc.

 Atlas numbers documents automatically when they are added or moved, which includes maintaining the child ‘dot’ number notation.

Section Headers are placeholders in the hierarchy and require no copy (though you can add descriptions to them if you wish). To create a Section Header simply tick the Section Header checkbox when adding or editing the document. Content cannot currently be flagged as a Section Header if it is created in Windows Livewriter.

Copying Documents

atlas_bar_doc_copy.JPGWhen one or more documents can serve as a template for others they can be copied. Select the document(s) you wish to copy and click on the “copy” link (shown in the image above). Atlas will prompt with a parent location for the copied document(s) and if none is specified the copied document(s) will be appended to the existing document structure. Copied documents will be given the title “copy of <original document name>”, which can be changed by editing the document and amending the title.

Deleting Documents

atlas_bar_doc_delete.JPGIf you are logged in with administrative privileges you can one or more documents in a single operation by selecting the document(s) and clicking on the “delete” link (shown inthe image above). Atlas will prompt for confirmation of the action and if it is confirmed the selected document(s) will be deleted from the Atlas database.

Moving Documents

atlas_bar_doc_move.JPGIf you are logged in with administrative privileges you can alter the document hierarchy (and therefore numbering) by moving documents. To move one or more documents users select the document(s) to move, click on the “move” link (shown in the image above). Atlas will prompt the user to determine if a document should have a new parent and whether any child documents should be moved at the same time. To move documents to the end simply click on “move” {image of the move button} without specifying a new parent. When documents (and any children) are moved Atlas renumbers the hierarchy.

Compiling and printing documentation

atlas_bar_view_print_pdf.JPGTo create, view or print a custom manual/guide from multiple documents users need only navigate to the Docs section and select the documents to be compiled, viewed or printed by clicking on the check box next to the document title. Click on “view”, “print” or “pdf” (shown in the image above) and Atlas will compile the selected documents into a single selection and display it on the screen in HTML, initiate the printer dialogue, or create a pdf that can be printed, or downloaded and stored.


Previous  |  Next