7/6/2023 0 Comments Gnucash tutorial video![]() ![]() To test the linkages between GnuCash and help files in Linux, see Test Documentation in Linux.See The Make Utility for more on using and installing make. To check your changes, you will use the make utility to compile the documentation locally.You likely will also follow these steps to install a few additional tools: You can start by following instructions in Initializing Documentation Build Environment to create a recommended base directory structure with the source files in place and ready to be edited. epub, mobi calibre can display these mobile formats. Alternatively Kde's help browser KHelpcenter can be used. docbook Gnome's help browser Yelp-This is desired. Html any web browser-This is the minimum requirement. Maintenance OptiPNG should be run once on new png files, also in stylesheets. Identify-and in other instructions convert from ImageMagick, a nice toolset to manipulate images or query their parameters, awk from gawk, bc from bc, but the later two are in most cases already installed. Illustrations To illustrate your text with Screenshots and Images, you can use forĭiagrams any SVG able drawing program like OfficeDraw (available from LibreOffice or OpenOffice), Screenshots Creation the built-in PrintScreen of your OS or desktop environment, Manipulation Our script util/adjust-dpi.sh uses the following programs But some editors or IDEs offer Syntaxhighlighting and perhaps other specific tools for Docbook or at least XML. Any text editor will do, as long as it can save your files without extra markup. That will require:Įditing Text To edit the source files, you will need to have a plain text editor. You can now edit text or add/update images. Build System To check and install your version with make commands CMake is used. Version Control System To manage your changes of the source text, you will install Git. But here it is probably better explained: The recent details are in Requirements in the README file. To begin changing the documentation, you will need to set up your system with the proper software. It may be helpful to become familiar with the references given in the REFERENCES section below. The above brief description outlines the general documentation update process. If everything is accepted without requiring further work, your changes will be applied to the main set of documentation by a developer and you will be notified of that action. After your changes have been validated locally, you will submit your changes to the project either through a "patch," or by a git "pull request" (both of which will be explained later).įor quality control, any changes you submit will be reviewed by a developer before your changes become official. ![]() This process permits you to be sure that only what you intend will actually be installed. Since your changes will be carried out by software, there is a difference determination process that identifies exactly what and where changes will be made. As a documentation support person, your task is to shepherd your modifications through all stages from start to finish.Īt each stage, you must validate your changes to assure that they are both valid and have the intended effect, and you must address any errors or unexpected changes that are found. Later in the process, the XML files are converted to other versions (HTML, PDF, etc.) for viewing. These source files use a special markup in XML to provide structure. For background on these tools, see Build Tools.Īny changes you make will be inserted into local copies of the source documentation files and subsequently transferred to the main documentation set. The tools and the process are outlined in this page. These aspects require that documentation contributors learn and use several specialized tools to engage the process. It also requires contributors to check their contributions for compatibility by compiling the documentation before final submission. This includes using a version control system (VCS) to coordinate contributions from disparate sources, as well as using DocBook, a semantic markup language for technical documentation based on eXtended Markup Language (XML) for the actual edits. This ensures that changes are made consistently and reliably. The documentation update process uses the same software management tools that are used for updating the program itself. Preface and Introduction - What to expect 5.1.5 Adjusting an Image's Dots Per Inch. ![]() 4 References to Supporting Technologies Used.3.6 Ensure Only Expected Changes Have Been Made.3.5.3 Completeness Check: After Adding, Moving or Deleting Files.3.4.3 Telling the Program of a New Help Context. ![]()
0 Comments
Leave a Reply. |