Formatting Tutorial: Difference between revisions

From JoS Wiki
mNo edit summary
(added picture)
 
(3 intermediate revisions by the same user not shown)
Line 62: Line 62:
# Only once this has been done, and all information has been correctly transferred, then you can delete the contents of the source page, leaving just the redirect link.
# Only once this has been done, and all information has been correctly transferred, then you can delete the contents of the source page, leaving just the redirect link.


=== Organizing Links ===
=== Organizing Page Links ===
[[File:Organized Links.png|thumb|316x316px|Exposing Christianity: Initial Link Organization.]]
Many pages exist on the JoS Sites as a collection of links. It is understandable why HPS Maxine had done this to begin with, but now it is our job to improve upon this.  
Many pages exist on the JoS Sites as a collection of links. It is understandable why HPS Maxine had done this to begin with, but now it is our job to improve upon this.  


'''The initial action''' to be done is to organize the links based on their titles into various categories. This is simply to create a basic order without requiring the editor to know all the content within every link. This can be seen on the [[Exposing Christianity]] page. Sometimes this can be difficult, but just do your best to think of some general categories. You are aiming for perhaps ~5 or so links per category, otherwise you are still left with a pile of too many links.
'''The initial action''' to be done is to organize the links based on their titles into various categories. This is simply to create a basic order without requiring the editor to know all the content within every link. This can be seen on the [[Exposing Christianity]] page. Sometimes this can be difficult, but just do your best to think of some general categories. You are aiming for perhaps ~5 or so links per category, otherwise you are still left with a pile of too many links. At the same time, this is not always possible, as seen in the example.


In some ways, this does not need to be very accurate, but it helps on pages which have 30 different links. How are you supposed to begin organizing this? That is where this first step comes into play.
In some ways, this does not need to be very accurate, but it helps on pages which have 30 different links. How are you supposed to begin organizing this? That is where this first step comes into play.
Line 71: Line 72:
'''Further attempts''' to organize links requires comprehension of the page itself. At this point, it is best to either attempt to organize pages into sections or attempt to merge pages. Both of these methods will help the goal of organizing the parent page.
'''Further attempts''' to organize links requires comprehension of the page itself. At this point, it is best to either attempt to organize pages into sections or attempt to merge pages. Both of these methods will help the goal of organizing the parent page.


==== Organizing Pages into Sections ====


=== Organizing Individual Pages into Sections - Dividing Page ===
[[File:Organized into sections.png|thumb|223x223px|Initial Organization into Sections]]
It is impossible for every editor to be fully aware of each sentence that exists on the Wiki. Yet, for editors to organize the Wiki, they need some understanding of what exists on each individual page. Therefore, we have to summarize each page for others. Of course, this is helpful to readers, not just editors.


Image Management
'''Start''' by picking a large page, then read through it all once. Be mindful of where there are natural breaks within topics. Sometimes the pages can go on multiple tangents or topics, but just do your best to divide the page within your mind.
 
Then, once you have grasped what is being said, create a title for the passage in question. Write this title above the passage, then highlight your title and change the text format to one of the heading options. Repeat this process of summarizing the entire page, to the best of your ability. This is the first, but important step here.
 
=== Organizing Individual Pages ("Detailing the Page") ===
Once a large page has been divided into sections, further steps can be taken, such as:
 
* [[File:Format comparison.png|thumb|Notice the changes in paragraph structure, as well as the additions of sections, text bolding, and links.]]Rearrange Sections, with the introductory content closer to the top
* Underlining or bolding of important parts
* Creation of redirect links for important sections
* Incorporation of given references into the Wiki's citation tool
* Addition of a "See Also" section, either at the bottom or for a specific section

Latest revision as of 06:30, 20 May 2023

Premise

As we know, the JoS Sites are not already structured in a Wiki format. However, we cannot readily rewrite new pages of content, since we must respect the original authors and their knowledge. Furthermore, I doubt many people have a full awareness of the entirety of JoS knowledge on a given topic. Therefore, formatting the JoS Sites requires a more cautious approach to aid both problems.

The main objective here is to continuously reformat certain pages to the best of your ability. This leaves it in a more organized state for later. Then, it becomes much easier to make additional formatting or organizational attempts, as new ideas are generated on how best to present the information.

If we are to condense the 500-700 pages of JoS content (not including the library) into a readable Wiki format, this requires many organizational passes. To even categorize one page, you must also know what is being communicated. This requires effort, especially when attempting to reorganize entire sections. Yet, small efforts will build upon one another.

Although this process is continually evolving, there are also basic actions which can be done. Therefore, I will try to detail some of these methods which can be done by everyone to help our overall goal.

Organizational Actions

Expansion of pages

