Closed (fixed)
Project:
User Guide
Component:
User Guide content
Priority:
Normal
Category:
Task
Assigned:
Reporter:
Created:
29 Jun 2015 at 20:07 UTC
Updated:
17 Aug 2015 at 22:04 UTC
Jump to comment: Most recent, Most recent file
Page Information
Title: Creating a menu link when editing a content item
Section: Menu and Navigation Section
File name: menu-link-from-content.txt
Covers: Creating a menu link when editing a content item
Attribution
Please provide the needed format, thanks!
Attribution
<<user-permissions>>::
Adapted by https://www.drupal.org/u/batigolix[Boris Doesborg] from
https://www.drupal.org/documentation/modules/menu["Working with Menus"],
copyright 2000-2015 by the individual contributors to the
https://www.drupal.org/documentation[Drupal Community Documentation]
| Comment | File | Size | Author |
|---|---|---|---|
| #10 | menu-link-from-content.txt | 2.25 KB | batigolix |
| #7 | menu-link-from-content-result.png | 31.27 KB | batigolix |
| #7 | menu-link-from-content.txt | 2.29 KB | batigolix |
| #5 | menu-link-from-content.txt | 1.92 KB | batigolix |
| #3 | menu-link-from-content.png | 49.75 KB | batigolix |
Comments
Comment #1
jhodgdonBoris: for the attribution can you provide exactly what we'd need to paste into the attributions.txt file? That makes it really easy... :) There are instructions in the guidelines and they are linked from the User guide project home page.
Come to think of it I will add this to the Issue Template.
Comment #2
jhodgdonWe decided to use separate issues for each phase of writing/editing.
Comment #3
batigolixHere is a first draft.
I would need to link to topics that do not exist yet. Such as for example managing menus from the admin UI. How would we deal with that? For the moment I added these as todo in the source.
Comment #4
jhodgdonYes, adding as @todo is the right thing to do at this stage.
Anyway, thanks! This is looking pretty good. A few things to fix before the initial commit:
a) The "Steps" heading seems to be missing from the template.
b) Make sure you have put "@todo" in everywhere there is a To Do item.
c) Make sure that every ID mentioned in a <<>> *already exists* (otherwise, use @todo so we can add it later). For instance, <> does not exist.
d) When telling people how to fill in a form, we'd actually like to have a table of Field vs. Value along with the screen shot, and the screen shot needs an image include AsciiDoc macro. See:
https://userguide-drupal.redesign.devdrupal.org/guidelines/good-writing.... (section on images)
https://userguide-drupal.redesign.devdrupal.org/guidelines/formatting.html (section on images)
Comment #5
batigolixThat table should be an asciidoc table?
Do we still want to spell out the same fields in the steps or are they removed from the steps and just mentioned in the table?
Comment #6
jhodgdonI think we could have one step that says "Fill in the form with the following values:" and then an AsciiDoc table? Making it up as we go...
Comment #7
batigolixOk, we can experiment until it looks OK.
Please check the new attachment.
Comment #8
batigolixComment #9
jhodgdonLooking pretty good! I think the table structure seems fine.
So, reading this over...
a) I don't understand how the Prerequisite Knowledge section is "knowledge". It seems like it is talking about things you want to have on your site (a menu and some links). Maybe in this section the knowledge someone needs to know is what a menu is, and how to edit a content item? Both of those we have topics for.
b) We've dropped the menu-create topic.
c) You can put in actual links now to the topics in the site prerequisites and related tasks. The files exist even if the topics haven't yet been written.
d) Check the new topic tracking spreadsheet... now says this should cover:
Site prereq: Have created an About page. Edit the About page and add it to Main Navigation in the menu section: Prereq: concept paths, aliases, urls
So we want to be a bit more specific in the topic here, using the About page as an example. So for instance the first step might be:
Find the page you want to add to the navigation; for example, your About page.
And the example values would be related to this page.
Comment #10
batigolixThanks for the review, Jennifer! Here's a new attempt.
Regarding your feedback:
>> a) I don't understand how the Prerequisite Knowledge section is "knowledge". It seems like it is talking about things you want to have on your site (a menu and some links). Maybe in this section the knowledge someone needs to know is what a menu is, and how to edit a content item? Both of those we have topics for.
Should be better now
>> b) We've dropped the menu-create topic.
Removed it
>> c) You can put in actual links now to the topics in the site prerequisites and related tasks. The files exist even if the topics haven't yet been written.
Done
>> d) Check the new topic tracking spreadsheet... now says this should cover:
>> Site prereq: Have created an About page. Edit the About page and add it to Main Navigation in the menu section: Prereq: concept paths, aliases, urls
I dont see any topics regarding paths, aliases, etc.
>> So we want to be a bit more specific in the topic here, using the About page as an example. So for instance the first step might be:
>> Find the page you want to add to the navigation; for example, your About page.
>> And the example values would be related to this page.
Done
I had problems linking to menu-reorder (see error below), so i commented it for the moment and added a @todo note:
>> /Users/boris/Sites/d7-git/sites/all/modules/user_guide/scripts/../output/ebooks/en/guide.docbook:1891: element xref: validity error : IDREF attribute linkend references an unknown ID "menu-reorder"
Comment #11
jhodgdonDoh! The menu-reorder.txt file was inadvertently not added to the guide.txt file. Fixed that.
Topic looks good! Adding it to the guide. Thanks!
Comment #12
jhodgdonhttps://userguide-drupal.redesign.devdrupal.org/d8guide/en/menu-link-fro...
it is up!
Comment #13
jhodgdonNote: we'll redo the screen shots so they look more like the scenario but that is later. See #2539918: Automate creation of screenshots. The text is fine as it is and I didn't even find any guidelines problems so this was good! Thanks again!