By default, Bugzilla does not search the list of RESOLVED bugs.
You can force it to do so by putting the upper-case word ALL in front of your search query, e.g.: ALL tdelibs
We recommend searching for bugs this way, as you may discover that your bug has already been resolved and fixed in a later release.

Bug 694

Summary:	Help/Handbook files still reference KDE
Product:	TDE	Reporter:	Darrell <darrella>
Component:	system	Assignee:	Timothy Pearson <kb9vqf>
Status:	RESOLVED FIXED
Severity:	minor	CC:	bugwatch, darrella
Priority:	P5
Version:	R14.0.0 [Trinity]
Hardware:	Other
OS:	All
Compiler Version:		TDE Version String:
Application Version:		Application Name:
Attachments:	Correct some entities used in the DocBook files and add two new entities Updated image of the "T-icon" used in help files Patch to update help files from KDE3 to TDE Patch to update help files and user guides from KDE3 to TDE Patch to fix the creation of the checkXML script Updated image of the default Trinity desktop for the user guide Updated image of Amarok icon PNG image used in user guide. Updated PNG image of typical window in user guide Updated PNG image of the title bar menu in user guide Updated patch to update help files from KDE3 to TDE Updated patch to update help files and user guides from KDE3 to TDE Patch to fix amarok doctype declaration for future maintenance of handbook files Patch to fix k3b doctype declaration for future maintenance of handbook files Patch to fix koffice doctype declaration for future maintenance of handbook files Patch to fix tdepim doctype declaration for future maintenance of handbook files Patch to fix tdeutils doctype declaration for future maintenance of handbook files Patch to fix tdegames doctype declaration for future maintenance of handbook files Patch to fix libraries doctype declaration for future maintenance of handbook files Patch to fix applications doctype declaration for future maintenance of handbook files Updated patch to update help files and user guides from KDE3 to TDE Updated PNG image of default splash for the user guide New image of graphical login for user guide Updated khelpcenter logo image

Description Darrell 2011-11-27 12:36:56 CST

For example: KControl

Much of the KDE references can be fixed by replacing the docbook variable kde (&kde;) with tde (&tde;).

At the bottom of every handbook page is a link to contact the KDE doc team. Those links and email address should be updated to TDE locations.

Email addresses for the developers point to addresses at kde.org. Although the original authors need to be credited, the email addresses should be deleted.

Web pages for the home page of each app points to the KDE web site.

Comment 1 Darrell 2012-01-30 16:42:21 CST

Tim,

Do you have plan for updating the handbook help files?

I am studying and learning how this process functions. I am writing a draft for the wiki as well, which will include using Quanta Plus. Understanding this entire process will be my primary Trinity focus for the upcoming weeks.

The original reference documents used by the KDE documentation writers --- found around the web --- leaves much to be desired regarding technical information. Those three documents have not been updated in 7 years and even at the new KDE4 web site, those three documents remain unchanged. That is, slowly I am discovering tribal knowledge that never was documented properly. I want to update those three documents as well. Hence, my effort to write a wiki draft that will serve as a connector of sorts to those three documents. In the end, I will have those three documents updated for Trinity and along with the wiki, a significant part of the mystery about these help files will be gone.

Slowly I am understanding how this DocBook process operates. For example, changing all references in the handbook help files of "KDE" to "TDE" is straightforward. Only one addition is needed in the entity DTD, but all handbook help files need a big collective one-time patch to update the entity usage within each help file. I should be able to provide that patch.

Yet much remains to update the help files. I'd like to see an overall plan or at least a simple punch list as to what we want to change. I will test any patches I create so the final merge to GIT is comprehensive and clean for R14.

Comment 2 Darrell 2012-01-30 20:49:05 CST

Created attachment 304 [details]
Correct some entities used in the DocBook files and add two new entities

This patch corrects some entities used in the handbook help files.

The patch adds two new entities:

<!ENTITY tde "<acronym>TDE</acronym>">
<!ENTITY TQt "<trademark>TQt</trademark>">

When this patch is applied we can start updating the *.docbook source files. One of the first significant updates will be to replace *most* occurrences of the &kde; entity with the new &tde; entity. :)

Comment 3 Darrell 2012-01-31 15:47:47 CST

Created attachment 308 [details]
Updated image of the "T-icon" used in help files

Many handbook help files refer to the "K-icon", which is now a "T-icon." The updated help files will refer to the "T-icon."

Those help files also use an image, which needs updating.

The specific image used is tdelibs/doc/common/kdemenu.png.