An example of a page in which the listed articles must be expanded out of their individual links.

Some pages of the JoS site are comprised solely of individual links. This is unnecessary for a Wiki and these pages should be expanded out of their individual links. Initially, this would result in one big page containing these individual articles, but this can be dealt with later.

From the example image, the contents of each individual article should moved out and into the "main" page, which is the page listing all of these articles.

  1. Open an individual article.
  2. On the "main" page, create a Heading with the title of this individual article.
  3. Copy and paste the contents into the "main" page, under this new title.
  4. Save your changes on the "main" page, which allows the next step to work properly.
  5. Create a redirect link from the page of the individual article to the newly created Heading section of the "main" page.
    1. This redirect is essential so that any links to the original article now follow to the new location!
  6. Test the redirection by clicking on a link to the individual article. This should automatically redirect to the main page, under the section you specified.
  7. Only once this has been done, and all information has been correctly transferred, then you can delete the contents of the original article, leaving just the redirect link.
  8. Optionally, create a "See also" section at the bottom of the page for any remaining links.
    An example of some articles from the original example, which have now been expanded and further organized.

Repeat this process as necessary. Not every article must be "expanded" into a single page, but this general process makes subsequent actions much easier.



Merging of Pages

Page merging should be done in cases where two topics can fit together. For now, this refers to merging pages by creating a new section, NOT by merging paragraphs or text. This process helps make the Wiki more concise, as many pages exist in a redundant fashion or are located away from related. content.

One example of this is the astrology section, where the two pages describing each planet's rulership and signs could be combined into one page.

For some pages this is obvious, but for others it may not be. You must use your own judgement here, but also know that any changes can be altered later.

When to merge:

  • redundant pages
  • similar topics
  • one page is very short

When to not merge:

  • the result is messy or too big
  • topics are distinct enough to exist alone
  1. Read both articles well and do background research on any similar articles
  2. Check whether the merger is supported by the above criteria
  3. Determine which page shall be the destination/final page, and which is the source/deleted page
    • Which page occupies a more "dominant" position on the Wiki?
    • What are the downsides to removing the source page?
  4. On the destination page, create a Heading with the title of the source page.
  5. Copy and paste the contents into the destination page, under this new title.
  6. Save your changes on the destination page, which allows the next step to work properly.
  7. Create a redirect link from the source page to the newly created Heading section of the destination page.
    1. This redirect is essential so that any links to the source page now follow to the new location!
  8. Test the redirection by clicking on a link to the source page. This should automatically redirect to the destination page, under the section you specified.
  9. Only once this has been done, and all information has been correctly transferred, then you can delete the contents of the source page, leaving just the redirect link.

Organizing Page Links

Exposing Christianity: Initial Link Organization.

Many pages exist on the JoS Sites as a collection of links. It is understandable why HPS Maxine had done this to begin with, but now it is our job to improve upon this.

The initial action to be done is to organize the links based on their titles into various categories. This is simply to create a basic order without requiring the editor to know all the content within every link. This can be seen on the Exposing Christianity page. Sometimes this can be difficult, but just do your best to think of some general categories. You are aiming for perhaps ~5 or so links per category, otherwise you are still left with a pile of too many links. At the same time, this is not always possible, as seen in the example.

In some ways, this does not need to be very accurate, but it helps on pages which have 30 different links. How are you supposed to begin organizing this? That is where this first step comes into play.

Further attempts to organize links requires comprehension of the page itself. At this point, it is best to either attempt to organize pages into sections or attempt to merge pages. Both of these methods will help the goal of organizing the parent page.


Organizing Individual Pages into Sections - Dividing Page

Initial Organization into Sections

It is impossible for every editor to be fully aware of each sentence that exists on the Wiki. Yet, for editors to organize the Wiki, they need some understanding of what exists on each individual page. Therefore, we have to summarize each page for others. Of course, this is helpful to readers, not just editors.

Start by picking a large page, then read through it all once. Be mindful of where there are natural breaks within topics. Sometimes the pages can go on multiple tangents or topics, but just do your best to divide the page within your mind.

Then, once you have grasped what is being said, create a title for the passage in question. Write this title above the passage, then highlight your title and change the text format to one of the heading options. Repeat this process of summarizing the entire page, to the best of your ability. This is the first, but important step here.

Organizing Individual Pages ("Detailing the Page")

Once a large page has been divided into sections, further steps can be taken, such as:

  • Notice the changes in paragraph structure, as well as the additions of sections, text bolding, and links.
    Rearrange Sections, with the introductory content closer to the top
  • Underlining or bolding of important parts
  • Creation of redirect links for important sections
  • Incorporation of given references into the Wiki's citation tool
  • Addition of a "See Also" section, either at the bottom or for a specific section