Cleanup add content type text [#523256]

This is to cleanup admin/build/types/add.

Removed :

"The human-readable name of this content type. This text will be displayed as part of the list on the add new content page. It is recommended that this name begin with a capital letter and contain only letters, numbers, and spaces. This name must be unique."

First of all, human-readable name? what!? I am not sure if it makes sense to say where this content type will be listed, its unlikely they know this page very well + it might change in Drupal 7.
The recommendations? Is it really bad they don't start with capitals? also what is the use case for someone not entering letters, numbers and spaces?

The only thing worth keeping to me felt to be "This name must be unique" - but then I thought about the actual use case of this, you need to have quite an amount of content types to consider using the same name twice. Also since we don't have validation, you won't really find out until you click submit.

Removed

"A brief description of this content type. This text will be displayed as part of the list on the add new content page."

As noted above, it is unlikely that the user can recall what the list on the add new content page looks like, we should fix this with having an edit link on that screen - instead of trying to explain it here.

Changed

"To omit the body field for this content type, remove any text and leave this field blank."

Omit seems rather cryptic, tried something more human-readable :')

"Leave blank to remove the body field"

Changed

"Preview post"

"Preview post before submitting"

so I could remove "Should users preview posts before submitting?".

Sum-up
I changed and removed some stuff, this issue is connected to http://drupal.org/node/523244

Comment	File	Size	Author
#12	content_type_add_before.png	102.69 KB	arianek
#12	content_type_add_after.png	92.53 KB	arianek
#12	content_type_add_1.patch	3.34 KB	arianek
#12
#4	content_type_add_before.png	140.46 KB	arianek
#4	content_type_add_after.png	161.68 KB	arianek
#2	content_type_add.patch	5.25 KB	arianek
#2
#1	cleanup.content.type_.add_.patch	2.41 KB	Bojhan
#1
	cleanup.content.type_.add_.patch	0 bytes	Bojhan

	After-cleanup-addcontenttype.png	33.75 KB	Bojhan
	Before-cleanup-addcontenttype.png	39.4 KB	Bojhan

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

Bojhan CreditAttribution: Bojhan commented 18 July 2009 at 10:13

File	Size
cleanup.content.type_.add_.patch	2.41 KB

Comment #2

arianek CreditAttribution: arianek commented 2 August 2009 at 04:28

Issue tags:

+Documentation

File	Size
content_type_add.patch	5.25 KB

I just created a new patch updating text on the /admin/structure/types/add page. I kept the last edit from the list of changes you made (and took some of your other points into account):

- "Preview post"
+ "Preview post before submitting"
- "Should users preview posts before submitting?".

I also edited a bunch of the other help text, but kept help text on the human readable name and description, as i think it's still useful to have some guidelines and an explanation of where each will show up.

I changed the body field help text to "To remove the body field, remove text and leave blank." as it doesn't make sense to say "leave it blank" when it has text in it by default.

A few other punctuation changes and capitalized page titles in the help text as well, and changed the text for the Explanation or submission guidelines to be less awkward at the end.

Altogether, just trying to make it all more useful and friendly, and nice grammatically. Let me know what you think, and note this is my first patch (aside from reviews, I'd been only working on d.o documentation previously) so if there are any mistakes please do point them out!

Comment #3

Bojhan CreditAttribution: Bojhan commented 2 August 2009 at 12:08

This requires a before and after screenshot.

Comment #4

arianek CreditAttribution: arianek commented 2 August 2009 at 17:10

File	Size
content_type_add_after.png	161.68 KB
content_type_add_before.png	140.46 KB

adding screenshots

Comment #5

Bojhan CreditAttribution: Bojhan commented 2 August 2009 at 18:13

So a thorough review.

"This name will be displayed in any lists of content types. It is recommended that this name contain only letters, numbers, and spaces."
- Lets not change this, it is something that needs to be rewritten for Drupal as a whole.
- Same for your change of machine name.

"This text will be displayed in the list on the Content types and Add new content pages."
- Can be removed, will only become clear once you see it anyway.

"To remove the body field, remove this text and leave blank."
- I am not sure why its better then, "Leave blank to remove the body field"

"Preview post before submitting"
- We want to remove the notion of post from the interface, not sure if we can in this case.

"This text will be displayed at the top of the submission form for this content type. It is useful for adding help text describing the content type or general instructions."
- What about removing "It is useful for adding help text describing the content type or general instructions."

What does the last part of your patch do?

Comment #6

arianek CreditAttribution: arianek commented 2 August 2009 at 22:16

- I'm a little confused, as your first changes had removed the human readable name text altogether, I thought it was useful to have slightly more brief and clear text there, but if it's going to be overhauled in a more general sense that is fine.

- "This text will be displayed in the list on the Content types and Add new content pages." I know once you see it it's obvious, but when first adding a new content type, it is not obvious at all where that text will be used and I would think it would be helpful when filling out the node add form to know where everything goes, no?

- I changed it to "To remove the body field, remove this text and leave blank." rather than "Leave blank to remove the body field" because it is just bad logic to say "leave" this blank, when it is not blank to start out with, you must *remove* the text.

- For "Preview post before submitting", perhaps instead "Preview before submitting" or "Preview new content before submitting"

- Yes, I agree ""This text will be displayed at the top of the submission form for this content type." is probably adequate.

- The last one removes two unnecessary commas.

Will await your input and/or a 3rd opinion (if there are any other doc people watching this!) and then roll a new version.

Comment #7

Bojhan CreditAttribution: Bojhan commented 3 August 2009 at 00:08

"This text will be displayed in the list on the Content types and Add new content pages."
- So my worry is that, no one actually knows what the Add new content page is, as its not the thing you recall from that page.

"To remove the body field, remove this text and leave blank."
Reasoning sounds solid, lets indeed go for this.

"Preview before submitting"
Let's go for this, because new content doesn't necessarily apply to previewing - it can be editing existing.

Comment #8

arianek CreditAttribution: arianek commented 3 August 2009 at 00:49

- Agreed on the latter two. I think that's actually a major improvement using "Preview before submitting" now that you mention the other use cases, as if the same text was applied eg. comments, images, etc. it will still make sense.

- "This text will be displayed in the list on the Content types and Add new content pages." - what if the two page names were linked to the pages? Since the default install ships with 'page' and 'article' already set up, there will be content on those pages from the get go...

Comment #9

Bojhan CreditAttribution: Bojhan commented 3 August 2009 at 09:41

We probably don't want to link yet, because - it will destroy your work in the create content type form - if you click it(it opens in the same window). We have yet to find a unified solution for that.

Comment #10

arianek CreditAttribution: arianek commented 3 August 2009 at 17:24

Fair enough, no links. But you would still prefer no text (and edit links on the Content types page) to "This text will be displayed in the list on the Content types and Add new content pages."? Just double checking then will roll a new patch.

Comment #11

Bojhan CreditAttribution: Bojhan commented 5 August 2009 at 11:14

I think its favorable to remove that text yes. Mostly because, simply no one knows of the page we are referring to. Lets work on creating a referral on the create content page to managing content type, instead of adding that referral here.

Comment #12

arianek CreditAttribution: arianek commented 7 August 2009 at 21:31

File	Size
content_type_add_1.patch	3.34 KB

content_type_add_after.png	92.53 KB
content_type_add_before.png	102.69 KB

Alrighty - so I've compiled all that into a brand spankin new patch, summary:

- name/machine name text is the same as before
- removed help text on description
- body field help text now reads "To remove the body field, remove text and leave blank."
- preview settings reads "Preview before submitting"
- below preview settings, removed "Should users preview posts before submitting?"
- explanation/submission guidelines text reads "This text will be displayed at the top of the submission form for this content type."
- removed those two bad commas again as well (see patch)

Pls review and make sure I didn't miss anything! :-)