Attached is an updated image of kdemenu.png.

Comment 4 Darrell 2012-01-31 21:45:49 CST

Created attachment 310 [details]
Patch to update help files from KDE3 to TDE

Comment 5 Darrell 2012-01-31 21:46:35 CST

Created attachment 311 [details]
Patch to update help files and user guides from KDE3 to TDE

Comment 6 Darrell 2012-01-31 21:47:52 CST

This is just the beginning but these two patches include necessary fundamental changes with tdelibs and tdebase to update the Trinity help files and user guides.

These patches do much toward updating the KDE3 user guide into a TDE user guide. Much remains to be done, but these first patches change the overall context to TDE.

I successfully built tdelibs and tdebase with the patches with no errors. I have browsed the user guide as well. (Looks pretty nice!)

As soon as these two patches and the graphics image are merged, team members and users could start reviewing the user guide text to provide meaningful feedback.

As soon as I cobble together a script to transform all of the related DocBook files, we could generate a daily/nightly build of the user guide and post to the web site or wiki for reviews and feedback.

Comment 7 Darrell 2012-02-01 13:29:25 CST

Created attachment 312 [details]
Patch to fix the creation of the checkXML script

The checkXML.cmake file is incorrect and creates a file path of @CMAKE_INSTALL_PREFIX@/@BIN_INSTALL_DIR@ rather than just @BIN_INSTALL_DIR@. Refer to the original checkXML.in to see the correct path. This patch updates checkXML.cmake to the correct file path.

Comment 8 Darrell 2012-02-01 20:40:47 CST

Created attachment 314 [details]
Updated image of the default Trinity desktop for the user guide

This updated image reflects a default Trinity desktop rather than a default KDE3 desktop.

In GIT, this updated image replaces tdebase/doc/userguide/desktop.png.

Comment 9 Darrell 2012-02-04 01:52:17 CST

Warning:

Some of the necessary changes in the entities files requires updating the help file document type declarations. Without updating the declarations, the packages will fail to build. As I continue updating files I'll post patches. I'm just adding a warning here so others will know why the builds fail. The build failures will occur only when the entities patch is merged. The correct declaration:

"-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd"

Comment 10 Darrell 2012-02-08 16:04:15 CST

Comment on attachment 308 [details]
Updated image of the "T-icon" used in help files

Regarding attachment 308 [details], kmenu.png, to update GIT, copy and overwrite the kmenu.png image to tdelibs/doc/common/kmenu.png.

Comment 11 Darrell 2012-02-08 16:04:33 CST

Created attachment 345 [details]
Updated image of Amarok icon PNG image used in user guide.

The amarok-icon.png image currently in the user guide source tree is obsolete.

The updated image is copied from applications/amarok/amarok/src/hi32-app-amarok.png.

For updating GIT, copy and overwrite this new image to main/tdebase/doc/userguide/amarok-icon.png.

Comment 12 Darrell 2012-02-08 16:06:20 CST

Comment on attachment 314 [details]
Updated image of the default Trinity desktop for the user guide

Regarding attachment 314 [details], desktop.png, to update GIT, copy and overwrite the desktop.png image to main/tdebase/doc/userguide/desktop.png.

Comment 13 Darrell 2012-02-08 20:45:20 CST

Created attachment 346 [details]
Updated PNG image of typical window in user guide

To update GIT: copy the file and overwrite tdebase/doc/userguide/a-window.png.

Comment 14 Darrell 2012-02-08 21:14:54 CST

Created attachment 347 [details]
Updated PNG image of the title bar menu in user guide

To update GIT: copy the file and overwrite tdebase/doc/userguide/titlebar-menu.png.

Comment 15 Darrell 2012-02-16 19:36:31 CST

Created attachment 352 [details]
Updated patch to update help files from KDE3 to TDE

Comment 16 Darrell 2012-02-16 19:37:33 CST

Created attachment 353 [details]
Updated patch to update help files and user guides from KDE3 to TDE

Comment 17 Darrell 2012-02-17 14:28:18 CST

Created attachment 354 [details]
Patch to fix amarok doctype declaration for future maintenance of handbook files

Comment 18 Darrell 2012-02-17 14:28:42 CST

Created attachment 355 [details]
Patch to fix k3b doctype declaration for future maintenance of handbook files

Comment 19 Darrell 2012-02-17 14:29:51 CST

Created attachment 356 [details]
Patch to fix koffice doctype declaration for future maintenance of handbook files

Comment 20 Darrell 2012-02-17 14:30:19 CST

