SiteURL - Documentation




	Home




	Download




	Screenshots




	Install




	Documentation




	Version




	Licensing




	Author

The SiteURL current version (1.0.b.0) does not contain online help files, though it is planned for future version. For the time the online help is not available, you will find below a short documentation about SiteURL.

Warning:

the URLs modifications proceeded by SiteURL are not undoable (though some URLs modifications are "togglable"). So it is recommended to use a copy of your original web documents when you modify your URLs with SiteURL.

Overview

After SiteURL is launched, the first thing to do is to open the web documents that contain the URLs you want to view/edit. Click the Add button to open one or more web document(s), or click the Add Folder button to open all the web documents contained in a folder (and its eventual subfolders).

Note:
By default, SiteURL considers as web documents the following file types:
*.htm, *.html, *.xht, *.xhtml, *.xml, *.css, *.xsl, *.asp, *.cfm, *.cfml, *.js, *.jsp, *.php, *.php3, *.php4, *.py.
This default web documents extensions list can be modified in SiteURL's preferences (menu Options > Preferences). You can open in SiteURL every kind of text document that may contains an (X)HTML tag with an hypertext link as attribute value.

Web documents, once opened, are displayed in the top Web Documents list of the main window. All the distincts URLs these web documents contain are displayed in the bottom Found URLs list of the main window.

To add new web documents to the top list, click the Add or Add Folder button. Each time you add web documents to the top list, all the URLs these documents contain are also added to the bottom list.

To remove web documents from the list, select them and click the Close button. Each time you remove web documents from the top list, all the URLs these documents contain are also removed from the bottom list.

