3,146
edits
Changes
→Usage
{{Third-party addon}}
[[File:Note_Cleanup_ToolNoteCleanupTool-example-60-en.png|thumb|right|450px|Note Cleanup Tool - example window]]
==What is it For?==
The {{man label|Note Cleanup Tool}} searches your database for [[Gramps_{{man version}}_Wiki_Manual_-_Categories#Notes_Category|notes ]] that contain "HTML tags" and cleans it up. "HTML tags" have meaning to web browsers and other applications, but look like garbage to most people.
The cleanup consists of converting the "HTML tags" to what the Gramps folks call "Styled text" which displays nicely within Gramps and in the various reports that Gramps can generate.
The tool also searches for "links" to web sites and sets them to "Styled Text Links", so that they work properly in reports such as the Gramps ''Narrative Web Site''report.
'''Examples of notes that needs cleaning'''
The first note contains some text with ''italics'' as well as a link to a web site. The cleaned note is shown in the lower right pane of the image on the cleanup tool above.
The second Untidy note is much simpler, it only contains a bit of ''italics'' text; the tool will remove the <nowiki><i> and </i></nowiki> and convert the text in between to ''italics''. ===Where do the "dirtyUntidy" notes come from?===
The author of this addon has a lot of data that was imported from <code>ancestry.com</code> via GEDCOM. It seems that the <code>ancestry.com</code> software doesn't always do a great job of converting their web pages to notes for GEDCOM export.
The popular '''Family Tree Maker''' software, in conjunction with <code>ancestry.com</code> also seems to have a lot of these "dirtyUntidy" notes in their GEDCOM exports.
There are probably other ways that dirty Untidy notes get into our data, but this tool can help clean it up.
{{-}}
==Usage==
* Select Menu {{man menu|Tools -> Utilities -> Note Cleanup...}}
[[File:NoteCleanupTool-default-pop-up-60-en.png|thumb|center|650px|Note Cleanup Tool - showing initial pop-up and screen section information example]]
* At this point the tool window with three main panes and some buttons should be visible.
* {{man menu|Optional:''The following is best performed on a test database, since it actually adds some test notes to the active database.''}} If you want to perform a quick test to see what this tool does, you can press the {{man button|Generate Test Notes}} button, but not on your main database!But if you do accidental do this the test notes are in the range N99996-N99999 so you can delete them later.* Otherwise you can perform a scan of your data existing ''notes'' by pressing the {{man button|Search}} buttonto search for Untidy notes. This does not make '''any''' changes to your data, only performs the search and fills the panes if any dirty Untidy notes are found.** The left pane will contain lists of the results of the searchnotes {{man button|Search}}. If nothing appears here, then none of your data is dirtyUntidy, or any dirty Untidy notes already have been edited and styled. There may be up to three lists in the left pane. A list will only be present if there are notes found in that category.
*** The {{man label|Cleaned Notes}} list tab contains notes that have been edited in some way, and may have ''styles'' applied. This includes converting any web links to a ''styled'' link.
*** The {{man label|Links Only}} list tab contains notes that have not been edited (no textual changes at all) but have had links converted to ''styled''.
*** The {{man label|Issues}} list tab contains notes that ''may'' have been edited in some way, but contain ''HTML tags'' that the tool does not recognize.
** The top right pane will show the original unedited text of a note that is selected in the left pane. This cannot be changed.
** The lower right pane will show the proposed changes to the note. If the user wants to make additional changes, they can be made directly in the pane. The editing toolbar directly above the lower left pane can be used to make or correct style changes as well. This toolbar is an abbreviated version of the normal [[Gramps_{{man version}}_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_2#Note_editor_dialog|Gramps Note editor toolbar]] and each icon works the same. Any changes made here are preserved within the tool, but will not affect your data until the {{man button|Save All}} changes button is pressed (see next below).* When you have reviewed all the changes made, either by the tool, or manually, you can save your work using the {{man button|Save All}} changes button. Your data is '''not''' changed until you press this button, but when you do, all the changes are committed to your database.
* If you do not want any changes to be made to your data, or you are done with the tool, you can simply press the {{man button|Close}} button.
* If you want a record of notes that have been found in the search, you can use the {{man button|Export}} button to save a listing to a text file.