Leading or trailing whitespace in links
---------------------------------------
Key: DOCU-237
URL: http://jira.magnolia-cms.com/browse/DOCU-237
Project: Documentation
Issue Type: Task
Security Level: Public
Components: content
Reporter: Antti Hietala
Assignee: Ruth Stocks
Attachments: linkchecker-out.html
I ran a [LinkChecker|http://linkchecker.sourceforge.net/] tool on the
documentation site. It found some broken links and I was able to fix them. It
also found a bunch of other issues that add noise to the report. One of these
is leading and trailing spaces in URLs, which means the wiki link tag has an
extra space which ends up in the resulting HTML. Browsers are smart enough to
handle this so it's no big deal. But I want to weed them out.
Example with space at the beginning or end (bad):
{code}[Commenting module| /modules/commenting]
[Commenting module|/modules/commenting ]{code}
Example with no spaces (good):
{code}[Commenting module|/modules/commenting]{code}
To do: Find the attached LinkChecker report or download the LinkChecker tool
and run it against documentation.magnolia-cms.com. Fix all occurrences of
"Leading or trailing whitespace in URL" by editing the erroring page and
removing the spaces. Then activate the page with comment "Leading or trailing
whitespace".
The spaces are easy to find in the wiki markup by searching for {{'| '}} (pipe
character followed by whitespace) or {{' ]'}} (whitespace before square
bracket).
You will also find the following unnecessary markup in internal links. Fix them
too.
Incorrect:
{code:none}[Commenting module|/modules/commenting.html] Suffix not needed.
System adds it automatically.
[Commenting module|/modules/commenting.html#Video]
[Commenting
module|http://documentation.magnolia-cms.com/modules/commenting.html] Relative
URL is enough.{code}
Correct:
{code}[Commenting module|/modules/commenting]
[Commenting module|/modules/commenting#Video]{code}
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://jira.magnolia-cms.com/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
----------------------------------------------------------------
For list details, see: http://www.magnolia-cms.com/community/mailing-lists.html
Alternatively, use our forums: http://forum.magnolia-cms.com/
To unsubscribe, E-mail to: <dev-list-unsubscr...@magnolia-cms.com>
----------------------------------------------------------------
