Lines Matching full:documentation
81 document under the terms of the <citetitle>GNU Free Documentation
85 of the <citetitle>GNU Free Documentation License</citetitle> from
94 GNOME documentation, and those trademarks are made aware to the members
95 of the GNOME Documentation Project, the names have been printed in caps
100 <title>The GNOME Handbook of Writing Software Documentation</title>
109 <!-- ####### Introduction | The GNOME Documentation Project ####### -->
112 <title>The GNOME Documentation Project</title>
117 The GNOME Documentation Project (GDP) aims to provide GNOME
119 documentation system. At the center of the GDP is the
121 presents a unified interface to GNOME-specific documentation
122 as well as other Linux documentation such as man pages and
124 comprehensive view of documentation on a machine by
125 dynamically assembling the documentation of GNOME
128 both for developers and for users. Developer documentation
142 User documentation include the <ulink
148 GNOME application documentation. Most GNOME applications
158 to help write, update, and edit documentation. If you are
179 writing GNOME documentation but will want to understand how
180 the GNOME documentation system works and will need to
182 outline the structure of how the GNOME documentation system
183 works. Developers who do not write the documentation for
185 write the documentation. This is best done by sending an
191 documentation for the application. The #docs IRC channel on
255 This Handbook is a guide for both writing documentation for
257 packaging documentation into GNOME applications.
260 This Handbook, like all GNOME documentation, was written in
266 Documentation</citetitle> </ulink>. Alternately, one may
276 <title>Getting Started Writing GNOME Documentation</title>
303 documentation. If you notice some inaccuracies or omissions
304 in the documentation, or you think that you can explain the
306 author of the original documentation or to the GNOME
307 documentation project at <email>docs@gnome.org</email>.
312 <title>The GNOME Documentation Status Table</title>
314 The <citetitle>GDP Documentation Status Table</citetitle>
319 documentation components of GNOME. These components include
320 application documentation, internal GNOME component
321 documentation, user documentation, and developer
322 documentation. For each documentation item, it tracks the
323 current status of the documentation, who is working on the
324 particular document, where the documentation can be found,
329 you select a documentation item which needs work done. Once
346 documentation by contacting the application author.
357 All documentation for the GNOME project is written in SGML
359 this for documentation, not least of which is the single
443 gifs, the GNOME Documentation Project has decided to use the
444 PNG image format for all images in GNOME documentation. You
452 many screenshots in its documentation, we use our own
581 documentation distributed with GNOME unless you have the
684 FreeBSD Documentation Project Primer for New
685 Contributors</ulink> - FreeBSD documentation project
687 writing documentation using DocBook. Note that it also
698 documentation authors write correct and consistent DocBook:
723 application with documentation called
755 documentation. For the basic DocBook structure used to insert
811 Screenshots should be kept in the main documentation
814 documentation. After you use <command>db2html</command> to
818 documentation, or the whole "figs" directory for other
819 documentation) into the newly created HTML directory. Note
838 Documentation authors tend to investigate and test applets and
840 users. Often documentation authors will discover one or
868 version of documentation or programs. Modified documents will
927 multiple developers and documentation authors, users should
945 <!-- ################# The GNOME Documentation System###############
949 <title>The GNOME Documentation System</title>
951 <!-- ####### The GNOME Documentation System | The GNOME Help Browser
960 distinct documentation systems on Linux/Unix systems: man
961 pages, texinfo pages, Linux Documentation Project(LDP)
962 documents, GNOME application documentation, and other GNOME
968 presented. Thus, the documentation that appears in the GHB is
974 <!-- ####### The GNOME Documentation System | The GNOME Help Browser
989 DocBook source for documentation, it will be possible to do more
999 <!-- ####### The GNOME Documentation System | GNOME On-The-Fly
1000 Documentation Generation ####### -->
1005 GNOME uses the documentation presented by all the various
1007 present a complete and customized documentation environment
1009 users system. Some of this documentation, such as the manuals
1015 install that has documentation will show up in the index,
1020 <!-- ####### The GNOME Documentation System | The GNOME Documentation
1024 <title>The GNOME Documentation Components</title>
1078 was the main and only source of documentation. In GNOME 2.0
1105 API documentation is also available for the GNOME libraries. This is
1106 detailed documentation of the code that is used to build GNOME
1116 Some GNOME projects have documentation to maintain
1207 for GDP documentation-specific guidelines.
1216 DocBook itself and GNOME Documentation project will migrate from
1222 advised</emphasis> that the documentation writers conform to XML
1788 unlikely to need these for most documentation. For reference,
1792 terms commonly required in <acronym>GNOME</acronym> documentation,
1885 <!-- ################# GDP Documentation Conventions ############### -->
1888 <title>GDP Documentation Conventions </title>
1890 <!-- ####### GDP Documentation Conventions | All Documentation ####### -->
1893 <title>Conventions for All GDP Documentation</title>
1897 All GNOME documentation should conform to XML syntax
1906 All GNOME documentation should contain the names of both the
1907 application authors and documentation authors, as well as a
1915 <!-- ####### GDP Documentation Conventions | All Documentation ####### -->
1918 <title>Conventions for Application Documentation</title>
1923 Application documentation should identify the version of the
1924 application for which the documentation is written:
1939 documentation should contain a copyright notice, stating the
1941 Documentation License. You could also use some other license
1943 license. If documentation uses some trademarks (such as UNIX,
1952 license (for software, not for documentation), either in the
1960 Application documentation should give an address for
1982 <title>Documentation Availability</title>
1984 Applications and applets should not rely on documentation
1986 other documentation should be packaged with the application or
2040 This section is for developers. Documentation authors
2071 application's name. The application documentation (converted
2098 GNOME to create a menu entry which is tied to the documentation
2103 will be started with the associated HTML documentation.
2116 This section is for developers. Documentation authors
2127 not generally have their own special documentation, the
2128 documentation author(s) do not need to do very much. However,
2130 application correctly opens the help documentation when the
2149 documentation or forums for other GNOME language bindings.
2154 <!-- ################# Packaging Applet Documentation ############### -->
2157 <title>Packaging Applet Documentation</title>
2159 <title>Applet Documentation Files</title>
2161 In GNOME 2.0 each applet will have its own documentation
2172 this document. Applet documentation should be sent to Telsa
2176 the applet documentation if necessary.
2179 Images which are part of the applet documentation should be in
2185 package their documentation with the particular applet
2200 <title>Adding Documentation to an Applet Menu</title>
2204 This section is for developers. Documentation authors
2213 and links them to the documentation.
2293 <!-- ################# Referring to Other GNOME Documentation
2297 <title>Referring to Other GNOME Documentation (coming in
2307 <!-- ################# Basics of Documentation Style ############### -->
2310 <title>Basics of Documentation Style</title>
2314 documentation only when they run into problems, and they'll be
2323 intuitive and clear</emphasis> documentation.
2326 In order to write useful documentation, you'll have to know who
2334 <!-- *********** Basics of Documentation Style: planning -->
2340 reading over any existing documentation. Pay attention to
2353 <!-- ####### Basics of Documentation Style | Balance ####### -->
2400 The GDP strives to have all of its documentation conform
2415 <!-- ####### Basics of Documentation Style | Structure ####### -->
2449 <!-- ####### Basics of Documentation Style | Grammar & Spelling ####### -->
2455 documentation for their software to be error-free. That means
2472 familiarize yourself with documentation, and it certainly
2488 The GDP team is a valuable resource for any documentation
2489 author. GDP members can answer most questions documentation
2492 GDP members by visiting the <citetitle>GDP Documentation
2496 assigning a documentation item to yourself. This table also
2498 each documentation item. The best way to get in touch with
2521 Writing documentation typically involves a certain amount of
2527 is technically correct. The documentation author should also
2529 packages the documentation with the application.
2568 documentation package. This is typically done by passing the
2574 the documentation. The packaging system (tarballs and binary
2576 documentation in the package. Generally, this should be done
2596 Documentation Project Web page</ulink> lists current GDP
2601 type="http">GDP Documentation Status Table</ulink> tracks the
2602 status of all the various documentation components of GNOME.
2632 Documentation Project. You can find out how to subscribe to
2648 documentation issues. The IRC channel is #docs at
2713 Documentation Templates</ulink>.
2727 <!-- This is a GNOME documentation template, designed by the GNOME
2728 Documentation Project Team. Please use it for writing GNOME
2729 documentation, making obvious changes. In particular, all the words
2736 to remove these comments in your final documentation! ;-)
2766 Documentation License</citetitle>, Version 1.1 or any later
2770 Documentation License</citetitle> from the Free Software
2779 names appear in any GNOME documentation, and those trademarks
2780 are made aware to the members of the GNOME Documentation
3378 url="http://developer.gnome.org/projects/gdp">GNOME Documentation
3382 url="http://www.gnome.org/gdp/doctable/">GNOME Documentation Status
3457 Documentation Templates</ulink>. Note that the template
3474 <!-- This is a GNOME documentation template, designed by the GNOME
3475 Documentation Project Team. Please use it for writing GNOME
3476 documentation, making obvious changes. In particular, all the words
3482 Please don't forget to remove these comments in your final documentation,
3511 document under the terms of the <citetitle>GNU Free Documentation
3515 of the <citetitle>GNU Free Documentation License</citetitle> from
3524 GNOME documentation, and those trademarks are made aware to the members
3525 of the GNOME Documentation Project, the names have been printed in caps
3711 url="http://developer.gnome.org/projects/gdp">GNOME Documentation
3715 url="http://www.gnome.org/gdp/doctable/">GNOME Documentation
3787 Documentation Templates</ulink>.
3851 GNOME documentation, and those trademarks are made aware to the members
3852 of the GNOME Documentation
4203 <sect2 id="documentation-feedback">
4207 applications and documentation can be improved. Suggestions for
4210 Suggestions for documentation changes can be emailed directly to
4211 the documentation author (whose email should be included in the
4220 documentation writers, icon design artists, web masters, and
4225 Site</ulink>, documentation writers — <ulink type="http"
4226 url="http://developer.gnome.org/projects/gdp">The GNOME Documentation
4391 <email>HACKER-EMAIL</email>. The documentation for this applet