Created attachment 357 [details]
Patch to fix tdepim doctype declaration for future maintenance of handbook files

Comment 21 Darrell 2012-02-17 14:30:45 CST

Created attachment 358 [details]
Patch to fix tdeutils doctype declaration for future maintenance of handbook files

Comment 22 Darrell 2012-02-17 14:31:14 CST

Created attachment 359 [details]
Patch to fix tdegames doctype declaration for future maintenance of handbook files

Comment 23 Darrell 2012-02-17 17:52:42 CST

Created attachment 361 [details]
Patch to fix libraries doctype declaration for future maintenance of handbook files

Comment 24 Darrell 2012-02-17 17:53:21 CST

Created attachment 362 [details]
Patch to fix applications doctype declaration for future maintenance of handbook files

Comment 25 Darrell 2012-02-18 00:17:01 CST

Created attachment 390 [details]
Updated patch to update help files and user guides from KDE3 to TDE

Comment 26 Darrell 2012-02-18 14:47:10 CST

Created attachment 394 [details]
Updated PNG image of default splash for the user guide

Comment 27 Darrell 2012-02-18 15:08:24 CST

Created attachment 396 [details]
New image of graphical login for user guide

Copy image to main/tdebase/doc/userguide/.

Comment 28 Darrell 2012-02-18 20:59:55 CST

Created attachment 397 [details]
Updated khelpcenter logo image

Copy the image to tdebase/doc/khelpcenter/kdelogo2.png.

Comment 29 Darrell 2012-02-23 08:11:58 CST

kemu.png updated in GIT hash 0cbd99316a10fc2537140f71989d383404727255.

kdelogo2.png image updated in GIT hash 3cf6a5dbc9032f491591680ea0abf52512aa22ac.

desktop.png image updated in GIT hash fc9bd1925e84dec3efe404b152bada86e7404875.

amarok-icon.png image updated in GIT hash f902da0892b113333c4d932224f552385173dcd0.

a-window.png updated in GIT hash 785917ca148daac9007fd778eb60d3a4a0b77074.

titlebar-menu.png image updated in GIT hash 4c66dc7b29193170d1875c2c11914ddea39c8c3e.

splash-screen.png image upated in de750daeeda4ecd6f3739490aac17a024aafa73d.

tdm.png image updated in GIT hash ca1a4375014b6f78a06c74169a1285abbcbcd819.

checkXML script updated in GIT hash cce6e81f38f0d6eb0a45fe5e5bf1d5a44b184e2a.

Comment 30 Darrell 2012-02-25 00:37:08 CST

Various entities and text strings in tdelibs updated in GIT hash 324c251aafe36a1c94410bde2f4f09ad07bd33be.
Various entities and text strings in tdebase updated in GIT hash 618e7f195065cdc19b86f4c1ffe6b94d2b6a64ae.
Various entities and text strings in tdeutils updated in GIT hash 939c09368f6b557eb9add27e198c5865acb97f3c.
Various entities and text strings in tdegames updated in GIT hash f26b081c79f8c6a4b5857cd9bb7475282d199345.
Various entities and text strings in tdepim updated in GIT hash f18abe6c2d02538a4f49acfa12d7dc371aa9bd76.
Various entities and text strings in amarok updated in GIT hash 46b7d81758cd210ea81052090ae89be0d68bbbcf.
Various entities and text strings in k3b updated in GIT hash 51f3922353862c4aac60cd272a9579116db230c6.
Various entities and text strings in gwenview updated in GIT hash 42dcc1e5973fb0349f0dd96a99d24331abea0e45.
Various entities and text strings in k9copy updated in GIT hash dbe9cca0a5335d713904823d5c1488f2ac5ebcfc.
Various entities and text strings in kaffeine updated in GIT hash c19952fa9c58be8f1559dc501390115812fb7d11.
Various entities and text strings in ksystemlog updated in GIT hash 6d9435b04bbdbc736afedd0a4f4c0f6c729332f4.
Various entities and text strings in koffice updated in GIT hash d996d88fdc80c76ac445b7a8bc66171b9a4a3a0e.

Comment 31 Darrell 2012-02-25 00:51:02 CST

All of the attached patches have been merged to GIT.

Much work remains to update all help files. For now I'd like to keep this bug report open but future updates will be directly through GIT rather than through this bug report.

Comment 32 Darrell 2012-10-16 19:46:14 CDT

With the patches now working in R14 for some time, and being backported to 3.5.13.1 without issue, I'm finally closing this bug report as resolved.

Thanks to everybody who helped!