How to define anchors (fragment identifiers) in define pages?

[gernot]

Hello all,
I searched for this online and on the forums to no avail. I'd like to use anchors in my define pages (main page, shipping, conditions, contact us, etc.). I create sub-sections and refer to them in a table of contents list, as well as having a return to top link in each sub-section.
I am having trouble with the anchor / fragment identifier. I am open to alternative suggestions too of course.

Ordinarily, an identifier such <h2 id=top> would be referenced like href="#top", and the browser would not need to reload the page. However, since the page URL is actually a query of the form index.php?page=conditions I find I need to define the fragment also as id="index.php?page=conditions#top". I presume this reloads the page.
Furthermore, if I have multiple languages (selected via language icons on the page, such that the URL then includes "&language=en" for example" then I need to include that also into the anchor definition, corresponding to the the language version of the define page.

Is there a different approach I can take for anchors in the define page editor, or to achieve what I would like, namely a quick way for the user to get back to the top of the page (or another section of same page) with a mouse click?

Note: My site is currently available locally only pending regulatory approval, if access is required I can open up preferably only to specific IP addresses.

[dw08gm]

It goes something like this (would say more but running out of time with building about to close)

1. In your \includes\languages\english\html_includes\YourTemplate\define_yourpage.php

<p class="forward"><a href="index.php?main_page=yourpage#top"><?php echo zen_image_button(BUTTON_IMAGE_BACKTOTOP, BUTTON_BACKTOTOP_ALT); ?></a></p>

However zen_image_button code may depend upon what sort of buttons you use.

2. Before the last </div> in your page template file

  <div class="buttonRow forward"><a href="index.php?main_page=yourpage#top"><?php echo zen_image_button(BUTTON_IMAGE_BACKTOTOP, BUTTON_BACKTOTOP_ALT); ?></a></div>

Hope this helps.

[mc12345678]

As a "proof" to another some time ago, I had modified the default define_page_2 text to include a clickable link to return to the "top" of the page. There is no page load that occurs at least not quite like one would think as in a retrieval and download time period, just a movement within the given page.

Anyways, on index.php?main_page=page_2, I added a single link to go to an existing id tag that was located at/near the top of that page.

My added link was:

<a href="<?php echo zen_href_link($_GET['main_page'], zen_get_all_get_params(array('main_page')), $request_type, false); ?>#page">click</a>

This way, I don't have to "know" what page I'm on, the code is flexible to be put on whatever page. Basically if able to get to the page that is displayed, then able to get to the tag that is also on that page. In this case the tag to be reached was id="page" which happened to be on the page but not in the define_page_2 text.

[gernot]

Many thanks for the replies!
dw08gm: great idea, so this gives a "built-in" button on the page, handled by the code rather than being done in the define page editor. I also want links in the content, but this certainly works for me as a starting point.
mc12345678: Very interesting, I did not realize one can put PHP code in the define page editor contents. Definitely missing the big picture here as far as the admin power goes!

I will give both these a try tonight and report back.

PS: I made an error in my initial post, the href only needed the "?...#..." part, not "index.php?...#..."

[mc12345678]

Note that, if you have an html editor such as ckeditor installed and active, you will have to go into source editor mode for the php code to "take". Otherwise, visitors will see the text (php) as typed.

As an additional note, when building internal links, you want to use zen_href_link() type calls as much as possible so that your code is portable to any domain, sub-folder, etc... So long as the store is functioning in whatever environment, the links will be consistent and in the above case, the code can be copied to multiple locations with little effort updating just the id tag for that page.

[gernot]

mc12345678, worked a treat, exactly what it seems I needed! Thank you very much.
I had no idea the define pages was so powerful (extremely mistakenly assumed it was severely sanitized HTML only).
I do have CKEditor installed since 1.5.6b, as a convenience for my partner when she corrects the Japanese texts, but I do my normal editing in the text editor (especially some some contents are initially copied from an existing Wordpress site).
Thanks for pointing out how to get source mode there!
I'll have to study at bit more on how to use the zen_href_link() function, it is going to become extremely used on my pages!

[dw08gm]

Thanks MC# I will certainly consider your code.

For my (old) code to work, you may need to add item 3:

1. In your \includes\languages\english\html_includes\YourTemplate\define_YourPage.php

<p class="forward"><a href="index.php?main_page=yourpage#top"><?php echo zen_image_button(BUTTON_IMAGE_BACKTOTOP, BUTTON_BACKTOTOP_ALT); ?></a></p>

However if you prefer to use text instead of a button, you could use this:

<p class="forward"><a href="index.php?main_page=yourpage#top"><b>Back to Top</b></a></p>

2. In your \includes\templates\YourTemplate\templates\tpl_YourPage_default.php, before the last </div>

  <div class="buttonRow forward"><a href="index.php?main_page=yourpage#top"><?php echo zen_image_button(BUTTON_IMAGE_BACKTOTOP, BUTTON_BACKTOTOP_ALT); ?></a></div>

3. In your \includes\templates\YourTemplate\common\tpl_header.php, add the following immediately after <div id="headerWrapper"> (or whatever div contains your header file)

<!-- bof Back to top - see tpl_YourPage_default.php -->
    <a name="top"></a>
<!-- eof Back to top -->

Cheers


ps there is also a Back to Top plugin (from 2012) and support thread available here:

https://www.zen-cart.com/downloads.php?do=file&id=1574

https://www.zen-cart.com/showthread....Support-Thread

[gernot]

Many thanks for the additional information. I haven't edited the template files yet, although I did check them to see which "id"s were available to reference in some pages.
After some reading of the code, I could figure out how to link to other pages as well, with or without referencing a fragment in that page. Really great!

<a href="<?php echo zen_href_link($page='contact_us', zen_get_all_get_params(array('main_page')), $request_type, false); ?>">Contact</a>

[mc12345678]

Many thanks for the additional information. I haven't edited the template files yet, although I did check them to see which "id"s were available to reference in some pages.
After some reading of the code, I could figure out how to link to other pages as well, with or without referencing a fragment in that page. Really great!

<a href="<?php echo zen_href_link($page='contact_us', zen_get_all_get_params(array('main_page')), $request_type, false); ?>">Contact</a>

Unless there is a need to assign/create the variable $page in the content of the page where that code is located, then it could be removed to look like this:

<a href="<?php echo zen_href_link('contact_us', zen_get_all_get_params(array('main_page')), $request_type, false); ?>">Contact</a>

That said though, there is a constant that already defines the main_page value for you, again allowing the code to remain "generic". FILENAME_CONTACT_US

So this could be written:

<a href="<?php echo zen_href_link(FILENAME_CONTACT_US, zen_get_all_get_params(array('main_page')), $request_type, false); ?>">Contact</a>

Which should look relatively familiar if you review template files where the contact us link is offered.

[gernot]

Thank you for that advice, I changed all the "$page->..." to FILENAME... as appropriate.
For define_<pagename>.php the constants for a given <pagename> seem to be:
1. contact_us: FILENAME_CONTACT_US
2. privacy: FILENAME_PRIVACY
3. conditions: FILENAME_CONDITIONS
4. shippinginfo: FILENAME_SHIPPING (not SHIPPINGINFO)

Between mc12345678 and dw08gm I am getting the feel for how to manage the backend and GUI sides together, after having started assuming they were separated strictly. Nice!!

Aside:
1. Not sure where the '<pagename>' variables come from (which I could use instead of FILENAME...), are these defined globally?
2. define pages page_{2,3,4} exist also, but I cannot find where their links are in Zen Cart on the main page (I will have a look in the code at home tonight). So I disabled them for now.