Note:
By default, SiteURL reject to open "read only" web documents. If you want to open such documents (from a CD-Rom for instance), you have to toggle SiteURL in read only mode (check main window's Read only box or select menu Options > Read only Mode). Then the URLs contained in read only web documents can be displayed, but of course cannot be edited.

Web documents list

For each opened web document, the Web documents list displays its:

name,
path,
type,
last modification date,
number of URL occurences contained.

You can sort the Web documents list according to each of these columns by clicking on the corresponding column's title. Click a second time to sort the list in descending order.

To obtain more informations about a web document (like the list of URLs contained in this document), select it in the Web documents list and click on the Infos button. The Web Document Info dialog displays only one document at a time, but if you have selected several documents, the navigation buttons (blue arrows buttons) lets you move from one document to another.

You can adjust the horizontal splitter to give more or less room to the Web documents list compared to the Found URLs list: click and drag the splitter to your preferred position.

Note for Windows XP users:
Unfortunately, the horizontal splitter between Web documents list and Found URLs list is not visible when SiteURL runs under Windows XP. But it still works: position your mouse cursor about 10 pixels below the bottom of the Web documents list, and when the cursor's shape change to an

, then you can click and drag the invisible splitter.

Found URLs list

For each distinct URL referenced in your web documents, the Found URLs list displays its:

name (URL),
(X)HTML source element & attribute (like <A HREF> or <IMG SRC>),
adressing type (see table below),
target document type,
number of occurences found in all opened web documents.

You can sort the Found URLs list according to each of these columns by clicking on the corresponding column's title. Click a second time to sort the list in descending order.

Each distinct URL is also represented by an icon corresponding to its adressing type:

Icon	Adressing type	Example
	Relative adressing	img/foo.png
	Absolute adressing	http://www.mysite.org/img/foo.png
	Invalid adressing ⁽¹⁾	img/foo<.png
	Script ⁽²⁾	javascript:history.go(-1)
	Fragment identifier ⁽³⁾

(1) An URL is declared invalid if it contains at least one forbidden character.
(2) Scripts are not URLs strictly speaking, but are nevertheless editable under SiteURL.
(3) Fragment identifiers are not URLs strictly speaking. They are taken into account in SiteURL because they are often used in association with actual URLs (for instance, fragment identifier "here" with URL "foo.htm#here")

Click on the Find button to search for URLs into the Found URLs list according to different crireria: URL string content, (X)HTML element & attribute, adressing type, and target document type. The search result is displayed in the Found URLs list: every URL matching your criteria becomes selected.

Click on the Toggle button to invert Found URLs list current selection: every selected URL becomes unselected, and vice versa.

To edit one or more URLs, select them in the Found URLs list and click on the Edit button. SiteURL will then display the Edit URLs dialog.

Note:
The Edit button remains inactive (grayed) if no URL is selected in the Found URLs list or if the Read only box is checked.

To obtain more informations about an URL (like the list of web documents containing this URL), select it in the Found URLs list and click on the Infos button. The URL Info dialog displays only one URL at a time, but if you have selected several URLs, the navigation buttons (blue arrows buttons) lets you move from one URL to another.

Edit URLs dialog

The top area of the Edit URLs dialog is dedicated to the URL editor. There are four distinct URL editors (though only one can be used at a time):

Rename: to rename one by one the selected URLs.
Insert/Delete: to insert or delete characters into selected URLs.
Find/Replace: to find and replace characters into selected URLs.
Upper/Lower: to transform selected URLs string contents into lowercase or uppercase.

To display one of these URL editors, click on the corresponding tab.

The bottom area of the Edit URLs dialog is dedicated to the Preview list. This list lets you preview the changes before they apply: the left column displays the original URL, and the right column displays the URL as it will be if you validate the dialog with the current URL editor settings.

The Preview list is automatically updated when you modify the current URL editor settings. This real-time updating is time-consuming and could affect interface responsiveness if you have many URLs to edit. In this case, click on the Preview blue arrow button to mask the Preview list. To display it again, click a second time on the Preview button.

When you validate the Edit URLs dialog (OK button), SiteURL displays a last confirmation dialog before saving the web documents. The Confirm Edit dialog shows the number of URLs to edit, and the list of web documents (containing these URLs) which have to be updated/saved. Only the URLs that were actually modified by the current editor are taken into account to determine which web documents should be saved (the URL displayed as [unchanged] or [empty] in the Preview list will not be updated).

Note:
The Confirm Edit dialog can be bypassed if you uncheck the Confirm web documents saving box in the Preferences dialog (menu Options > Preferences).

How SiteURL saves web documents

If SiteURLs encounters at least one error during web documents saving, the whole editing process is aborted, and no URL nor web document is modified (a bit like in a database transaction).

The source web documents are not directly overwrote at their original position, but saved in a distinct copy (original file name prefixed by the string "s~u~"). When all documents have been processed (and if everything went right) the copies are then renamed to their original names. This "safe-save" technic ensure to always keep valid documents (updated or not) when a serious error (like power failure) occurs during a saving process.

SiteURL's web document modifications apply only to the parts of the document that contain URLs affected by the current editor. Each character from your source documents that don't belong to an affected URL will always be left unchanged.

How SiteURL extracts URLs from web documents

SiteURL is in no way an (X)HTML code validator. In fact, it is very permissive with the (X)HTML syntax, and considers as web document every text file that contains at least one (X)HTML tag with one URL attribute value.

SiteURL extracts only URLs that occur in the referenced (X)HTML elements/attributes couples values (see table below). Every URL that occurs in another location (and notably every URL that occurs in the text outside the (X)HTML tags) will be ignored.
Example: if your web document contains the string:

SiteURL will extract the URL "http://www.foo.org/" (value of the href attribute), but will not extract the text "www.foo.org".

SiteURL considers as URLs the values of the following (X)HTML elements/attributes couples:

Element	Attribute
a	href
a	name
applet	codebase
area	href
base	href
blockquote	cite
body	background
del	cite
form	action
frame	longdesc
frame	src
head	profile
iframe	longdesc
iframe	src
img	longdesc
	src
	usemap

Element	Attribute
input	src
input	usemap
ins	cite
link	href
map	name
object	archive
	classid
	codebase
	data
	usemap
q	cite
script	src
table	background
td	background
th	background
tr	background

Note:
When SiteURL opens a cascading style sheet document (CSS), it considers as URL every string comprised between "url(" and ")".

Doc.

Hosted by SourceForge.net